ldas-tools-framecpp 2.7.0
|
Interface definition for an FrSH structure. More...
#include <FrSH.hh>
Public Member Functions | |
virtual const std::string & | name () const =0 |
virtual void | assign (assign_stream_type &Stream)=0 |
Assign the contents of the instance. | |
virtual const std::string & | name () const =0 |
virtual void | assign (assign_stream_type &Stream)=0 |
Assign the contents of the instance. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
class_type | GetClass () const |
Retrieve the class identifier. | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const =0 |
Return the number of bytes for this object. | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const =0 |
Return the number of bytes for this object. | |
virtual Object * | Create () const |
constructor - virtual | |
virtual Object * | Create (istream_type &Stream) const =0 |
constructor - virtual | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
constructor - virtual | |
virtual Object * | Create (istream_type &Stream) const =0 |
constructor - virtual | |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual bool | operator== (const Object &Obj) const =0 |
comparison operator | |
virtual bool | operator== (const Object &Obj) const =0 |
comparison operator | |
virtual Object * | Clone () const |
constructor - virtual copy constructor | |
virtual Object * | Clone () const |
constructor - virtual copy constructor | |
virtual const char * | ObjectStructName () const =0 |
Retrieve the class name of the object. | |
virtual const char * | ObjectStructName () const =0 |
Retrieve the class name of the object. | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. | |
virtual void | Write (ostream_type &Stream) const =0 |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const =0 |
Write object to the stream. | |
Static Public Member Functions | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. | |
Protected Member Functions | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
virtual class_type | getClass () const |
Retrieve the class identifier. | |
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. | |
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. | |
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. | |
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. | |
Interface definition for an FrSH structure.
|
pure virtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
pure virtual |
Assign the contents of the instance.
[in] | Stream | An input stream from which to read information for the instance. |
|
pure virtualinherited |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
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::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::FrStatData, 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::FrStatData, 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 >.
|
pure virtualinherited |
Return the number of bytes for this object.
[in] | Stream | The stream on which the object will be written or read. |
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::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::FrStatData, 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::FrStatData, 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 >.
|
protectedpure virtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
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::Version_3::FrAdcData, 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_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
protectedpure virtualinherited |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
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::Version_3::FrAdcData, 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_4::FrAdcData, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inlineinherited |
Retrieve the class identifier.
|
inherited |
Retrieve the class identifier.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
virtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
pure virtual |
|
pure virtual |
|
pure virtualinherited |
Retrieve the class name of the object.
Implemented in FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, 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::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, 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.
|
pure virtualinherited |
Retrieve the class name of the object.
Implemented in FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, 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::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, 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.
|
protectedpure virtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implemented in FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
protectedpure virtualinherited |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
Implemented in FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_8::FrEndOfFile, and FrameCPP::Version_8::FrHeader.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The 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, and FrameCPP::Version_8::FrHeader.
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The 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, and FrameCPP::Version_8::FrHeader.
|
pure virtualinherited |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
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, and FrameCPP::Version_8::FrHeader.
|
pure virtualinherited |
Write object to the stream.
[in,out] | Stream | The stream being written with the contents of object. |
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, and FrameCPP::Version_8::FrHeader.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |