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

End of File data structure. More...

#include <FrEndOfFile.hh>

Inheritance diagram for FrameCPP::Version_8::FrEndOfFile:
FrameCPP::Common::FrEndOfFile FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef INT_4U nFrames_type
 
typedef INT_8U nBytes_type
 
typedef INT_8U seekTOC_type
 
typedef INT_4U chkSumFrHeader_type
 
typedef INT_4U chkSum_type
 
typedef INT_4U chkSumFile_type
 
typedef INT_8U nBytes_cmn_type
 
typedef INT_8U seekTOC_cmn_type
 
typedef INT_4U chkType_cmn_type
 
typedef INT_4U chkSum_cmn_type
 
typedef IStringStream assign_stream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef LDASTools::AL::SharedPtr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 

Public Member Functions

 FrEndOfFile ()
 Default constructor. More...
 
virtual ~FrEndOfFile ()
 Destructor. More...
 
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. More...
 
virtual FrEndOfFileCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual nBytes_cmn_type NBytes () const
 Retrieve the expected size of the stream. More...
 
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. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
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, IStream *Stream)
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::DescriptionStructDescription ()
 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 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 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. 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. More...
 

Protected Attributes

nFrames_type m_nFrames
 Number of frames in this file. More...
 
nBytes_type m_nBytes
 Total number of bytes in the file; zero if not computed. More...
 
seekTOC_type m_seekTOC
 
chkSumFrHeader_type m_chkSumFrHeader
 FrHeader checksum. More...
 
chkSum_type m_chkSum
 
chkSumFile_type m_chkSumFile
 File checksum. More...
 

Detailed Description

End of File data structure.

Member Typedef Documentation

◆ assign_stream_type

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

◆ chkSum_cmn_type

◆ chkSum_type

◆ chkSumFile_type

typedef INT_4U FrameCPP::Version_8::FrEndOfFile::chkSumFile_type

◆ chkSumFrHeader_type

typedef INT_4U FrameCPP::Version_8::FrEndOfFile::chkSumFrHeader_type

◆ chkType_cmn_type

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ nBytes_cmn_type

◆ nBytes_type

◆ nFrames_type

◆ object_type

typedef LDASTools::AL::SharedPtr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ promote_arg_type

◆ promote_ret_type

◆ seekTOC_cmn_type

◆ seekTOC_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ FrEndOfFile()

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

Default constructor.

Returns
A new instance of this object.

◆ ~FrEndOfFile()

FrameCPP::Version_8::FrEndOfFile::~FrEndOfFile ( )
virtual

Destructor.

Reimplemented from FrameCPP::Common::FrEndOfFile.

Member Function Documentation

◆ assign()

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.

Implements FrameCPP::Common::FrEndOfFile.

◆ Bytes()

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.

◆ Clone()

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

Virtual copy constructor.

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

◆ Create() [1/3]

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

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

◆ Create() [3/3]

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

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ demote()

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.

◆ DemoteObject()

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.

◆ GetChkSum()

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

Retrieve the checksum.

Returns
The checksum.

◆ GetChkSumFile()

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

Retrieve the file checksum.

Returns
The file checksum.

◆ GetChkSumFrHeader()

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

Retrieve the FrHeader checksum.

Returns
The FrHEader checksum.

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetDescription()

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.

◆ GetNBytes()

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()

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.

◆ GetSeekTOC()

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.

◆ NBytes()

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

Retrieve the expected size of the stream.

Implements FrameCPP::Common::FrEndOfFile.

◆ ObjectStructName()

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

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

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()

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

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

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

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,
IStream Stream 
)
inherited

◆ SeekTOC()

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.

Reimplemented from FrameCPP::Common::FrEndOfFile.

◆ StructDescription()

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.

◆ StructName()

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.

◆ VerifyObject()

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

Verify the object.

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

◆ Write()

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()

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_chkSumFile

chkSumFile_type FrameCPP::Version_8::FrEndOfFile::m_chkSumFile
protected

File checksum.

◆ m_chkSumFrHeader

chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFile::m_chkSumFrHeader
protected

FrHeader checksum.

◆ m_nBytes

nBytes_type FrameCPP::Version_8::FrEndOfFile::m_nBytes
protected

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

◆ m_nFrames

nFrames_type FrameCPP::Version_8::FrEndOfFile::m_nFrames
protected

Number of frames in this file.

◆ 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.

◆ s_object_id

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

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