ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T > Struct Template Reference

Holder of Stream reference to an object within the stream. More...

#include <PTR_STRUCT.hh>

Inheritance diagram for FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >:
Collaboration diagram for FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >:

Public Types

typedef DC data_class_type
 
typedef DI data_instance_type
 
typedef PTR_STRUCT_BASE::class_type class_type
 
typedef PTR_STRUCT_BASE::instance_type instance_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 stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 

Public Member Functions

 PTR_STRUCT ()
 Default constructor.
 
 PTR_STRUCT (data_class_type ClassId, data_instance_type Instance)
 Constructor.
 
virtual class_type Class () const
 Retrieve the class identifier.
 
virtual void Class (class_type Value)
 Establish the class identifier.
 
data_class_type ClassRaw () const
 Retrieve the class identifier.
 
virtual instance_type Instance () const
 Retrieve the instance of the class.
 
virtual void Instance (instance_type Value)
 Establish the instance of the class.
 
data_instance_type InstanceRaw () const
 Establish the instance of the class.
 
const PTR_STRUCToperator= (const PTR_STRUCT &RHS)
 Assignment operator.
 
cmn_streamsize_type Bytes (const StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual PTR_STRUCTCreate (IStream &Stream) const
 Virtual constructor.
 
virtual PTR_STRUCTClone () const
 Virtual constructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual void Write (OStream &Stream) const
 Write the structure to the stream.
 
bool operator== (const PTR_STRUCT &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
bool operator!= (const PTR_STRUCT &RHS) const
 comparison operator
 
 PTR_STRUCT ()
 Default constructor.
 
 PTR_STRUCT (data_class_type ClassId, data_instance_type Instance)
 Constructor.
 
virtual class_type Class () const
 Retrieve the class identifier.
 
virtual void Class (class_type Value)
 Establish the class identifier.
 
data_class_type ClassRaw () const
 Retrieve the class identifier.
 
virtual instance_type Instance () const
 Retrieve the instance of the class.
 
virtual void Instance (instance_type Value)
 Establish the instance of the class.
 
data_instance_type InstanceRaw () const
 Establish the instance of the class.
 
const PTR_STRUCToperator= (const PTR_STRUCT &RHS)
 Assignment operator.
 
cmn_streamsize_type Bytes (const StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual PTR_STRUCTCreate (IStream &Stream) const
 Virtual constructor.
 
virtual PTR_STRUCTClone () const
 Virtual constructor.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual void Write (OStream &Stream) const
 Write the structure to the stream.
 
bool operator== (const PTR_STRUCT &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
bool operator!= (const PTR_STRUCT &RHS) const
 comparison operator
 
bool IsNULL () const
 Determine if the reference represents a NULL reference.
 
bool IsNULL () const
 Determine if the reference represents a NULL reference.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
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, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 

Static Public Member Functions

static cmn_streamsize_type Bytes ()
 Number of bytes needed to write this structure.
 
static cmn_streamsize_type Bytes ()
 Number of bytes needed to write this structure.
 
static std::string Desc (const std::string &Type)
 Describe the reference object.
 
static std::string Desc (const std::string &Type)
 Describe the reference object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_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, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_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, stream_base_type *Stream)
 Upgrade an object.
 

Static Public Attributes

static const PTR_STRUCTNULL_PTR
 Version specific NULL reference.
 

Protected Member Functions

virtual FrameSpec::ObjectInterface::demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual FrameSpec::ObjectInterface::promote_ret_type promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual FrameSpec::ObjectInterface::demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual FrameSpec::ObjectInterface::promote_ret_type promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Private Member Functions

 PTR_STRUCT (IStream &Stream)
 
 PTR_STRUCT (const PTR_STRUCT &Source)
 
 PTR_STRUCT (IStream &Stream)
 
 PTR_STRUCT (const PTR_STRUCT &Source)
 

Private Attributes

data_class_type data_class
 The class identifier.
 
data_instance_type data_instance
 Occurence counter.
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Detailed Description

template<class DC, class DI, int SPEC_VERSION_T>
struct FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >

Holder of Stream reference to an object within the stream.

This is a version specific interface to the information.

Member Typedef Documentation

◆ class_type

template<class DC , class DI , int SPEC_VERSION_T>
typedef PTR_STRUCT_BASE::class_type PTR_STRUCT::class_type

◆ data_class_type

template<class DC , class DI , int SPEC_VERSION_T>
typedef DC PTR_STRUCT::data_class_type

◆ data_instance_type

template<class DC , class DI , int SPEC_VERSION_T>
typedef DI PTR_STRUCT::data_instance_type

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ frame_spec_version_type

◆ instance_type

template<class DC , class DI , int SPEC_VERSION_T>
typedef PTR_STRUCT_BASE::instance_type PTR_STRUCT::instance_type

◆ object_type

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

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ PTR_STRUCT() [1/8]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT::PTR_STRUCT ( )
inline

Default constructor.

Returns
New instance of this object

◆ PTR_STRUCT() [2/8]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT::PTR_STRUCT ( data_class_type ClassId,
data_instance_type Instance )
inline

Constructor.

Parameters
[in]ClassId
[in]Instance
Returns
New instance of this object

◆ PTR_STRUCT() [3/8]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT::PTR_STRUCT ( IStream & Stream)
inlineprivate

◆ PTR_STRUCT() [4/8]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT::PTR_STRUCT ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & Source)
inlineprivate

◆ PTR_STRUCT() [5/8]

template<class DC , class DI , int SPEC_VERSION_T>
FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::PTR_STRUCT ( )

Default constructor.

Returns
New instance of this object

◆ PTR_STRUCT() [6/8]

template<class DC , class DI , int SPEC_VERSION_T>
FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::PTR_STRUCT ( data_class_type ClassId,
data_instance_type Instance )

Constructor.

Parameters
[in]ClassId
[in]Instance
Returns
New instance of this object

◆ PTR_STRUCT() [7/8]

template<class DC , class DI , int SPEC_VERSION_T>
FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::PTR_STRUCT ( IStream & Stream)
private

◆ PTR_STRUCT() [8/8]

template<class DC , class DI , int SPEC_VERSION_T>
FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::PTR_STRUCT ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & Source)
private

Member Function Documentation

◆ Bytes() [1/4]

template<class DC , class DI , int SPEC_VERSION_T>
cmn_streamsize_type PTR_STRUCT::Bytes ( )
inlinestatic

Number of bytes needed to write this structure.

Returns
The number of bytes need to read or write this object.

◆ Bytes() [2/4]

template<class DC , class DI , int SPEC_VERSION_T>
static cmn_streamsize_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Bytes ( )
static

Number of bytes needed to write this structure.

Returns
The number of bytes need to read or write this object.

◆ Bytes() [3/4]

template<class DC , class DI , int SPEC_VERSION_T>
cmn_streamsize_type PTR_STRUCT::Bytes ( const StreamBase & Stream) const
inlinevirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

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

◆ Bytes() [4/4]

template<class DC , class DI , int SPEC_VERSION_T>
cmn_streamsize_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Bytes ( const StreamBase & Stream) const
virtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

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

◆ Class() [1/4]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT< DC, DI, SPEC_VERSION_T >::class_type PTR_STRUCT::Class ( ) const
virtual

Retrieve the class identifier.

Returns
The class identifier.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Class() [2/4]

template<class DC , class DI , int SPEC_VERSION_T>
virtual class_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Class ( ) const
virtual

Retrieve the class identifier.

Returns
The class identifier.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Class() [3/4]

template<class DC , class DI , int SPEC_VERSION_T>
void PTR_STRUCT::Class ( class_type Value)
virtual

Establish the class identifier.

Parameters
[in]ValueThe class identifier.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Class() [4/4]

template<class DC , class DI , int SPEC_VERSION_T>
virtual void FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Class ( class_type Value)
virtual

Establish the class identifier.

Parameters
[in]ValueThe class identifier.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ ClassRaw() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
data_class_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::ClassRaw ( ) const
inline

Retrieve the class identifier.

◆ ClassRaw() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
data_class_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::ClassRaw ( ) const
inline

Retrieve the class identifier.

◆ Clone() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT< DC, DI, SPEC_VERSION_T > * PTR_STRUCT::Clone ( ) const
inlinevirtual

Virtual constructor.

Returns
A new instance of this object.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Clone() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
virtual PTR_STRUCT * FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Clone ( ) const
virtual

Virtual constructor.

Returns
A new instance of this object.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Create() [1/4]

◆ Create() [2/4]

◆ Create() [3/4]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT< DC, DI, SPEC_VERSION_T > * PTR_STRUCT::Create ( IStream & Stream) const
inlinevirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

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

◆ Create() [4/4]

template<class DC , class DI , int SPEC_VERSION_T>
virtual PTR_STRUCT * FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Create ( IStream & Stream) const
virtual

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

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

◆ demote() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
FrameSpec::ObjectInterface::demote_ret_type PTR_STRUCT::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

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.

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

◆ demote() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
virtual FrameSpec::ObjectInterface::demote_ret_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

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.

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

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_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.

◆ Desc() [1/2]

std::string FrameCPP::Common::PTR_STRUCT_BASE::Desc ( const std::string & Type)
inlinestaticinherited

Describe the reference object.

Parameters
[in]TypeThe type of object being referenced.
Returns
The text that describes the pointer reference.

Output the descriptive text that needs to be part of the FrSE object used to describe the entirety of an object.

◆ Desc() [2/2]

static std::string FrameCPP::Common::PTR_STRUCT_BASE::Desc ( const std::string & Type)
staticinherited

Describe the reference object.

Parameters
[in]TypeThe type of object being referenced.
Returns
The text that describes the pointer reference.

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetDescription() [1/4]

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.

◆ GetDescription() [2/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [3/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream) const
virtualinherited

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

Reimplemented in FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ GetDescription() [4/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream) const
virtualinherited

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

Reimplemented in FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ Instance() [1/4]

template<class DC , class DI , int SPEC_VERSION_T>
PTR_STRUCT< DC, DI, SPEC_VERSION_T >::instance_type PTR_STRUCT::Instance ( ) const
virtual

Retrieve the instance of the class.

Returns
The instance of the class.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Instance() [2/4]

template<class DC , class DI , int SPEC_VERSION_T>
virtual instance_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Instance ( ) const
virtual

Retrieve the instance of the class.

Returns
The instance of the class.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Instance() [3/4]

template<class DC , class DI , int SPEC_VERSION_T>
void PTR_STRUCT::Instance ( instance_type Value)
virtual

Establish the instance of the class.

Parameters
[in]ValueThe instance of the class.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ Instance() [4/4]

template<class DC , class DI , int SPEC_VERSION_T>
virtual void FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Instance ( instance_type Value)
virtual

Establish the instance of the class.

Parameters
[in]ValueThe instance of the class.

Implements FrameCPP::Common::PTR_STRUCT_BASE.

◆ InstanceRaw() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
data_instance_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::InstanceRaw ( ) const
inline

Establish the instance of the class.

Returns
The instance of the class.

◆ InstanceRaw() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
data_instance_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::InstanceRaw ( ) const
inline

Establish the instance of the class.

Returns
The instance of the class.

◆ IsNULL() [1/2]

bool FrameCPP::Common::PTR_STRUCT_BASE::IsNULL ( ) const
inlineinherited

Determine if the reference represents a NULL reference.

A NULL reference is used to terminate a list of objects.

Returns
True if the reference represents a NULL reference, false otherwise.

◆ IsNULL() [2/2]

bool FrameCPP::Common::PTR_STRUCT_BASE::IsNULL ( ) const
inherited

Determine if the reference represents a NULL reference.

Returns
True if the reference represents a NULL reference, false otherwise.

◆ ObjectStructName() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
const char * PTR_STRUCT::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

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

◆ ObjectStructName() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
virtual const char * FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::ObjectStructName ( ) const
virtual

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

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

◆ operator!=() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
bool PTR_STRUCT::operator!= ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & RHS) const
inline

comparison operator

Parameters
[in]RHSThe PTR_STRUCT to compare.

◆ operator!=() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
bool FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::operator!= ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & RHS) const

