FrameCPP::Version_4::FrEndOfFile Class Reference

#include <FrEndOfFile.hh>

Inheritance diagram for FrameCPP::Version_4::FrEndOfFile:

Collaboration diagram for FrameCPP::Version_4::FrEndOfFile:

Public Types
typedef INT_4U	nFrames_type
typedef INT_4U	nBytes_type
typedef INT_4U	chkFlag_type
typedef INT_4U	chkSum_type
typedef INT_4U	seekTOC_type
typedef INT_4U	nFrames_type
typedef INT_4U	nBytes_type
typedef INT_4U	chkFlag_type
typedef INT_4U	chkSum_type
typedef INT_4U	seekTOC_type
typedef INT_8U	nBytes_cmn_type
typedef INT_8U	nBytes_cmn_type
typedef INT_4U	nFrames_cmn_type
typedef INT_4U	nFrames_cmn_type
typedef INT_8U	seekTOC_cmn_type
typedef INT_8U	seekTOC_cmn_type
typedef INT_4U	chkType_cmn_type
typedef INT_4U	chkType_cmn_type
typedef INT_4U	chkSum_cmn_type
typedef INT_4U	chkSum_cmn_type
typedef IStringStream	assign_stream_type
typedef IStringStream	assign_stream_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef boost::shared_ptr< Object >	object_type
typedef boost::shared_ptr< Object >	object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef object_type	demote_arg_type
typedef object_type	demote_arg_type
typedef object_type	demote_ret_type
typedef object_type	demote_ret_type
typedef stream_base_type	demote_stream_type
typedef stream_base_type	demote_stream_type
typedef object_type	promote_arg_type
typedef object_type	promote_arg_type
typedef object_type	promote_ret_type
typedef object_type	promote_ret_type
typedef stream_base_type	promote_stream_type
typedef stream_base_type	promote_stream_type

Public Member Functions
	FrEndOfFile ()
virtual	~FrEndOfFile ()
virtual Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Return the number of bytes for this object.
virtual FrEndOfFile *	Clone () const
	constructor - virtual copy constructor
virtual FrEndOfFile *	Create (istream_type &Stream) const
	constructor - virtual
virtual const char *	ObjectStructName () const
	Retrieve the class name of the object.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
bool	operator== (const FrEndOfFile &RHS) const
	comparison operator
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator
virtual nBytes_cmn_type	NBytes () const
virtual nFrames_cmn_type	NFrames () const
FrEndOfFile::seekTOC_type	GetSeekTOC () const
virtual FrEndOfFile::seekTOC_cmn_type	SeekTOC () const
virtual void	VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
	Verify an object.
	FrEndOfFile ()
virtual	~FrEndOfFile ()
virtual Common::FrameSpec::size_type	Bytes (const Common::StreamBase &Stream) const
	Return the number of bytes for this object.
virtual FrEndOfFile *	Clone () const
	constructor - virtual copy constructor
virtual FrEndOfFile *	Create (istream_type &Stream) const
	constructor - virtual
virtual const char *	ObjectStructName () const
	Retrieve the class name of the object.
virtual void	Write (ostream_type &Stream) const
	Write object to the stream.
bool	operator== (const FrEndOfFile &RHS) const
	comparison operator
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator
virtual nBytes_cmn_type	NBytes () const
virtual nFrames_cmn_type	NFrames () const
FrEndOfFile::seekTOC_type	GetSeekTOC () const
virtual FrEndOfFile::seekTOC_cmn_type	SeekTOC () const
virtual void	VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
	Verify an 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 (ostream_type &Stream) const
virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.
virtual const Description *	GetDescription (ostream_type &Stream) const
frame_spec_version_type	FrameSpecVersion () const
frame_spec_version_type	FrameSpecVersion () const
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
template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type	PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)

Static Public Member Functions
static const char *	StructName ()
static const Common::Description *	StructDescription ()
static const char *	StructName ()
static const Common::Description *	StructDescription ()
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.

Static Public Attributes
static const Common::FrameSpec::Info::frame_object_types	s_object_id = Common::FrameSpec::Info::FSI_FR_END_OF_FILE

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
	Down grade an object.
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
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
	Down grade an object.
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
virtual class_type	getClass () const
	Retrieve the class identifier.
