ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::Version_4::FrStatData Class Reference

#include <FrStatData.hh>

Inheritance diagram for FrameCPP::Version_4::FrStatData:
Collaboration diagram for FrameCPP::Version_4::FrStatData:

Public Types

typedef FrStatDataNPS nps_type
 
typedef FrStatDataPS ps_type
 
typedef FrStatDataNPS nps_type
 
typedef FrStatDataPS ps_type
 
typedef Query::fr_detector_type fr_detector_type
 
typedef Query::fr_detector_type fr_detector_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
typedef stream_base_type promote_stream_type
 
typedef INT_4U timeStart_type
 
typedef INT_4U timeStart_type
 
typedef INT_4U timeEnd_type
 
typedef INT_4U timeEnd_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::GetName > data_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > data_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > data_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::GetNameSlow > table_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_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
 
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 &statData)
 
 FrStatData (const std::string &name, const std::string &comment, const std::string &representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version)
 
 FrStatData (const Previous::FrStatData &Source, stream_base_type *Stream)
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrStatDataClone () const
 constructor - virtual copy constructor
 
virtual FrStatDataCreate (istream_type &Stream) const
 constructor - virtual
 
virtual fr_detector_type GetDetector () const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData.
 
bool operator== (const FrStatData &RHS) const
 Comparison operator.
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 Comparison operator.
 
 FrStatData ()
 Default constructor.
 
 FrStatData (const FrStatData &statData)
 
 FrStatData (const std::string &name, const std::string &comment, const std::string &representation, INT_4U timeStart, INT_4U timeEnd, INT_4U version)
 
 FrStatData (const Previous::FrStatData &Source, stream_base_type *Stream)
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrStatDataClone () const
 constructor - virtual copy constructor
 
virtual FrStatDataCreate (istream_type &Stream) const
 constructor - virtual
 
virtual fr_detector_type GetDetector () const
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData.
 
bool operator== (const FrStatData &RHS) const
 Comparison operator.
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 Comparison operator.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
const std::string & GetName () const
 Retrieve static data name.
 
const std::string & GetName () const
 Retrieve static data name.
 
const std::string & GetComment () const
 Retrieve the comment.
 
const std::string & GetComment () const
 Retrieve the comment.
 
const std::string & GetRepresentation () const
 Retrieve the type of static data.
 
const std::string & GetRepresentation () const
 Retrieve the type of static data.
 
timeStart_type GetTimeStart () const
 Retrieve the start time.
 
timeStart_type GetTimeStart () const
 Retrieve the start time.
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time.
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time.
 
version_type GetVersion () const
 Retrieve the version number.
 
version_type GetVersion () const
 Retrieve the version number.
 
bool operator== (const FrStatDataNPS &RHS) const
 Comparison operator.
 
detector_type GetDetector ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
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 ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
detector_typeAddressOfDetector () const
 
detector_typeAddressOfDetector () const
 
detector_typeAddressOfDetector () const
 
detector_typeAddressOfDetector () const
 
void SetDetector (detector_type Detector)
 
void SetDetector (detector_type Detector)
 
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, promote_stream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType, typename CurrentType>
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType, typename CurrentType>
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
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_4U ALL_VERSIONS = 0xFFFFFFFF
 
static const INT_4U LATEST_VERSION = 0xFFFFFFFE
 
static const FrameSpec::Info::frame_object_types STRUCT_ID
 
static const INT_2U MAX_REF
 
static const INT_2U MAX_REF
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Protected Attributes

storage_type m_data
 
ref_type m_refs
 
ref_type m_refs
 

Private Member Functions

 FrStatData (istream_type &Stream)
 
 FrStatData (istream_type &Stream)
 

Private Attributes

const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Member Typedef Documentation

◆ const_detector_type [1/3]

typedef boost::shared_ptr< FrDetector > const FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::const_detector_type
inherited

◆ const_detector_type [2/3]

typedef boost::shared_ptr< FrDetector > const FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::const_detector_type
inherited

◆ const_detector_type [3/3]

typedef boost::shared_ptr< FrDetector > const FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::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]

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ demote_stream_type [1/2]

◆ demote_stream_type [2/2]

◆ detector_type [1/3]

◆ detector_type [2/3]

◆ detector_type [3/3]

◆ fr_detector_type [1/2]

typedef Query::fr_detector_type FrameCPP::Common::FrStatData::fr_detector_type
inherited

◆ fr_detector_type [2/2]

typedef Query::fr_detector_type FrameCPP::Common::FrStatData::fr_detector_type
inherited

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ iterator [1/3]

◆ iterator [2/3]

◆ iterator [3/3]

◆ nps_type [1/2]

◆ nps_type [2/2]

◆ object_type [1/2]

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

