ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
FrameCPP::Common::FrEndOfFile Class Referenceabstract

#include <FrEndOfFile.hh>

Inheritance diagram for FrameCPP::Common::FrEndOfFile:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface FrameCPP::Version_3::FrEndOfFile FrameCPP::Version_4::FrEndOfFile FrameCPP::Version_6::FrEndOfFile FrameCPP::Version_8::FrEndOfFile

Public Types

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 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 object_type promote_arg_type
 
typedef object_type promote_ret_type
 

Public Member Functions

 FrEndOfFile (const Description *Desc)
 
virtual ~FrEndOfFile ()
 
virtual nBytes_cmn_type NBytes () const =0
 
virtual seekTOC_cmn_type SeekTOC () const
 
virtual chkSum_cmn_type Filter (const Common::IStream &Stream, CheckSum &Check, chkType_cmn_type &Type, void *Buffer, INT_8U Size) const =0
 Run filters over the given bytes. More...
 
virtual void assign (assign_stream_type &Stream)=0
 Assign the contents of the instance. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () 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 streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual const char * ObjectStructName () const =0
 Retrieve the class name of the object. 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)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void Write (ostream_type &Stream) const =0
 Write object to the stream. More...
 

Static Public Member Functions

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 class_type getClass () const
 Retrieve the class identifier. More...
 
virtual demote_ret_type demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
 Demotes object to previous version of the frame spec. More...
 
virtual promote_ret_type promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
 Promotes object to another version of the frame spec. More...
 

Member Typedef Documentation

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

Constructor & Destructor Documentation

FrameCPP::Common::FrEndOfFile::FrEndOfFile ( const Description Desc)
FrameCPP::Common::FrEndOfFile::~FrEndOfFile ( )
virtual

Member Function Documentation

virtual void FrameCPP::Common::FrEndOfFile::assign ( assign_stream_type Stream)
pure virtual

Assign the contents of the instance.

Parameters
[in]StreamAn input stream from which to read information for the instance.

Implemented in FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_4::FrEndOfFile.

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectInterface::Bytes ( const StreamBase Stream) const
pure virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_6::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_3::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrVect, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_4::FrVect, FrameCPP::Version_3::FrProcData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSummary, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrMsg, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited
FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited
virtual Object* FrameCPP::Common::FrameSpec::ObjectInterface::Create ( istream_type Stream) const
pure virtualinherited

constructor - virtual

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_7::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSH, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

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.

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote ( frame_spec_version_type  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedpure virtualinherited

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.

Implemented in FrameCPP::Version_4::FrStatData, FrameCPP::Version_8::FrVect, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_7::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrProcData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_6::FrProcData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrHistory, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrMsg, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_6::FrStatData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_8::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSummary, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrEndOfFrame, and FrameCPP::Version_4::FrEndOfFrame.

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.
virtual chkSum_cmn_type FrameCPP::Common::FrEndOfFile::Filter ( const Common::IStream Stream,
CheckSum Check,
chkType_cmn_type Type,
void *  Buffer,
INT_8U  Size 
) const
pure virtual

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.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

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.

virtual nBytes_cmn_type FrameCPP::Common::FrEndOfFile::NBytes ( ) const
pure virtual
virtual const char* FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName ( ) const
pure virtualinherited

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrProcData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_3::FrVect, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrTOC, FrameCPP::Version_7::FrSimData, FrameCPP::Version_8::FrEvent, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrSimData, FrameCPP::Version_8::FrDetector, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSummary, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrHistory, FrameCPP::Version_8::FrRawData, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrTable, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrMsg, FrameCPP::Version_4::FrProcData, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSH, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrHeader, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrMsg, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, and FrameCPP::Version_3::FrHistory.

virtual bool FrameCPP::Common::FrameSpec::ObjectInterface::operator== ( const Object Obj) const
pure virtualinherited

comparison operator

Implemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_8::FrDetector, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrameH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrTable, FrameCPP::Version_7::FrSimData, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrHistory, FrameCPP::Version_6::FrProcData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrVect, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_8::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSummary, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_4::FrEndOfFile.

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote ( frame_spec_version_type  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedpure virtualinherited

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.

Implemented in FrameCPP::Version_4::FrStatData, FrameCPP::Version_8::FrVect, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrProcData, FrameCPP::Version_7::FrEvent, FrameCPP::Version_6::FrProcData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_3::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrHistory, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrMsg, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTOC, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_6::FrStatData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_8::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrHistory, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSummary, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrEndOfFrame, and FrameCPP::Version_4::FrEndOfFrame.

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.
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.
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
FrEndOfFile::seekTOC_cmn_type FrameCPP::Common::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 in FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type Stream) const
pure virtualinherited

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implemented in FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrTable, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_6::FrEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_7::FrEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_3::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_6::FrProcData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_4::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrTable, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrMsg, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrMsg, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

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

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

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