comparison operator

Parameters
[in]RHSThe PTR_STRUCT to compare.

◆ operator=() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & PTR_STRUCT::operator= ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & RHS)

Assignment operator.

Parameters
[in]RHSThe source to copy.
Returns
Reference to this object.

◆ operator=() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
const PTR_STRUCT & FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::operator= ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & RHS)

Assignment operator.

Parameters
[in]RHSThe source to copy.
Returns
Reference to this object.

◆ operator==() [1/4]

template<class DC , class DI , int SPEC_VERSION_T>
bool PTR_STRUCT::operator== ( const Common::FrameSpec::Object & Obj) const
inlinevirtual

comparison operator

Parameters
[in]ObjThe stream object to compare.
Returns
True if this PTR_STRUCT references Obj.

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

◆ operator==() [2/4]

template<class DC , class DI , int SPEC_VERSION_T>
virtual bool FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

comparison operator

Parameters
[in]ObjThe stream object to compare.
Returns
True if this PTR_STRUCT references Obj.

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

◆ operator==() [3/4]

template<class DC , class DI , int SPEC_VERSION_T>
bool PTR_STRUCT::operator== ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & RHS) const
inline

comparison operator

Parameters
[in]RHSThe PTR_STRUCT to compare.
Returns
True if the two PTR_STRUCT elements reference the same stream object.

