ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrStatData Class Reference

Static Data Structure Definition. More...

#include <FrStatData.hh>

Inheritance diagram for FrameCPP::Version_8::FrStatData:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrStatData:
Collaboration graph
[legend]

Public Types

typedef FrStatDataNPS nps_type
 
typedef FrStatDataPS ps_type
 
typedef FrStatDataNPS nps_type
 
typedef FrStatDataPS ps_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef boost::shared_ptr< TDetector > detector_type
 
typedef boost::shared_ptr< TDetector > detector_type
 
typedef boost::shared_ptr< TDetector > const const_detector_type
 
typedef boost::shared_ptr< TDetector > const const_detector_type
 
typedef Common::SearchContainer< TVect, &TVect::GetName > data_type
 
typedef Common::SearchContainer< TVect, &TVect::GetName > data_type
 
typedef data_type::iterator iterator
 
typedef data_type::iterator iterator
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::const_iterator const_iterator
 
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > table_type
 
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > table_type
 
typedef table_type::iterator table_iterator
 
typedef table_type::iterator table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrStatData ()
 Default constructor.
 
 FrStatData (const FrStatData &Source)
 Copy Constructor.
 
 FrStatData (const std::string &name, const std::string &comment, const std::string &representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version)
 Constructor.
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor.
 
virtual FrStatDataClone () const
 Virtual constructor.
 
virtual fr_detector_type GetDetector () const
 Retrieve the detector associated with the object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData.
 
