End of File data structure. More...

#include <FrEndOfFile.hh>

Public Member Functions
	FrEndOfFile ()
	Default constructor.

virtual	~FrEndOfFile ()
	Destructor.

virtual Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

virtual FrEndOfFile *	Clone () const
	Virtual copy constructor.

virtual FrEndOfFile *	Create (istream_type &Stream) const
	Virtual constructor.

virtual nBytes_cmn_type	NBytes () const
	Retrieve the expected size of the stream.

virtual nFrames_cmn_type	NFrames () const
	Retrieve the number of frames in the stream.

virtual const char *	ObjectStructName () const
	The name structure name of this object.

virtual void	Write (ostream_type &Stream) const
	Write the structure to the stream.

bool	operator== (const FrEndOfFile &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type

virtual FrEndOfFile::seekTOC_cmn_type	SeekTOC () const
	Retrieve the location of the table of contents.

virtual void	VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
	Verify the object.

	FrEndOfFile ()
	Default constructor.

virtual	~FrEndOfFile ()
	Destructor.

virtual Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

virtual FrEndOfFile *	Clone () const
	Virtual copy constructor.

virtual FrEndOfFile *	Create (istream_type &Stream) const
	Virtual constructor.

virtual nBytes_cmn_type	NBytes () const
	Retrieve the expected size of the stream.

virtual nFrames_cmn_type	NFrames () const
	Retrieve the number of frames in the stream.

virtual const char *	ObjectStructName () const
	The name structure name of this object.

virtual void	Write (ostream_type &Stream) const
	Write the structure to the stream.

bool	operator== (const FrEndOfFile &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type

virtual FrEndOfFile::seekTOC_cmn_type	SeekTOC () const
	Retrieve the location of the table of contents.

virtual void	VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
	Verify the object.

class_type	GetClass () const
	Retrieve the class identifier.

class_type	GetClass () const
	Retrieve the class identifier.

virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.

virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.

ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream.

ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream.

virtual Object *	Create () const
	constructor - virtual

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

chkSum_type	GetChkSum () const
	Retrieve the checksum.

chkSumFile_type	GetChkSumFile () const
	Retrieve the file checksum.

chkSumFrHeader_type	GetChkSumFrHeader () const
	Retrieve the FrHeader checksum.

nBytes_type	GetNBytes () const
	Retrieve the total number of bytes in this file.

nFrames_type	GetNFrames () const
	Retrieve the number of frames in this file.

seekTOC_type	GetSeekTOC () const
	Retrieve the location of the table of contents.

Static Public Member Functions
static const char *	StructName ()
	The name structure name of this object.

static const char *	StructName ()
	The name structure name of this object.

static const Common::Description *	StructDescription ()
	The description of structure.

static const Common::Description *	StructDescription ()
	The description of structure.

static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
	Down grade an object.

static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
	Down grade an object.

static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.

template<typename PreviousType, typename CurrentType>
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.

static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.

template<typename PreviousType, typename CurrentType>
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
	Upgrade an object.

Protected Member Functions
virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance.

virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Demotes object to previous version of the frame spec.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Promotes object to another version of the frame spec.

virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance.

virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Demotes object to previous version of the frame spec.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Promotes object to another version of the frame spec.

virtual class_type	getClass () const
	Retrieve the class identifier.

virtual class_type	getClass () const
	Retrieve the class identifier.

Protected Attributes
nFrames_type	nFrames
	Number of frames in this file.

nBytes_type	nBytes
	Total number of bytes in the file; zero if not computed.

seekTOC_type	seekTOC

chkSumFrHeader_type	chkSumFrHeader
	FrHeader checksum.

chkSum_type	chkSum

chkSumFile_type	chkSumFile
	File checksum.

Detailed Description

End of File data structure.

Constructor & Destructor Documentation

◆ FrEndOfFile() [1/2]

FrameCPP::Version_8::FrEndOfFile::FrEndOfFile ( )

Default constructor.

Returns: A new instance of this object.

◆ FrEndOfFile() [2/2]

FrameCPP::Version_8::FrEndOfFile::FrEndOfFile ( )

Default constructor.

Returns: A new instance of this object.

Member Function Documentation

◆ assign() [1/2]

void FrameCPP::Version_8::FrEndOfFile::assign ( assign_stream_type & Stream )

protectedvirtual

Assign the contents of the instance.

Parameters

[in] Stream An input stream from which to read information for the instance.

◆ assign() [2/2]

virtual void FrameCPP::Version_8::FrEndOfFile::assign ( assign_stream_type & Stream )

protectedvirtual

Assign the contents of the instance.

Parameters

[in] Stream An input stream from which to read information for the instance.

◆ Bytes() [1/2]

FrameSpec::size_type FrameCPP::Version_8::FrEndOfFile::Bytes ( const Common::StreamBase & Stream ) const

virtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

Returns: The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Bytes() [2/2]

virtual Common::FrameSpec::size_type FrameCPP::Version_8::FrEndOfFile::Bytes ( const Common::StreamBase & Stream ) const

virtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

Returns: The number of bytes need to read or write this object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [1/2]

FrEndOfFile * FrameCPP::Version_8::FrEndOfFile::Create ( istream_type & Stream ) const

virtual

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [2/2]

virtual FrEndOfFile * FrameCPP::Version_8::FrEndOfFile::Create ( istream_type & Stream ) const

virtual

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [1/2]

FrEndOfFile::demote_ret_type FrameCPP::Version_8::FrEndOfFile::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		demote_stream_type *	Stream ) const

protectedvirtual

Demotes object to previous version of the frame spec.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrEndOfFile::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		demote_stream_type *	Stream ) const

