ldas-tools-framecpp 2.8.1
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:
Inheritance graph
[legend]

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
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual const Description * GetDescription () const =0
 Get FrSH/FrSE description of object.
 
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...
 
virtual ~ObjectInterface ()
 Destructor.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual const Description * GetDescription () const =0
 Get FrSH/FrSE description of object.
 
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...
 
virtual ~ObjectInterface ()
 Destructor.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const =0
 Return the number of bytes for this object. More...
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (istream_type &Stream) const =0
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual const Description * GetDescription () const =0
 Get FrSH/FrSE description of object.
 
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...
 

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

Detailed Description

Interface to Objects.

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

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

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_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, and FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >.

◆ Bytes() [2/3]

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_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, and FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >.

◆ Bytes() [3/3]

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_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::PTR_STRUCT< DC, DI >, and FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >.

◆ demote() [1/3]

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

◆ demote() [2/3]

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

◆ demote() [3/3]

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

◆ DemoteObject() [1/3]

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.

◆ DemoteObject() [2/3]

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

◆ DemoteObject() [3/3]

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

◆ ObjectStructName() [1/3]

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

◆ ObjectStructName() [2/3]

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

◆ ObjectStructName() [3/3]

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

◆ promote() [1/3]

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

◆ promote() [2/3]

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

◆ promote() [3/3]

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

◆ PromoteObject() [1/6]

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

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

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

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

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

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.

◆ VerifyObject() [1/3]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

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

◆ VerifyObject() [2/3]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

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

◆ VerifyObject() [3/3]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

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

◆ Write() [1/3]

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::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.

◆ Write() [2/3]

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::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.

◆ Write() [3/3]

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::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.


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