bool operator== (const FrStatData &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrStatData ()
 Default constructor.
 
 FrStatData (const FrStatData &Source)
 Copy Constructor.
 
 FrStatData (const std::string &name, const std::string &comment, const std::string &representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version)
 Constructor.
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor.
 
virtual FrStatDataClone () const
 Virtual constructor.
 
virtual fr_detector_type GetDetector () const
 Retrieve the detector associated with the object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData.
 
bool operator== (const FrStatData &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
detector_type GetDetector ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
detector_typeAddressOfDetector () const
 
detector_typeAddressOfDetector () const
 
void SetDetector (detector_type Detector)
 
void SetDetector (detector_type Detector)
 
bool operator== (const FrStatDataPST &RHS) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 

Static Public Attributes

static const INT_2U MAX_REF = 3
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrStatDatapCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrStatDatapCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 

Protected Attributes

ref_type m_refs
 

Private Types

typedef ObjectWithChecksum< Common::FrStatDataobject_type
 Object with checksum data.
 
typedef ObjectWithChecksum< Common::FrStatDataobject_type
 Object with checksum data.
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_typeobject_base_type
 

Private Member Functions

 FrStatData (istream_type &Stream)
 Stream Constructor.
 
 FrStatData (istream_type &Stream)
 Stream Constructor.
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

Static Data Structure Definition.

Member Typedef Documentation

◆ const_detector_type [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef boost::shared_ptr< TDetector > const FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::const_detector_type
inherited

◆ const_detector_type [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef boost::shared_ptr< TDetector > const FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::const_detector_type
inherited

◆ const_iterator [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef data_type::const_iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::const_iterator
inherited

◆ const_iterator [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef data_type::const_iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::const_iterator
inherited

◆ const_table_iterator [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef table_type::const_iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::const_table_iterator
inherited

◆ const_table_iterator [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef table_type::const_iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::const_table_iterator
inherited

◆ data_type [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::data_type
inherited

◆ data_type [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::data_type
inherited

◆ detector_type [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef boost::shared_ptr< TDetector > FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::detector_type
inherited

◆ detector_type [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef boost::shared_ptr< TDetector > FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::detector_type
inherited

◆ istream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ iterator [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef data_type::iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::iterator
inherited

◆ iterator [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef data_type::iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::iterator
inherited

◆ nps_type [1/2]

typedef FrStatDataNPS FrameCPP::Version_8::FrStatData::nps_type

◆ nps_type [2/2]

typedef FrStatDataNPS FrameCPP::Version_8::FrStatData::nps_type

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrStatData > FrameCPP::Version_8::FrStatData::object_type
private

Object with checksum data.

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrStatData > FrameCPP::Version_8::FrStatData::object_type
private

Object with checksum data.

◆ ostream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ps_type [1/2]

typedef FrStatDataPS FrameCPP::Version_8::FrStatData::ps_type

◆ ps_type [2/2]

typedef FrStatDataPS FrameCPP::Version_8::FrStatData::ps_type

◆ self_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ table_iterator [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef table_type::iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::table_iterator
inherited

◆ table_iterator [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef table_type::iterator FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::table_iterator
inherited

◆ table_type [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::table_type
inherited

◆ table_type [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::table_type
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

Constructor & Destructor Documentation

◆ FrStatData() [1/10]

FrameCPP::Version_8::FrStatData::FrStatData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [2/10]

FrameCPP::Version_8::FrStatData::FrStatData ( const FrStatData Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrStatData() [3/10]

FrameCPP::Version_8::FrStatData::FrStatData ( const std::string &  name,
const std::string &  comment,
const std::string &  representation,
INT_4U  timeStart,
INT_4U  timeEnd,
INT_4U  version 
)

Constructor.

Parameters
[in]nameStatic data name
[in]commentComemnt
[in]representationType of static data being represented
[in]timeStartStart time of static data validity.
[in]timeEndEnd time of static data validity.
[in]versionVersion number of this static structure.
Returns
A new instance of the object.

◆ FrStatData() [4/10]

FrameCPP::Version_8::FrStatData::FrStatData ( const Previous::FrStatData Source,
istream_type Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of the object.

◆ FrStatData() [5/10]

FrameCPP::Version_8::FrStatData::FrStatData ( istream_type Stream)
private

Stream Constructor.

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

◆ FrStatData() [6/10]

FrameCPP::Version_8::FrStatData::FrStatData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [7/10]

FrameCPP::Version_8::FrStatData::FrStatData ( const FrStatData Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrStatData() [8/10]

FrameCPP::Version_8::FrStatData::FrStatData ( const std::string &  name,
const std::string &  comment,
const std::string &  representation,
INT_4U  timeStart,
INT_4U  timeEnd,
INT_4U  version 
)

Constructor.

Parameters
[in]nameStatic data name
[in]commentComemnt
[in]representationType of static data being represented
[in]timeStartStart time of static data validity.
[in]timeEndEnd time of static data validity.
[in]versionVersion number of this static structure.
Returns
A new instance of the object.

◆ FrStatData() [9/10]

FrameCPP::Version_8::FrStatData::FrStatData ( const Previous::FrStatData Source,
istream_type Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of the object.

◆ FrStatData() [10/10]

FrameCPP::Version_8::FrStatData::FrStatData ( istream_type Stream)
private

Stream Constructor.

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

Member Function Documentation

◆ AddressOfDetector() [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
detector_type * FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::AddressOfDetector ( ) const
inlineinherited

◆ AddressOfDetector() [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
detector_type * FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::AddressOfDetector ( ) const
inlineinherited

◆ Bytes() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

FrStatData * FrameCPP::Version_8::FrStatData::Clone ( ) const
virtual

Virtual constructor.

Returns
A new instance of FrameH based on Obj
Deprecated:
Do not make this call as it will be gone by version 1.14.0.

◆ Clone() [2/2]

virtual FrStatData * FrameCPP::Version_8::FrStatData::Clone ( ) const
virtual

Virtual constructor.

Returns
A new instance of FrameH based on Obj
Deprecated:
Do not make this call as it will be gone by version 1.14.0.

◆ Create() [1/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream &  Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ DataType() [1/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [2/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited

◆ DataType() [3/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ DataType() [4/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited

◆ demote() [1/2]

FrStatData::demote_ret_type FrameCPP::Version_8::FrStatData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_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.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrStatData::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_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.

◆ GetDetector() [1/3]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
detector_type FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::GetDetector ( )
inlineinherited

◆ GetDetector() [2/3]

virtual fr_detector_type FrameCPP::Version_8::FrStatData::GetDetector ( ) const
inlinevirtual

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetDetector() [3/3]

virtual fr_detector_type FrameCPP::Version_8::FrStatData::GetDetector ( ) const
inlinevirtual

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ Merge() [1/2]

FrStatData & FrameCPP::Version_8::FrStatData::Merge ( const FrStatData RHS)

Merge with another FrAdcData.

Parameters
[in]RHSThe source of the information to append to this FrAdcData structure.
Returns
A reference to this object
Todo:
Need to implement Merge routine

◆ Merge() [2/2]

FrStatData & FrameCPP::Version_8::FrStatData::Merge ( const FrStatData RHS)

Merge with another FrAdcData.

Parameters
[in]RHSThe source of the information to append to this FrAdcData structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrStatData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrStatData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ operator==() [1/5]

bool FrameCPP::Version_8::FrStatData::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/5]

virtual bool FrameCPP::Version_8::FrStatData::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/5]

bool FrameCPP::Version_8::FrStatData::operator== ( const FrStatData RHS) const
inline

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/5]

bool FrameCPP::Version_8::FrStatData::operator== ( const FrStatData RHS) const

equality operator

Parameters
[in]RHSThe FrAdcData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [5/5]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
bool FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::operator== ( const FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable > &  RHS) const
inlineinherited

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrStatData::pBytes ( const Common::StreamBase Stream) const
protectedvirtual

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::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrStatData::pBytes ( const Common::StreamBase Stream) const
protectedvirtual

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::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [1/2]

FrStatData * FrameCPP::Version_8::FrStatData::pCreate ( istream_type Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pCreate() [2/2]

virtual FrStatData * FrameCPP::Version_8::FrStatData::pCreate ( istream_type Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ Promote() [1/2]

FrStatData::promote_ret_type FrameCPP::Version_8::FrStatData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_8::FrStatData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

FrStatData::promote_ret_type FrameCPP::Version_8::FrStatData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_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.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrStatData::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_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.

◆ pWrite() [1/2]

void FrameCPP::Version_8::FrStatData::pWrite ( ostream_type Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrStatData::pWrite ( ostream_type Stream) const
protectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.

◆ RefData() [1/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
data_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefData ( )
inlineinherited

◆ RefData() [2/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
data_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefData ( )
inlineinherited

◆ RefData() [3/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
const data_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefData ( ) const
inlineinherited

◆ RefData() [4/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
const data_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefData ( ) const
inlineinherited

◆ RefTable() [1/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
table_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefTable ( )
inlineinherited

◆ RefTable() [2/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
table_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefTable ( )
inlineinherited

◆ RefTable() [3/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
const table_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefTable ( ) const
inlineinherited

◆ RefTable() [4/4]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
const table_type & FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::RefTable ( ) const
inlineinherited

◆ SetDetector() [1/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
void FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::SetDetector ( detector_type  Detector)
inlineinherited

◆ SetDetector() [2/2]

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
void FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::SetDetector ( detector_type  Detector)
inlineinherited

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_8::FrStatData::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrStatData::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrStatData::StructName ( )
inlinestatic

The name structure name of this object.

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

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrStatData::StructName ( )
static

The name structure name of this object.

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

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inherited

◆ vTOCQuery() [1/2]

void FrameCPP::Version_8::FrStatData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_8::FrStatData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_refs

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
ref_type FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::m_refs
protectedinherited

◆ MAX_REF

template<typename TPTR_STRUCT , typename TDetector , typename TVect , typename TTable >
static const INT_2U FrameCPP::Version_4::FrStatDataPST< TPTR_STRUCT, TDetector, TVect, TTable >::MAX_REF = 3
staticinherited

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