protectedvirtual

Demotes object to previous version of the frame spec.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject	(	frame_spec_version_type	Target,
		object_type	Obj,
		demote_stream_type *	Stream )

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns: A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject	(	frame_spec_version_type	Target,
		object_type	Obj,
		demote_stream_type *	Stream )

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns: A pointer to the objected derived by demoting Obj.

◆ GetChkSum()

chkSum_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSum ( ) const

inlineinherited

Retrieve the checksum.

Returns: The checksum.

◆ GetChkSumFile()

chkSumFile_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSumFile ( ) const

inlineinherited

Retrieve the file checksum.

Returns: The file checksum.

◆ GetChkSumFrHeader()

chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetChkSumFrHeader ( ) const

inlineinherited

Retrieve the FrHeader checksum.

Returns: The FrHEader checksum.

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inlineinherited

Retrieve the class identifier.

Returns: The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inherited

Retrieve the class identifier.

Returns: The class identifier.

◆ GetDescription() [1/2]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns: The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/2]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns: The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetNBytes()

nBytes_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetNBytes ( ) const

inlineinherited

Retrieve the total number of bytes in this file.

Returns: The total number of bytes in this file.

◆ GetNFrames()

nFrames_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetNFrames ( ) const

inlineinherited

Retrieve the number of frames in this file.

Returns: The number of frames in this file.

◆ GetSeekTOC()

seekTOC_type FrameCPP::Version_8::FrEndOfFileImpl::Data::GetSeekTOC ( ) const

inlineinherited

Retrieve the location of the table of contents.

Returns: The location of the table of contents.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrEndOfFile::ObjectStructName ( ) const

virtual

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrEndOfFile::ObjectStructName ( ) const

virtual

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrEndOfFile::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrEndOfFile::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrEndOfFile::operator== ( const FrEndOfFile & RHS ) const

equality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrEndOfFile::operator== ( const FrEndOfFile & RHS ) const

equality operator

Parameters

[in] RHS The FrAdcData object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ promote() [1/2]

FrEndOfFile::promote_ret_type FrameCPP::Version_8::FrEndOfFile::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		promote_stream_type *	Stream ) const

protectedvirtual

Promotes object to another version of the frame spec.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object promoted to the next generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrEndOfFile::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		promote_stream_type *	Stream ) const