◆ operator==() [4/4]

template<class DC , class DI , int SPEC_VERSION_T>
bool FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::operator== ( const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & RHS) const

comparison operator

Parameters
[in]RHSThe PTR_STRUCT to compare.
Returns
True if the two PTR_STRUCT elements reference the same stream object.

◆ promote() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
FrameSpec::ObjectInterface::promote_ret_type PTR_STRUCT::promote ( INT_2U Target,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

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.

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

◆ promote() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
virtual FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::promote ( INT_2U Target,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

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.

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

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_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/5]

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,
stream_base_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/5]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_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() [4/5]

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

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,
promote_stream_type * Stream )
inherited

◆ VerifyObject() [1/2]

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

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_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/2]

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

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_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ Write() [1/2]

template<class DC , class DI , int SPEC_VERSION_T>
void PTR_STRUCT::Write ( OStream & Stream) const
inlinevirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ Write() [2/2]

template<class DC , class DI , int SPEC_VERSION_T>
virtual void FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >::Write ( OStream & Stream) const
virtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ WriteNext() [1/2]

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.

◆ WriteNext() [2/2]

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

◆ data_class

template<class DC , class DI , int SPEC_VERSION_T>
data_class_type PTR_STRUCT::data_class
private

The class identifier.

The class identifier of the object. The values of 0, 1, and 2 are reserved by the frame specification. The value 0 is used to partially identify the end of series of chained objects. The value 1 is reserved to identify the FrSH class of objects. The vlaue 2 is reserved to identify the FrSE class of objects. All other values are at the descretion of the library implementing the frame specification.

◆ data_instance

template<class DC , class DI , int SPEC_VERSION_T>
data_instance_type PTR_STRUCT::data_instance
private

Occurence counter.

Counter for occurrence of this class of object within the current frame or current file. It starts from zero (0).

Note
All instance counters are set to zero (0) after FrEndOfFrame and FrEndOfFile.

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ NULL_PTR

template<class DC , class DI , int SPEC_VERSION_T>
const PTR_STRUCT< DC, DI, SPEC_VERSION_T > & PTR_STRUCT::NULL_PTR
static
Initial value:
=
PTR_STRUCT()
Default constructor.
Definition PTR_STRUCT.hh:313

Version specific NULL reference.


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