virtual class_type	getClass () const
	Retrieve the class identifier.

Protected Attributes
nFrames_type	m_nFrames
nBytes_type	m_nBytes
chkFlag_type	m_chkFlag
chkSum_type	m_chkSum
seekTOC_type	m_seekTOC

Private Member Functions
	FrEndOfFile (istream_type &Source)
virtual chkSum_cmn_type	Filter (const istream_type &Stream, Common::CheckSum &Filt, chkType_cmn_type &Type, void *Buffer, INT_8U Size) const
	Run filters over the given bytes.
	FrEndOfFile (istream_type &Source)
virtual chkSum_cmn_type	Filter (const istream_type &Stream, Common::CheckSum &Filt, chkType_cmn_type &Type, void *Buffer, INT_8U Size) const
	Run filters over the given bytes.

Private Attributes
const class_type	m_class
	Storage for the class identifier.
const Description *const	m_desc
	Description for parent class.
const frame_spec_version_type	frame_spec_version
	Version of the frame specification.

Member Typedef Documentation

assign_stream_type [1/2]

typedef IStringStream FrameCPP::Common::FrEndOfFile::assign_stream_type

inherited

assign_stream_type [2/2]

typedef IStringStream FrameCPP::Common::FrEndOfFile::assign_stream_type

inherited

chkFlag_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::chkFlag_type

chkFlag_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::chkFlag_type

chkSum_cmn_type [1/2]

typedef INT_4U FrameCPP::Common::FrEndOfFile::chkSum_cmn_type

inherited

chkSum_cmn_type [2/2]

typedef INT_4U FrameCPP::Common::FrEndOfFile::chkSum_cmn_type

inherited

chkSum_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::chkSum_type

chkSum_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::chkSum_type

chkType_cmn_type [1/2]

typedef INT_4U FrameCPP::Common::FrEndOfFile::chkType_cmn_type

inherited

chkType_cmn_type [2/2]

typedef INT_4U FrameCPP::Common::FrEndOfFile::chkType_cmn_type

inherited