◆ object_type [2/2]

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

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ promote_stream_type [1/2]

◆ promote_stream_type [2/2]

◆ ps_type [1/2]

◆ ps_type [2/2]

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

◆ table_iterator [2/3]

◆ table_iterator [3/3]

◆ table_type [1/3]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::table_type
inherited

◆ table_type [2/3]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::table_type
inherited

◆ table_type [3/3]

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::table_type
inherited

◆ timeEnd_type [1/2]

◆ timeEnd_type [2/2]

◆ timeStart_type [1/2]

◆ timeStart_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

◆ version_type [1/2]

◆ version_type [2/2]

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_4::FrStatData::FrStatData ( )

Default constructor.

◆ FrStatData() [2/10]

FrameCPP::Version_4::FrStatData::FrStatData ( const FrStatData & statData)

◆ FrStatData() [3/10]

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

◆ FrStatData() [4/10]

FrameCPP::Version_4::FrStatData::FrStatData ( const Previous::FrStatData & Source,
stream_base_type * Stream )

◆ FrStatData() [5/10]

FrameCPP::Version_4::FrStatData::FrStatData ( istream_type & Stream)
private

◆ FrStatData() [6/10]

FrameCPP::Version_4::FrStatData::FrStatData ( )

Default constructor.

◆ FrStatData() [7/10]

FrameCPP::Version_4::FrStatData::FrStatData ( const FrStatData & statData)

◆ FrStatData() [8/10]

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

◆ FrStatData() [9/10]

FrameCPP::Version_4::FrStatData::FrStatData ( const Previous::FrStatData & Source,
stream_base_type * Stream )

◆ FrStatData() [10/10]

FrameCPP::Version_4::FrStatData::FrStatData ( istream_type & Stream)
private

Member Function Documentation

◆ AddressOfDetector() [1/4]

detector_type * FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::AddressOfDetector ( ) const
inlineinherited

◆ AddressOfDetector() [2/4]

detector_type * FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::AddressOfDetector ( ) const
inlineinherited

◆ AddressOfDetector() [3/4]

detector_type * FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::AddressOfDetector ( ) const
inlineinherited

◆ AddressOfDetector() [4/4]

detector_type * FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::AddressOfDetector ( ) const
inlineinherited

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_4::FrStatData::Bytes ( const Common::StreamBase & Stream) const
virtual

Number of bytes needed to write this structure.

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

◆ Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_4::FrStatData::Bytes ( const Common::StreamBase & Stream) const
virtual

Number of bytes needed to write this structure.

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

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Clone() [2/2]

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

constructor - virtual copy constructor

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [1/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, and FrVect.

◆ Create() [2/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream & Buffer) const
virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

◆ Create() [3/4]

FrStatData * FrameCPP::Version_4::FrStatData::Create ( istream_type & Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

virtual FrStatData * FrameCPP::Version_4::FrStatData::Create ( istream_type & Stream) const
virtual

constructor - virtual

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

◆ 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_4::FrStatData::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_4::FrStatData::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
protectedvirtual

Down grade an object.

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

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ FrameSpecVersion() [1/2]

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

◆ FrameSpecVersion() [2/2]

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

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetComment() [1/2]

const std::string & FrStatDataNPS::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetComment() [2/2]

const std::string & FrameCPP::Version_4::FrStatDataNPS::GetComment ( ) const
inherited

Retrieve the comment.

Returns
The comment

◆ GetDescription() [1/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [2/4]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [3/4]

◆ GetDescription() [4/4]

◆ GetDetector() [1/3]

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

◆ GetDetector() [2/3]

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

◆ GetDetector() [3/3]

◆ GetName() [1/2]

const std::string & FrStatDataNPS::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetName() [2/2]

const std::string & FrameCPP::Version_4::FrStatDataNPS::GetName ( ) const
inherited

Retrieve static data name.

Returns
The static data name

◆ GetRepresentation() [1/2]

const std::string & FrStatDataNPS::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetRepresentation() [2/2]

const std::string & FrameCPP::Version_4::FrStatDataNPS::GetRepresentation ( ) const
inherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetTimeEnd() [1/2]

FrStatDataNPS::timeEnd_type FrStatDataNPS::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeEnd() [2/2]

timeEnd_type FrameCPP::Version_4::FrStatDataNPS::GetTimeEnd ( ) const
inherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeStart() [1/2]

FrStatDataNPS::timeStart_type FrStatDataNPS::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetTimeStart() [2/2]

timeStart_type FrameCPP::Version_4::FrStatDataNPS::GetTimeStart ( ) const
inherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetVersion() [1/2]

FrStatDataNPS::version_type FrStatDataNPS::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ GetVersion() [2/2]

version_type FrameCPP::Version_4::FrStatDataNPS::GetVersion ( ) const
inherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ Merge() [1/2]

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

Merge with another FrAdcData.

Todo
Need to implement Merge routine

◆ Merge() [2/2]

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

Merge with another FrAdcData.

◆ ObjectStructName() [1/2]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

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

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/6]

bool FrameCPP::Version_4::FrStatData::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

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

◆ operator==() [2/6]

virtual bool FrameCPP::Version_4::FrStatData::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

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

◆ operator==() [3/6]

bool FrameCPP::Version_4::FrStatData::operator== ( const FrStatData & RHS) const
inline

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

◆ operator==() [4/6]

bool FrameCPP::Version_4::FrStatData::operator== ( const FrStatData & RHS) const

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

◆ operator==() [5/6]

bool FrStatDataNPS::operator== ( const FrStatDataNPS & RHS) const
inlineinherited

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

◆ operator==() [6/6]

◆ Promote() [1/2]

FrStatData::promote_ret_type FrameCPP::Version_4::FrStatData::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestatic

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_4::FrStatData::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

◆ promote() [1/2]

FrStatData::promote_ret_type FrameCPP::Version_4::FrStatData::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_4::FrStatData::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
protectedvirtual

Upgrade an object.

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

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/5]

template<typename PreviousType, typename CurrentType>
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/5]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/5]

