ldas-tools-framecpp  2.6.5
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Common::FrameSpec::ObjectInterface Class Referenceabstract

Interface to Objects. More...

#include <FrameSpec.hh>

Inheritance diagram for FrameCPP::Common::FrameSpec::ObjectInterface:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameH FrameCPP::Common::FrDetector FrameCPP::Common::FrEndOfFile FrameCPP::Common::FrSH FrameCPP::Common::FrStatData FrameCPP::Common::FrTOC FrameCPP::Common::PTR_STRUCT_BASE FrameCPP::Common::StreamRefInterface FrameCPP::Version_3::FrAdcData FrameCPP::Version_3::FrEndOfFrame FrameCPP::Version_3::FrHeader FrameCPP::Version_3::FrHistory FrameCPP::Version_3::FrMsg FrameCPP::Version_3::FrProcData FrameCPP::Version_3::FrRawData FrameCPP::Version_3::FrSE FrameCPP::Version_3::FrSerData FrameCPP::Version_3::FrSimData FrameCPP::Version_3::FrSummary FrameCPP::Version_3::FrTrigData FrameCPP::Version_3::FrVect FrameCPP::Version_4::FrAdcData FrameCPP::Version_4::FrEndOfFrame FrameCPP::Version_4::FrProcData FrameCPP::Version_4::FrRawData FrameCPP::Version_4::FrSerData FrameCPP::Version_4::FrSimData FrameCPP::Version_4::FrSimEvent FrameCPP::Version_4::FrSummary FrameCPP::Version_4::FrTable FrameCPP::Version_4::FrTrigData FrameCPP::Version_4::FrVect FrameCPP::Version_6::FrAdcData FrameCPP::Version_6::FrEndOfFrame FrameCPP::Version_6::FrEvent FrameCPP::Version_6::FrMsg FrameCPP::Version_6::FrProcData FrameCPP::Version_6::FrRawData FrameCPP::Version_6::FrSerData FrameCPP::Version_6::FrSimData FrameCPP::Version_6::FrSimEvent FrameCPP::Version_6::FrSummary FrameCPP::Version_6::FrTable FrameCPP::Version_6::FrVect FrameCPP::Version_7::FrEvent FrameCPP::Version_7::FrRawData FrameCPP::Version_7::FrSerData FrameCPP::Version_7::FrSimData FrameCPP::Version_7::FrSimEvent FrameCPP::Version_8::FrHeader FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >

Public Types

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

virtual ~ObjectInterface ()
 Destructor. 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 DescriptionGetDescription () const =0
 Get FrSH/FrSE description of object. More...
 
virtual const char * ObjectStructName () const =0
 Retrieve the class name of the object. More...
 
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...
 
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 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...
 

Protected Member Functions

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...
 
virtual class_type getClass () const =0
 Retrieve the class name associated with the object. More...
 

Detailed Description

Interface to Objects.

This interface should be the base of all frame objects. It allows for generic handling of frame objects.

Member Typedef Documentation

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ object_type

◆ promote_arg_type

◆ promote_ret_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ ~ObjectInterface()

FrameCPP::Common::FrameSpec::ObjectInterface::~ObjectInterface ( )
virtual

Destructor.

Release the resources back to the system. By being virtual, all the resources associated with any derived class are given a chance for proper cleanup.

Member Function Documentation

◆ Bytes()

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

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_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrProcData, 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_6::FrTOC, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrHeader, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::FrSerData, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrMsg, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

◆ Clone()

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtual

◆ Create() [1/3]

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

◆ Create() [2/3]

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

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_4::FrSimEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrProcData, 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_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_3::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_4::FrEndOfFrame, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHistory.

◆ Create() [3/3]

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

constructor - virtual

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

◆ demote()

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

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

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
static

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.

◆ getClass()

virtual class_type FrameCPP::Common::FrameSpec::ObjectInterface::getClass ( ) const
protectedpure virtual

Retrieve the class name associated with the object.

Implemented in FrameCPP::Common::FrameSpec::Object.

◆ GetDescription()

virtual const Description* FrameCPP::Common::FrameSpec::ObjectInterface::GetDescription ( ) const
pure virtual

Get FrSH/FrSE description of object.

Implemented in FrameCPP::Common::FrameSpec::Object.

◆ ObjectStructName()

virtual const char* FrameCPP::Common::FrameSpec::ObjectInterface::ObjectStructName ( ) const
pure virtual

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

◆ operator==()

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

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_4::FrSimEvent, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrDetector, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_3::FrVect, 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_6::FrVect, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrMsg, FrameCPP::Version_3::FrSimData, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrHistory, FrameCPP::Version_7::FrSimData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_4::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrDetector, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrameH, FrameCPP::Version_4::FrTOC, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrSH, FrameCPP::Version_4::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_4::FrDetector, FrameCPP::Version_3::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_3::FrDetector, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_6::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_4::FrProcData, 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.

◆ promote()

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

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

◆ 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 
)
static

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

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 
)

◆ VerifyObject()

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

◆ Write()

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type Stream) const
pure virtual

Write object to the stream.

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

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


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