ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrEndOfFile Class Reference

End of File data structure. More...

#include <FrEndOfFile.hh>

Inheritance diagram for FrameCPP::Version_8::FrEndOfFile:
Collaboration diagram for FrameCPP::Version_8::FrEndOfFile:

Public Types

typedef INT_8U nBytes_cmn_type
 
typedef INT_4U nFrames_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 boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
typedef FR_END_OF_FILE_N_FRAMES_TYPE nFrames_type
 
typedef FR_END_OF_FILE_N_BYTES_TYPE nBytes_type
 
typedef FR_END_OF_FILE_SEEK_TOC_TYPE seekTOC_type
 
typedef FR_END_OF_FILE_CHK_SUM_FR_HEADER_TYPE chkSumFrHeader_type
 
typedef FR_END_OF_FILE_CHK_SUM_TYPE chkSum_type
 
typedef FR_END_OF_FILE_CHK_SUM_FILE_TYPE chkSumFile_type
 

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 FrEndOfFileClone () const
 Virtual copy constructor.
 
virtual FrEndOfFileCreate (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 FrEndOfFileClone () const
 Virtual copy constructor.
 
virtual FrEndOfFileCreate (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 DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (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)
 
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::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 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.
 

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

Private Member Functions

 FrEndOfFile (istream_type &Source)
 
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)
 
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.
 
void load (Archive &archiver, const unsigned int version)
 
void load (Archive &archiver, const unsigned int version)
 
void save (Archive &archiver, const unsigned int version) const
 
void save (Archive &archiver, const unsigned int version) const
 

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.
 

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

◆ chkSumFrHeader_type

◆ chkType_cmn_type

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ frame_spec_version_type

◆ nBytes_cmn_type

◆ nBytes_type

◆ nFrames_cmn_type

◆ nFrames_type

◆ object_type

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

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ seekTOC_cmn_type

◆ seekTOC_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ FrEndOfFile() [1/4]

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

Default constructor.

Returns
A new instance of this object.

◆ ~FrEndOfFile() [1/2]

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

Destructor.

Reimplemented from FrameCPP::Common::FrEndOfFile.

◆ FrEndOfFile() [2/4]

FrameCPP::Version_8::FrEndOfFile::FrEndOfFile ( istream_type & Source)
private

◆ FrEndOfFile() [3/4]

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

Default constructor.

Returns
A new instance of this object.

◆ ~FrEndOfFile() [2/2]

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

Destructor.

Reimplemented from FrameCPP::Common::FrEndOfFile.

◆ FrEndOfFile() [4/4]

FrameCPP::Version_8::FrEndOfFile::FrEndOfFile ( istream_type & Source)
private

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.

Implements FrameCPP::Common::FrEndOfFile.

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

Implements FrameCPP::Common::FrEndOfFile.

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

◆ Clone() [1/2]

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

Virtual copy constructor.

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

◆ Clone() [2/2]

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

Virtual copy constructor.

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

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

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

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,
demote_stream_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,
demote_stream_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,
demote_stream_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,
demote_stream_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.

◆ Filter() [1/2]

FrEndOfFile::chkSum_cmn_type FrameCPP::Version_8::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]StreamThe source of the bytes to read.
[in,out]CheckThe running checksum calculation
[out]TypeThe recorded CRC type present in this structure when read from the stream.
[in]BufferThe bytes to be filtered
[in]SizeThe number of bytes in Buffer to be checked.
Returns
The checksum value recorded within the FrEndOfFile structure.

Implements FrameCPP::Common::FrEndOfFile.

◆ Filter() [2/2]

chkSum_cmn_type FrameCPP::Version_8::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]StreamThe source of the bytes to read.
[in,out]CheckThe running checksum calculation
[out]TypeThe recorded CRC type present in this structure when read from the stream.
[in]BufferThe bytes to be filtered
[in]SizeThe 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

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

◆ 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::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, 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::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ 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::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, 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::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

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

◆ load() [1/2]

void FrameCPP::Version_8::FrEndOfFileImpl::SerialIO< FrEndOfFile >::load ( Archive & archiver,
const unsigned int version )
inlineprivateinherited

◆ load() [2/2]

void FrameCPP::Version_8::FrEndOfFileImpl::SerialIO< FrEndOfFile >::load ( Archive & archiver,
const unsigned int version )
inlineprivateinherited

◆ NBytes() [1/2]

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

Retrieve the expected size of the stream.

Implements FrameCPP::Common::FrEndOfFile.

◆ NBytes() [2/2]

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

Retrieve the expected size of the stream.

Implements FrameCPP::Common::FrEndOfFile.

◆ NFrames() [1/2]

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

Retrieve the number of frames in the stream.

Implements FrameCPP::Common::FrEndOfFile.

◆ NFrames() [2/2]

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

Retrieve the number of frames in the stream.

Implements FrameCPP::Common::FrEndOfFile.

◆ 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]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==() [2/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==() [3/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==() [4/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.

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

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

◆ save() [1/2]

void FrameCPP::Version_8::FrEndOfFileImpl::SerialIO< FrEndOfFile >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivateinherited

◆ save() [2/2]

void FrameCPP::Version_8::FrEndOfFileImpl::SerialIO< FrEndOfFile >::save ( Archive & archiver,
const unsigned int version ) const
inlineprivateinherited

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

Reimplemented from FrameCPP::Common::FrEndOfFile.

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

Reimplemented from FrameCPP::Common::FrEndOfFile.

◆ StructDescription() [1/2]

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

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::FrEndOfFileImpl::ClassicIO< FrEndOfFile >::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.

◆ VerifyObject() [1/2]

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

Verify the object.

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

◆ VerifyObject() [2/2]

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

Verify the object.

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

◆ 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

◆ 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

◆ chkSumFile

chkSumFile_type FrameCPP::Version_8::FrEndOfFileImpl::Data::chkSumFile
protectedinherited

File checksum.

◆ chkSumFrHeader

chkSumFrHeader_type FrameCPP::Version_8::FrEndOfFileImpl::Data::chkSumFrHeader
protectedinherited

FrHeader checksum.

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

◆ nBytes

nBytes_type FrameCPP::Version_8::FrEndOfFileImpl::Data::nBytes
protectedinherited

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

◆ nFrames

nFrames_type FrameCPP::Version_8::FrEndOfFileImpl::Data::nFrames
protectedinherited

Number of frames in this file.

◆ s_object_id

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

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