template<typename PreviousType, typename CurrentType>
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/5]

template<typename PreviousType, typename CurrentType>
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target,
FrameSpec::ObjectInterface::frame_spec_version_type Source,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream )
inherited

◆ RefData() [1/8]

◆ RefData() [2/8]

◆ RefData() [3/8]

◆ RefData() [4/8]

◆ RefData() [5/8]

const data_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefData ( ) const
inlineinherited

◆ RefData() [6/8]

const data_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefData ( ) const
inlineinherited

◆ RefData() [7/8]

const data_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefData ( ) const
inlineinherited

◆ RefData() [8/8]

const data_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefData ( ) const
inlineinherited

◆ RefTable() [1/8]

◆ RefTable() [2/8]

◆ RefTable() [3/8]

◆ RefTable() [4/8]

◆ RefTable() [5/8]

const table_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefTable ( ) const
inlineinherited

◆ RefTable() [6/8]

const table_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefTable ( ) const
inlineinherited

◆ RefTable() [7/8]

const table_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefTable ( ) const
inlineinherited

◆ RefTable() [8/8]

const table_type & FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::RefTable ( ) const
inlineinherited

◆ SetDetector() [1/4]

void FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::SetDetector ( detector_type Detector)
inlineinherited

◆ SetDetector() [2/4]

void FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::SetDetector ( detector_type Detector)
inlineinherited

◆ SetDetector() [3/4]

void FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::SetDetector ( detector_type Detector)
inlineinherited

◆ SetDetector() [4/4]

void FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::SetDetector ( detector_type Detector)
inlineinherited

◆ StructDescription() [1/2]

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

◆ StructDescription() [2/2]

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

◆ StructName() [1/2]

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

◆ StructName() [2/2]

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

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ VerifyObject() [1/2]

◆ VerifyObject() [2/2]

◆ vTOCQuery() [1/2]

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

◆ vTOCQuery() [2/2]

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

◆ Write() [1/2]

void FrameCPP::Version_4::FrStatData::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ Write() [2/2]

virtual void FrameCPP::Version_4::FrStatData::Write ( ostream_type & Stream) const
virtual

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

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

◆ WriteNext() [1/2]

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

Write a next pointer to the parent to the stream.

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

◆ WriteNext() [2/2]

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

◆ ALL_VERSIONS

static const INT_4U FrameCPP::Version_4::FrStatData::ALL_VERSIONS = 0xFFFFFFFF
static

◆ frame_spec_version

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

Version of the frame specification.

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

◆ LATEST_VERSION

static const INT_4U FrameCPP::Version_4::FrStatData::LATEST_VERSION = 0xFFFFFFFE
static

◆ m_class

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

Storage for the class identifier.

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

◆ m_data

storage_type FrStatDataNPS::m_data
protectedinherited

◆ m_desc

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

Description for parent class.

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

◆ m_refs [1/2]

ref_type FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::m_refs
protectedinherited

◆ m_refs [2/2]

ref_type FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::m_refs
protectedinherited

◆ MAX_REF [1/2]

const INT_2U FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::MAX_REF
staticinherited

◆ MAX_REF [2/2]

static const INT_2U FrameCPP::Version_4::FrStatDataPST< PTR_STRUCT, FrDetector, FrVect, FrTable >::MAX_REF
staticinherited

◆ STRUCT_ID

static const FrameSpec::Info::frame_object_types FrameCPP::Common::FrStatData::STRUCT_ID
staticinherited
Initial value:

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