ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrEndOfFile Class Reference

End of File data structure. More...

#include <FrEndOfFile.hh>

Inherits FrameCPP::Common::FrEndOfFile, and FrameCPP::Common::FrEndOfFile.

Public Member Functions

 FrEndOfFile ()
 Default constructor. More...
 
virtual ~FrEndOfFile ()
 Destructor.
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrEndOfFileClone () const
 Virtual copy constructor.
 
virtual FrEndOfFileCreate (istream_type &Stream) const
 Virtual constructor. More...
 
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. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
bool operator== (const FrEndOfFile &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
FrEndOfFile::chkSum_type GetChkSum () const
 Retrieve the checksum. More...
 
FrEndOfFile::chkSumFile_type GetChkSumFile () const
 Retrieve the file checksum. More...
 
FrEndOfFile::chkSumFrHeader_type GetChkSumFrHeader () const
 Retrieve the FrHeader checksum. More...
 
FrEndOfFile::nBytes_type GetNBytes () const
 Retrieve the total number of bytes in this file. More...
 
FrEndOfFile::nFrames_type GetNFrames () const
 Retrieve the number of frames in this file. More...
 
FrEndOfFile::seekTOC_type GetSeekTOC () const
 Retrieve the location of the table of contents. More...
 
virtual FrEndOfFile::seekTOC_cmn_type SeekTOC () const
 Retrieve the location of the table of contents. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object.
 
 FrEndOfFile ()
 Default constructor. More...
 
virtual ~FrEndOfFile ()
 Destructor.
 
virtual Common::FrameSpec::size_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual FrEndOfFileClone () const
 Virtual copy constructor.
 
virtual FrEndOfFileCreate (istream_type &Stream) const
 Virtual constructor. More...
 
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. More...
 
virtual void Write (ostream_type &Stream) const
 Write the structure to the stream. More...
 
bool operator== (const FrEndOfFile &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
FrEndOfFile::chkSum_type GetChkSum () const
 Retrieve the checksum. More...
 
FrEndOfFile::chkSumFile_type GetChkSumFile () const
 Retrieve the file checksum. More...
 
FrEndOfFile::chkSumFrHeader_type GetChkSumFrHeader () const
 Retrieve the FrHeader checksum. More...
 
FrEndOfFile::nBytes_type GetNBytes () const
 Retrieve the total number of bytes in this file. More...
 
FrEndOfFile::nFrames_type GetNFrames () const
 Retrieve the number of frames in this file. More...
 
FrEndOfFile::seekTOC_type GetSeekTOC () const
 Retrieve the location of the table of contents. More...
 
virtual FrEndOfFile::seekTOC_cmn_type SeekTOC () const
 Retrieve the location of the table of contents. More...
 
virtual void VerifyObject (Common::Verify &Verifier, Common::IFrameStream &Stream) const
 Verify the object.
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_type & WriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

Protected Member Functions

virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual void assign (assign_stream_type &Stream)
 Assign the contents of the instance. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Protected Attributes

nFrames_type m_nFrames
 Number of frames in this file.
 
nBytes_type m_nBytes
 Total number of bytes in the file; zero if not computed.
 
seekTOC_type m_seekTOC
 
chkSumFrHeader_type m_chkSumFrHeader
 FrHeader checksum.
 
chkSum_type m_chkSum
 
chkSumFile_type m_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]StreamAn 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]StreamAn 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]StreamThe 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]StreamThe 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]StreamThe 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]StreamThe 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,
istream_type *  Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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,
istream_type *  Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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,
istream_type *  Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream 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,
istream_type *  Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetChkSum() [1/2]

FrEndOfFile::chkSum_type FrameCPP::Version_8::FrEndOfFile::GetChkSum ( ) const

Retrieve the checksum.

Returns
The checksum.

◆ GetChkSum() [2/2]

FrEndOfFile::chkSum_type FrameCPP::Version_8::FrEndOfFile::GetChkSum ( ) const
inline

Retrieve the checksum.

Returns
The checksum.

◆ GetChkSumFile() [1/2]

FrEndOfFile::chkSumFile_type FrameCPP::Version_8::FrEndOfFile::GetChkSumFile ( ) const

Retrieve the file checksum.

Returns
The file checksum.

◆ GetChkSumFile() [2/2]

FrEndOfFile::chkSumFile_type FrameCPP::Version_8::FrEndOfFile::GetChkSumFile ( ) const
inline

Retrieve the file checksum.

Returns
The file checksum.

◆ GetChkSumFrHeader() [1/2]

FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFile::GetChkSumFrHeader ( ) const

Retrieve the FrHeader checksum.

Returns
The FrHEader checksum.

◆ GetChkSumFrHeader() [2/2]

FrEndOfFile::chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFile::GetChkSumFrHeader ( ) const
inline

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]

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

FrEndOfFile::nBytes_type FrameCPP::Version_8::FrEndOfFile::GetNBytes ( ) const

Retrieve the total number of bytes in this file.

Returns
The total number of bytes in this file.

◆ GetNBytes() [2/2]

FrEndOfFile::nBytes_type FrameCPP::Version_8::FrEndOfFile::GetNBytes ( ) const
inline

Retrieve the total number of bytes in this file.

Returns
The total number of bytes in this file.

◆ GetNFrames() [1/2]

FrEndOfFile::nFrames_type FrameCPP::Version_8::FrEndOfFile::GetNFrames ( ) const
inline

Retrieve the number of frames in this file.

Returns
The number of frames in this file.

◆ GetNFrames() [2/2]

FrEndOfFile::nFrames_type FrameCPP::Version_8::FrEndOfFile::GetNFrames ( ) const

Retrieve the number of frames in this file.

Returns
The number of frames in this file.

◆ GetSeekTOC() [1/2]

FrEndOfFile::seekTOC_type FrameCPP::Version_8::FrEndOfFile::GetSeekTOC ( ) const
inline

Retrieve the location of the table of contents.

Returns
The location of the table of contents.

◆ GetSeekTOC() [2/2]

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

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 FrEndOfFile RHS) const

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

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

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/4]

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

equality operator for abstract data type

Parameters
[in]RHSThe 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==() [4/4]

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

equality operator for abstract data type

Parameters
[in]RHSThe 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.

◆ promote() [1/2]

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

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe 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]

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

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe 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]

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

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/4]

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

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/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,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating 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,
istream_type *  Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating 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]

const Description * FrameCPP::Version_8::FrEndOfFile::StructDescription ( )
static

The description of structure.

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

◆ StructDescription() [2/2]

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

The description of structure.

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

◆ StructName() [1/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.

◆ StructName() [2/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.

◆ Write() [1/2]

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

Write the structure to the stream.

Parameters
[in]StreamThe 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]StreamThe 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]StreamThe 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]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ m_chkSum

chkSum_type FrameCPP::Version_8::FrEndOfFile::m_chkSum
protected

Structure checksum.

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

◆ m_seekTOC

seekTOC_type FrameCPP::Version_8::FrEndOfFile::m_seekTOC
protected

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: