ldas-tools-framecpp  2.8.1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static 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 Common::FrStatData::fr_detector_type fr_detector_type
 
typedef Common::FrStatData::fr_detector_type fr_detector_type
 
typedef Common::FrStatData::fr_detector_type fr_detector_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string comment_type
 
typedef std::string comment_type
 
typedef std::string comment_type
 
typedef std::string representation_type
 
typedef std::string representation_type
 
typedef std::string representation_type
 
typedef INT_4U timeStart_type
 
typedef INT_4U timeStart_type
 
typedef INT_4U timeStart_type
 
typedef INT_4U timeEnd_type
 
typedef INT_4U timeEnd_type
 
typedef INT_4U timeEnd_type
 
typedef INT_4U version_type
 
typedef INT_4U version_type
 
typedef INT_4U version_type
 
typedef boost::shared_ptr< FrDetectordetector_type
 
typedef boost::shared_ptr< FrDetectordetector_type
 
typedef boost::shared_ptr< FrDetectordetector_type
 
typedef boost::shared_ptr< FrDetector > const const_detector_type
 
typedef boost::shared_ptr< FrDetector > const const_detector_type
 
typedef boost::shared_ptr< FrDetector > const const_detector_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamedata_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamedata_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamedata_type
 
typedef data_type::iterator iterator
 
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 data_type::const_iterator const_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlowtable_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlowtable_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlowtable_type
 
typedef table_type::iterator table_iterator
 
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
 
typedef table_type::const_iterator const_table_iterator
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
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
}
 
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
 
typedef STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 

Public Member Functions

 FrStatData ()=default
 Default constructor. More...
 
 FrStatData (const FrStatData &Source)
 Copy Constructor. More...
 
 FrStatData (const name_type &Name, const comment_type &Comment, const representation_type &Representation, timeStart_type TimeStart, timeEnd_type TimeEnd, version_type Version)
 Constructor. More...
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData. More...
 
