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

#include <StreamRefInterface.hh>

Inheritance diagram for FrameCPP::Common::StreamRefInterface:
FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface FrameCPP::Common::StreamRef< LT, CT, IT > FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >

Public Types

typedef INT_2U class_type
 
typedef INT_4U instance_type
 
typedef INT_8U length_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

 StreamRefInterface ()
 
virtual void assign (IStringStream &Stream)=0
 
virtual class_type GetClass () const =0
 
virtual instance_type GetInstance () const =0
 
virtual length_type GetLength () const =0
 
virtual void SetClass (class_type Class)=0
 
virtual void SetInstance (instance_type Instance)=0
 
virtual void SetLength (length_type Length)=0
 
virtual FrameSpec::size_type SizeOf () const =0
 
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...
 

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

◆ class_type

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ instance_type

◆ length_type

◆ object_type

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

◆ promote_arg_type

◆ promote_ret_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ StreamRefInterface()

FrameCPP::Common::StreamRefInterface::StreamRefInterface ( )

Member Function Documentation

◆ assign()

virtual void FrameCPP::Common::StreamRefInterface::assign ( IStringStream Stream)
pure virtual

◆ Bytes()

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_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
virtualinherited

◆ Create() [1/3]

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

◆ Create() [2/3]

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_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
virtualinherited

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

◆ GetClass()

virtual class_type FrameCPP::Common::StreamRefInterface::GetClass ( ) const
pure virtual

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetDescription()

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetInstance()

virtual instance_type FrameCPP::Common::StreamRefInterface::GetInstance ( ) const
pure virtual

◆ GetLength()

virtual length_type FrameCPP::Common::StreamRefInterface::GetLength ( ) const
pure virtual

◆ ObjectStructName()

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_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 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_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 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_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 
)
staticinherited

Upgrade an object.

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

◆ PromoteObject() [2/3]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

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

◆ PromoteObject() [3/3]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ SetClass()

virtual void FrameCPP::Common::StreamRefInterface::SetClass ( class_type  Class)
pure virtual

◆ SetInstance()

virtual void FrameCPP::Common::StreamRefInterface::SetInstance ( instance_type  Instance)
pure virtual

◆ SetLength()

virtual void FrameCPP::Common::StreamRefInterface::SetLength ( length_type  Length)
pure virtual

◆ SizeOf()

virtual FrameSpec::size_type FrameCPP::Common::StreamRefInterface::SizeOf ( ) const
pure virtual

◆ VerifyObject()

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

◆ Write()

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

◆ WriteNext()

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

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