protectedvirtual

Promotes object to another version of the frame spec.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object promoted to the next generation.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/4]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		stream_base_type *	Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/4]

template<typename PreviousType, typename CurrentType>

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		stream_base_type *	Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/4]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		stream_base_type *	Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/4]

template<typename PreviousType, typename CurrentType>

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		stream_base_type *	Stream )

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ SeekTOC() [1/2]

Common::FrEndOfFile::seekTOC_cmn_type FrameCPP::Version_8::FrEndOfFile::SeekTOC ( ) const

inlinevirtual

Retrieve the location of the table of contents.

Returns: The location of the table of contents.

Todo: This may be better placed in the protected section.

◆ SeekTOC() [2/2]

virtual FrEndOfFile::seekTOC_cmn_type FrameCPP::Version_8::FrEndOfFile::SeekTOC ( ) const

virtual

Retrieve the location of the table of contents.

Returns: The location of the table of contents.

Todo: This may be better placed in the protected section.

◆ StructDescription() [1/2]

template<typename T>

static const Common::Description * FrameCPP::Version_8::FrEndOfFileImpl::ClassicIO< T >::StructDescription ( )

inlinestaticinherited

The description of structure.

Returns: A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

template<typename T>

static const Common::Description * FrameCPP::Version_8::FrEndOfFileImpl::ClassicIO< T >::StructDescription ( )

inlinestaticinherited

The description of structure.

Returns: A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrEndOfFile::StructName ( )

inlinestatic

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrEndOfFile::StructName ( )

static

The name structure name of this object.

Returns: The name of the structure as specified by the frame specification.

◆ Write() [1/2]

void FrameCPP::Version_8::FrEndOfFile::Write ( ostream_type & Stream ) const

virtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/2]

virtual void FrameCPP::Version_8::FrEndOfFile::Write ( ostream_type & Stream ) const

virtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream ) const

inherited

Write a next pointer to the parent to the stream.

Parameters

[in,out] Stream The output stream to receive the next pointer.

Returns: The output stream.

◆ WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream ) const

inherited

Write a next pointer to the parent to the stream.

Parameters

[in,out] Stream The output stream to receive the next pointer.

Returns: The output stream.

Member Data Documentation

◆ chkSum

chkSum_type FrameCPP::Version_8::FrEndOfFileImpl::Data::chkSum

protectedinherited

Structure checksum.

Note: The chkSum AND chkSumFile ariables are not included in the computation of checkSum, but chkSumFrHeader is includeed

◆ seekTOC

seekTOC_type FrameCPP::Version_8::FrEndOfFileImpl::Data::seekTOC

protectedinherited

Bytes to back up to the Beginning of the table of contents structure. If seekTOC is zero, then there is no table of contents for this file.

The documentation for this class was generated from the following files:

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version8/FrEndOfFile.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/FrEndOfFile.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/FrEndOfFile.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FrEndOfFile() [1/2]

◆ FrEndOfFile() [2/2]

Member Function Documentation

◆ assign() [1/2]

◆ assign() [2/2]

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ demote() [1/2]

◆ demote() [2/2]

◆ DemoteObject() [1/2]

◆ DemoteObject() [2/2]

◆ GetChkSum()

◆ GetChkSumFile()

◆ GetChkSumFrHeader()

◆ GetClass() [1/2]

◆ GetClass() [2/2]

◆ GetDescription() [1/2]

◆ GetDescription() [2/2]

◆ GetNBytes()

◆ GetNFrames()

◆ GetSeekTOC()

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ promote() [1/2]

◆ promote() [2/2]

◆ PromoteObject() [1/4]

◆ PromoteObject() [2/4]

◆ PromoteObject() [3/4]

◆ PromoteObject() [4/4]

◆ SeekTOC() [1/2]

◆ SeekTOC() [2/2]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]

◆ StructName() [1/2]

◆ StructName() [2/2]

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteNext() [1/2]

◆ WriteNext() [2/2]

Member Data Documentation

◆ chkSum

◆ seekTOC