bool operator== (const FrStatData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
 FrStatData ()=default
 Default constructor. More...
 
 FrStatData (const FrStatData &Source)
 Copy Constructor. More...
 
 FrStatData (const name_type &Name, const comment_type &Comment, const representation_type &Representation, timeStart_type TimeStart, timeEnd_type TimeEnd, version_type Version)
 Constructor. More...
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData. More...
 
bool operator== (const FrStatData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
 FrStatData ()=default
 Default constructor. More...
 
 FrStatData (const FrStatData &Source)
 Copy Constructor. More...
 
 FrStatData (const name_type &Name, const comment_type &Comment, const representation_type &Representation, timeStart_type TimeStart, timeEnd_type TimeEnd, version_type Version)
 Constructor. More...
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData. More...
 
bool operator== (const FrStatData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
Common::FrameSpec::ObjectClone () const
 
Common::FrameSpec::ObjectClone () const
 
Common::FrameSpec::ObjectClone () const
 
virtual Common::FrStatData::fr_detector_type GetDetector () const
 Retrieve the detector associated with the object. More...
 
virtual Common::FrStatData::fr_detector_type GetDetector () const
 Retrieve the detector associated with the object. More...
 
virtual Common::FrStatData::fr_detector_type GetDetector () const
 Retrieve the detector associated with the object. More...
 
detector_type GetDetector ()
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetName () const
 Retrieve static data name. More...
 
const std::string & GetName () const
 Retrieve static data name. More...
 
const std::string & GetName () const
 Retrieve static data name. More...
 
const std::string & GetComment () const
 Retrieve the comment. More...
 
const std::string & GetComment () const
 Retrieve the comment. More...
 
const std::string & GetComment () const
 Retrieve the comment. More...
 
const std::string & GetRepresentation () const
 Retrieve the type of static data. More...
 
const std::string & GetRepresentation () const
 Retrieve the type of static data. More...
 
const std::string & GetRepresentation () const
 Retrieve the type of static data. More...
 
timeStart_type GetTimeStart () const
 Retrieve the start time. More...
 
timeStart_type GetTimeStart () const
 Retrieve the start time. More...
 
timeStart_type GetTimeStart () const
 Retrieve the start time. More...
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time. More...
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time. More...
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time. More...
 
version_type GetVersion () const
 Retrieve the version number. More...
 
version_type GetVersion () const
 Retrieve the version number. More...
 
version_type GetVersion () const
 Retrieve the version number. More...
 
const data_typeRefData () const
 
data_typeRefData ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
detector_typeAddressOfDetector () const
 
detector_typeAddressOfDetector () const
 
detector_typeAddressOfDetector () const
 
void SetDetector (detector_type Detector)
 
void SetDetector (detector_type Detector)
 
void SetDetector (detector_type Detector)
 
bool operator== (const Data &RHS) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 

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. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
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)
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE. More...
 

Static Public Attributes

static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Member Functions

virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

name_type name
 Static data name. More...
 
comment_type comment
 Comment for static data. More...
 
representation_type representation
 
timeStart_type timeStart
 
timeEnd_type timeEnd
 
version_type version
 
detector_type detector
 
data_type data
 
table_type table
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 3 }
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_comment_type
 
typedef STRING io_comment_type
 
typedef STRING io_representation_type
 
typedef STRING io_representation_type
 
typedef STRING io_representation_type
 
typedef Common::FrameSpec::ObjectWithChecksum< base_object_type, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< base_object_type, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< base_object_type, checksum_typeobject_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum. More...
 

Detailed Description

Static Data Structure Definition.

Member Typedef Documentation

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ const_detector_type [1/3]

typedef boost::shared_ptr< FrDetector > const FrameCPP::Version_8::FrStatDataImpl::Data::const_detector_type
inherited

◆ const_detector_type [2/3]

typedef boost::shared_ptr< FrDetector > const FrameCPP::Version_8::FrStatDataImpl::Data::const_detector_type
inherited

◆ const_detector_type [3/3]

typedef boost::shared_ptr< FrDetector > const FrameCPP::Version_8::FrStatDataImpl::Data::const_detector_type
inherited

◆ const_iterator [1/3]

◆ const_iterator [2/3]

◆ const_iterator [3/3]

◆ const_table_iterator [1/3]

◆ const_table_iterator [2/3]

◆ const_table_iterator [3/3]

◆ data_type [1/3]

◆ data_type [2/3]

◆ data_type [3/3]

◆ detector_type [1/3]

◆ detector_type [2/3]

◆ detector_type [3/3]

◆ fr_detector_type [1/3]

typedef Common::FrStatData::fr_detector_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::fr_detector_type
inherited

◆ fr_detector_type [2/3]

typedef Common::FrStatData::fr_detector_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::fr_detector_type
inherited

◆ fr_detector_type [3/3]

typedef Common::FrStatData::fr_detector_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::fr_detector_type
inherited

◆ io_comment_type [1/3]

◆ io_comment_type [2/3]

◆ io_comment_type [3/3]

◆ io_name_type [1/3]

◆ io_name_type [2/3]

◆ io_name_type [3/3]

◆ io_representation_type [1/3]

◆ io_representation_type [2/3]

◆ io_representation_type [3/3]

◆ istream_type [1/3]

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

◆ istream_type [2/3]

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

◆ istream_type [3/3]

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

◆ iterator [1/3]

◆ iterator [2/3]

◆ iterator [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ object_base_type [1/3]

typedef Common::FrameSpec::ObjectWithChecksum< base_object_type , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< base_object_type >::object_base_type
privateinherited

◆ object_base_type [2/3]

typedef Common::FrameSpec::ObjectWithChecksum< base_object_type , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< base_object_type >::object_base_type
privateinherited

◆ object_base_type [3/3]

typedef Common::FrameSpec::ObjectWithChecksum< base_object_type , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< base_object_type >::object_base_type
privateinherited

◆ ostream_type [1/3]

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

◆ ostream_type [2/3]

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

◆ ostream_type [3/3]

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

◆ representation_type [1/3]

◆ representation_type [2/3]

◆ representation_type [3/3]

◆ self_type [1/3]

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

◆ self_type [2/3]

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

◆ self_type [3/3]

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

◆ string_2_type [1/3]

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

◆ string_2_type [2/3]

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

◆ string_2_type [3/3]

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

◆ struct_desc_type [1/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type
inherited

◆ struct_desc_type [2/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type
inherited

◆ struct_desc_type [3/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type
inherited

◆ struct_id_type [1/3]

typedef INT_2U const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id_type
inherited

◆ struct_id_type [2/3]

typedef INT_2U const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id_type
inherited

◆ struct_id_type [3/3]

typedef INT_2U const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id_type
inherited

◆ struct_name_type [1/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type
inherited

◆ struct_name_type [2/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type
inherited

◆ struct_name_type [3/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type
inherited

◆ table_iterator [1/3]

◆ table_iterator [2/3]

◆ table_iterator [3/3]

◆ table_type [1/3]

◆ table_type [2/3]

◆ table_type [3/3]

◆ timeEnd_type [1/3]

◆ timeEnd_type [2/3]

◆ timeEnd_type [3/3]

◆ timeStart_type [1/3]

◆ timeStart_type [2/3]

◆ timeStart_type [3/3]

◆ version_type [1/3]

◆ version_type [2/3]

◆ version_type [3/3]

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 

◆ 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/12]

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

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [2/12]

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

FrameCPP::Version_8::FrStatData::FrStatData ( const name_type Name,
const comment_type Comment,
const representation_type Representation,
timeStart_type  TimeStart,
timeEnd_type  TimeEnd,
version_type  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/12]

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

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

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [6/12]

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

FrameCPP::Version_8::FrStatData::FrStatData ( const name_type Name,
const comment_type Comment,
const representation_type Representation,
timeStart_type  TimeStart,
timeEnd_type  TimeEnd,
version_type  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() [8/12]

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

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

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [10/12]

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

FrameCPP::Version_8::FrStatData::FrStatData ( const name_type Name,
const comment_type Comment,
const representation_type Representation,
timeStart_type  TimeStart,
timeEnd_type  TimeEnd,
version_type  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() [12/12]

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.

Member Function Documentation

◆ AddressOfDetector() [1/3]

detector_type* FrameCPP::Version_8::FrStatDataImpl::Data::AddressOfDetector ( ) const
inlineinherited

◆ AddressOfDetector() [2/3]

detector_type* FrameCPP::Version_8::FrStatDataImpl::Data::AddressOfDetector ( ) const
inlineinherited

◆ AddressOfDetector() [3/3]

detector_type* FrameCPP::Version_8::FrStatDataImpl::Data::AddressOfDetector ( ) const
inlineinherited

◆ Bytes() [1/3]

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

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

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

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/3]

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

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

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/3]

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

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

◆ Clone() [2/3]

◆ Clone() [3/3]

◆ Create() [1/9]

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

◆ Create() [2/9]

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

◆ Create() [3/9]

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

◆ Create() [4/9]

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

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

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

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

constructor - virtual

◆ Create() [8/9]

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

constructor - virtual

◆ Create() [9/9]

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

constructor - virtual

◆ DataType() [1/6]

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

◆ DataType() [2/6]

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

◆ DataType() [3/6]

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

◆ DataType() [4/6]

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

◆ DataType() [5/6]

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

◆ DataType() [6/6]

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

◆ demote() [1/3]

virtual demote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtualinherited

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

virtual demote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtualinherited

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

virtual demote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtualinherited

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.

◆ FrameSpecDescription() [1/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [3/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [3/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [3/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )
inlinestaticinherited

◆ GetComment() [1/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetComment() [2/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetComment() [3/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetDetector() [1/4]

detector_type FrameCPP::Version_8::FrStatDataImpl::Data::GetDetector ( )
inlineinherited

◆ GetDetector() [2/4]

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetDetector() [3/4]

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetDetector() [4/4]

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetName() [1/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetName() [2/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetName() [3/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetRepresentation() [1/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetRepresentation() [2/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetRepresentation() [3/3]

const std::string& FrameCPP::Version_8::FrStatDataImpl::Data::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetTimeEnd() [1/3]

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeEnd() [2/3]

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeEnd() [3/3]

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeStart() [1/3]

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetTimeStart() [2/3]

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetTimeStart() [3/3]

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetVersion() [1/3]

version_type FrameCPP::Version_8::FrStatDataImpl::Data::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ GetVersion() [2/3]

version_type FrameCPP::Version_8::FrStatDataImpl::Data::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ GetVersion() [3/3]

version_type FrameCPP::Version_8::FrStatDataImpl::Data::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ Merge() [1/3]

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

◆ Merge() [2/3]

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

◆ Merge() [3/3]

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

virtual const char* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/3]

virtual const char* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [3/3]

virtual const char* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/7]

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

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

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

bool FrameCPP::Version_8::FrStatDataImpl::Data::operator== ( const Data RHS) const
inlineinherited

◆ operator==() [5/7]

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

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

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.

◆ pBytes() [1/3]

virtual cmn_streamsize_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtualinherited

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

virtual cmn_streamsize_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtualinherited

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

virtual cmn_streamsize_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtualinherited

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

virtual self_type* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pCreate ( istream_type Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ pCreate() [2/3]

virtual self_type* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pCreate ( istream_type Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ pCreate() [3/3]

virtual self_type* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pCreate ( istream_type Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

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

◆ Promote() [1/3]

static promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestaticinherited

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

static promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestaticinherited

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

static promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestaticinherited

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

virtual promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtualinherited

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

virtual promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtualinherited

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

virtual promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

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

data_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefData ( )
inlineinherited

◆ RefData() [2/6]

data_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefData ( )
inlineinherited

◆ RefData() [3/6]

data_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefData ( )
inlineinherited

◆ RefData() [4/6]

const data_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefData ( ) const
inlineinherited

◆ RefData() [5/6]

const data_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefData ( ) const
inlineinherited

◆ RefData() [6/6]

const data_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefData ( ) const
inlineinherited

◆ RefTable() [1/6]

table_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [2/6]

table_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [3/6]

table_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [4/6]

const table_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefTable ( ) const
inlineinherited

◆ RefTable() [5/6]

const table_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefTable ( ) const
inlineinherited

◆ RefTable() [6/6]

const table_type& FrameCPP::Version_8::FrStatDataImpl::Data::RefTable ( ) const
inlineinherited

◆ SetDetector() [1/3]

void FrameCPP::Version_8::FrStatDataImpl::Data::SetDetector ( detector_type  Detector)
inlineinherited

◆ SetDetector() [2/3]

void FrameCPP::Version_8::FrStatDataImpl::Data::SetDetector ( detector_type  Detector)
inlineinherited

◆ SetDetector() [3/3]

void FrameCPP::Version_8::FrStatDataImpl::Data::SetDetector ( detector_type  Detector)
inlineinherited

◆ StructDescription() [1/3]

static const Common::Description* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/3]

static const Common::Description* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [3/3]

static const Common::Description* FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName() [1/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )
inlinestaticinherited

◆ StructName() [2/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )
inlinestaticinherited

◆ StructName() [3/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )
inlinestaticinherited

◆ TOCQuery() [1/3]

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

◆ TOCQuery() [2/3]

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

◆ TOCQuery() [3/3]

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

◆ vTOCQuery() [1/3]

virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< FrStatData >::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
inlineprotectedvirtualinherited

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

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

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

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

◆ comment

comment_type FrameCPP::Version_8::FrStatDataImpl::Data::comment
protectedinherited

Comment for static data.

◆ data

data_type FrameCPP::Version_8::FrStatDataImpl::Data::data
protectedinherited

◆ detector

detector_type FrameCPP::Version_8::FrStatDataImpl::Data::detector
protectedinherited

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

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_8::FrStatDataImpl::Data::MAX_REF { 3 }
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_8::FrStatDataImpl::Data::name
protectedinherited

Static data name.

◆ representation

representation_type FrameCPP::Version_8::FrStatDataImpl::Data::representation
protectedinherited

Type of static data being represented. e,g., calibration, swept sine, pole-zero, FIR or IIR coefficients...

◆ struct_desc

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc
staticinherited

◆ struct_id

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id
staticinherited

◆ struct_name

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name
staticinherited

◆ table

table_type FrameCPP::Version_8::FrStatDataImpl::Data::table
protectedinherited

◆ timeEnd

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::timeEnd
protectedinherited

End time of static data validity. A value of zero represents the end time being unknown. GPS time in integer seconds since GPS standard epoch.

◆ timeStart

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::timeStart
protectedinherited

Start time of static data validity. GPS time in integer seconds since GPS standard epoch.

◆ version

version_type FrameCPP::Version_8::FrStatDataImpl::Data::version
protectedinherited

Version number for this static structure. i.e., the counter begins at 0 and is incremented by 1 thereafter. Updated statics for the same time window (e.g., modified calibration data) will be identified by identified by unique version numbers.


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