demote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_stream_type [1/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_stream_type

inherited

demote_stream_type [2/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_stream_type

inherited

frame_spec_version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

frame_spec_version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

nBytes_cmn_type [1/2]

typedef INT_8U FrameCPP::Common::FrEndOfFile::nBytes_cmn_type

inherited

nBytes_cmn_type [2/2]

typedef INT_8U FrameCPP::Common::FrEndOfFile::nBytes_cmn_type

inherited

nBytes_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::nBytes_type

nBytes_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::nBytes_type

nFrames_cmn_type [1/2]

typedef INT_4U FrameCPP::Common::FrEndOfFile::nFrames_cmn_type

inherited

nFrames_cmn_type [2/2]

typedef INT_4U FrameCPP::Common::FrEndOfFile::nFrames_cmn_type

inherited

nFrames_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::nFrames_type

nFrames_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::nFrames_type

object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type

inherited

object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type

inherited

promote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_stream_type [1/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_stream_type

inherited

promote_stream_type [2/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_stream_type

inherited

seekTOC_cmn_type [1/2]

typedef INT_8U FrameCPP::Common::FrEndOfFile::seekTOC_cmn_type

inherited

seekTOC_cmn_type [2/2]

typedef INT_8U FrameCPP::Common::FrEndOfFile::seekTOC_cmn_type

inherited

seekTOC_type [1/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::seekTOC_type

seekTOC_type [2/2]

typedef INT_4U FrameCPP::Version_4::FrEndOfFile::seekTOC_type

unique_object_type [1/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

unique_object_type [2/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

Constructor & Destructor Documentation

FrEndOfFile() [1/4]

FrameCPP::Version_4::FrEndOfFile::FrEndOfFile

(

)

~FrEndOfFile() [1/2]

FrameCPP::Version_4::FrEndOfFile::~FrEndOfFile ( )

virtual

Reimplemented from FrameCPP::Common::FrEndOfFile.

FrEndOfFile() [2/4]

FrameCPP::Version_4::FrEndOfFile::FrEndOfFile ( istream_type & Source )

private

FrEndOfFile() [3/4]

FrameCPP::Version_4::FrEndOfFile::FrEndOfFile

(

)

~FrEndOfFile() [2/2]

virtual FrameCPP::Version_4::FrEndOfFile::~FrEndOfFile ( )

virtual

Reimplemented from FrameCPP::Common::FrEndOfFile.

FrEndOfFile() [4/4]

FrameCPP::Version_4::FrEndOfFile::FrEndOfFile ( istream_type & Source )

private

Member Function Documentation

assign() [1/2]

void FrameCPP::Version_4::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.

Implements FrameCPP::Common::FrEndOfFile.

assign() [2/2]

virtual void FrameCPP::Version_4::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.

Implements FrameCPP::Common::FrEndOfFile.

Bytes() [1/2]

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

virtual

Return the number of bytes for this object.

Parameters

[in]

Stream

The stream on which the object will be written or read.

Returns

The number of bytes required by this object for the specified stream.

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

Bytes() [2/2]

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

virtual

Return the number of bytes for this object.

Parameters

[in]

Stream

The stream on which the object will be written or read.

Returns

The number of bytes required by this object for the specified stream.

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

Clone() [1/2]

FrEndOfFile * FrameCPP::Version_4::FrEndOfFile::Clone ( ) const

virtual

constructor - virtual copy constructor

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Clone() [2/2]

virtual FrEndOfFile * FrameCPP::Version_4::FrEndOfFile::Clone ( ) const

virtual

constructor - virtual copy constructor

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Create() [1/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, and FrVect.

Create() [2/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream & Buffer ) const

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

Create() [3/4]

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

virtual

constructor - virtual

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

Create() [4/4]

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

virtual

constructor - virtual

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

demote() [1/2]

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

protectedvirtual

Down grade an object.

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

demote() [2/2]

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

protectedvirtual

Down grade an object.

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.

Filter() [1/2]

FrEndOfFile::chkSum_cmn_type FrameCPP::Version_4::FrEndOfFile::Filter ( const istream_type & Stream, Common::CheckSum & Check, chkType_cmn_type & Type, void * Buffer, INT_8U Size ) const

privatevirtual

Run filters over the given bytes.

Parameters

[in,out]	Stream	The source of the bytes to read.
[in,out]	Check	The running checksum calculation
[out]	Type	The recorded CRC type present in this structure when read from the stream.
[in]	Buffer	The bytes to be filtered
[in]	Size	The number of bytes in Buffer to be checked.

Returns

The checksum value recorded within the FrEndOfFile structure.

Implements FrameCPP::Common::FrEndOfFile.

Filter() [2/2]

virtual chkSum_cmn_type FrameCPP::Version_4::FrEndOfFile::Filter ( const istream_type & Stream, Common::CheckSum & Check, chkType_cmn_type & Type, void * Buffer, INT_8U Size ) const

privatevirtual

Run filters over the given bytes.

Parameters

[in,out]	Stream	The source of the bytes to read.
[in,out]	Check	The running checksum calculation
[out]	Type	The recorded CRC type present in this structure when read from the stream.
[in]	Buffer	The bytes to be filtered
[in]	Size	The number of bytes in Buffer to be checked.

Returns

The checksum value recorded within the FrEndOfFile structure.

Implements FrameCPP::Common::FrEndOfFile.

FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const

inlineinherited

FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const

inherited

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.

getClass() [1/2]

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

protectedvirtualinherited

Retrieve the class identifier.

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

getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

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

GetDescription() [1/4]

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/4]

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.

GetDescription() [3/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream ) const

virtualinherited

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

Reimplemented in FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, and FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >.

GetDescription() [4/4]

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

virtualinherited

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

Reimplemented in FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, and FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >.

GetSeekTOC() [1/2]

FrEndOfFile::seekTOC_type FrameCPP::Version_4::FrEndOfFile::GetSeekTOC ( ) const

inline

GetSeekTOC() [2/2]

FrEndOfFile::seekTOC_type FrameCPP::Version_4::FrEndOfFile::GetSeekTOC

(

)

const

NBytes() [1/2]

FrEndOfFile::nBytes_cmn_type FrameCPP::Version_4::FrEndOfFile::NBytes ( ) const

virtual

Implements FrameCPP::Common::FrEndOfFile.

NBytes() [2/2]

virtual nBytes_cmn_type FrameCPP::Version_4::FrEndOfFile::NBytes ( ) const

virtual

Implements FrameCPP::Common::FrEndOfFile.

NFrames() [1/2]

FrEndOfFile::nFrames_cmn_type FrameCPP::Version_4::FrEndOfFile::NFrames ( ) const

virtual

Implements FrameCPP::Common::FrEndOfFile.

NFrames() [2/2]

virtual nFrames_cmn_type FrameCPP::Version_4::FrEndOfFile::NFrames ( ) const

virtual

Implements FrameCPP::Common::FrEndOfFile.

ObjectStructName() [1/2]

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

virtual

Retrieve the class name of the object.

Returns

The name of the class associated with the object.

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

ObjectStructName() [2/2]

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

virtual

Retrieve the class name of the object.

Returns

The name of the class associated with the object.

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

operator==() [1/4]

bool FrameCPP::Version_4::FrEndOfFile::operator== ( const Common::FrameSpec::Object & Obj ) const

virtual

comparison operator

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

operator==() [2/4]

virtual bool FrameCPP::Version_4::FrEndOfFile::operator== ( const Common::FrameSpec::Object & Obj ) const

virtual

comparison operator

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

operator==() [3/4]

bool FrameCPP::Version_4::FrEndOfFile::operator==

(

const FrEndOfFile &

RHS

)

const

comparison operator

operator==() [4/4]

bool FrameCPP::Version_4::FrEndOfFile::operator==

(

const FrEndOfFile &

RHS

)

const

comparison operator

promote() [1/2]

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

protectedvirtual

Upgrade an object.

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

promote() [2/2]

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

protectedvirtual

Upgrade an object.

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

PromoteObject() [1/5]

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/5]

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/5]

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/5]

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() [5/5]

template<typename PreviousType, typename CurrentType>

FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type * Stream )

inherited

SeekTOC() [1/2]

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

inlinevirtual

Returns the file position of the start of the table of contents. If the stream has no table of contents, the value of zero is returned.

Reimplemented from FrameCPP::Common::FrEndOfFile.

SeekTOC() [2/2]

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

virtual

Returns the file position of the start of the table of contents. If the stream has no table of contents, the value of zero is returned.

Reimplemented from FrameCPP::Common::FrEndOfFile.

StructDescription() [1/2]

const Description * FrameCPP::Version_4::FrEndOfFile::StructDescription ( )

static

StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_4::FrEndOfFile::StructDescription ( )

static

StructName() [1/2]

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

inlinestatic

StructName() [2/2]

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

static

VerifyObject() [1/2]

void FrameCPP::Version_4::FrEndOfFile::VerifyObject ( Common::Verify & Verifier, Common::IFrameStream & Stream ) const

virtual

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

VerifyObject() [2/2]

virtual void FrameCPP::Version_4::FrEndOfFile::VerifyObject ( Common::Verify & Verifier, Common::IFrameStream & Stream ) const

virtual

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

Write() [1/2]

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

virtual

Write object to the stream.

Parameters

[in,out]

Stream

The stream being written with the contents of object.

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

Write() [2/2]

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

virtual

Write object to the stream.

Parameters

[in,out]

Stream

The stream being written with the contents of object.

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

frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version

privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

m_chkFlag

chkFlag_type FrameCPP::Version_4::FrEndOfFile::m_chkFlag

protected

m_chkSum

chkSum_type FrameCPP::Version_4::FrEndOfFile::m_chkSum

protected

m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class

privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc

privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

m_nBytes

nBytes_type FrameCPP::Version_4::FrEndOfFile::m_nBytes

protected

m_nFrames

nFrames_type FrameCPP::Version_4::FrEndOfFile::m_nFrames

protected

m_seekTOC

seekTOC_type FrameCPP::Version_4::FrEndOfFile::m_seekTOC

protected

s_object_id

static const Common::FrameSpec::Info::frame_object_types FrameCPP::Version_4::FrEndOfFile::s_object_id = Common::FrameSpec::Info::FSI_FR_END_OF_FILE

static

---

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/Version4/FrEndOfFile.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version4/FrEndOfFile.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version4/FrEndOfFile.cc