ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrEventImpl::ClassicIO< T > Class Template Referenceabstract

#include <FrEventClassicIO.hh>

Inheritance diagram for FrameCPP::Version_9::FrEventImpl::ClassicIO< T >:
Collaboration diagram for FrameCPP::Version_9::FrEventImpl::ClassicIO< T >:

Public Types

typedef FR_EVENT_N_PARAM_TYPE nParam_type
 
typedef FR_EVENT_PARAM_NAME_TYPE paramName_type
 
typedef FR_EVENT_PARAM_VALUE_TYPE paramValue_type
 
typedef std::pair< paramName_type, paramValue_typeParam_type
 
typedef std::vector< Param_typeParamList_type
 
typedef std::string name_type
 
typedef std::string comment_type
 
typedef std::string inputs_type
 
typedef LDASTools::AL::GPSTime GTime_type
 
typedef FR_EVENT_TIME_BEFORE_TYPE timeBefore_type
 
typedef FR_EVENT_TIME_AFTER_TYPE timeAfter_type
 
typedef FR_EVENT_EVENT_STATUS_TYPE eventStatus_type
 
typedef FR_EVENT_AMPLITUDE_TYPE amplitude_type
 
typedef FR_EVENT_PROBABILITY_TYPE probability_type
 
typedef std::string statistics_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetName > data_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef REAL_4 paramValue_v5_type
 
typedef std::pair< paramName_type, paramValue_v5_typeParam_v5_type
 
typedef std::vector< Param_v5_typeParamList_v5_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
}
 
typedef STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > self_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 

Public Member Functions

 ClassicIO ()
 
 ClassicIO (const Previous::FrEvent &Source, stream_base_type *Stream)
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
 ClassicIO ()
 
 ClassicIO (const Previous::FrEvent &Source, stream_base_type *Stream)
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::DescriptionGetDescription (ostream_type &Stream) const
 The data structure description.
 
name_type const & GetName () const
 
name_type const & GetName () const
 
comment_type const & GetComment () const
 
comment_type const & GetComment () const
 
inputs_type const & GetInputs () const
 
inputs_type const & GetInputs () const
 
GTime_type const & GetGTime () const
 
GTime_type const & GetGTime () const
 
timeBefore_type GetTimeBefore () const
 
timeBefore_type GetTimeBefore () const
 
timeAfter_type GetTimeAfter () const
 
timeAfter_type GetTimeAfter () const
 
eventStatus_type GetEventStatus () const
 
eventStatus_type GetEventStatus () const
 
amplitude_type GetAmplitude () const
 
amplitude_type GetAmplitude () const
 
probability_type GetProbability () const
 
probability_type GetProbability () const
 
statistics_type const & GetStatistics () const
 
statistics_type const & GetStatistics () const
 
ParamList_type const & GetParam () const
 
ParamList_typeGetParam ()
 
ParamList_type const & GetParam () const
 
ParamList_typeGetParam ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
bool operator== (Data const &RHS) const
 
bool operator== (Data const &RHS) 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.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
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.
 
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 bool operator== (const Object &Obj) const =0
 comparison operator
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 

Static Public Member Functions

static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static constexpr unsigned int GetMaxRef ()
 
static constexpr unsigned int GetMaxRef ()
 
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.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
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.
 

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

Protected Attributes

name_type name
 Name of event.
 
comment_type comment
 Descriptor of event.
 
inputs_type inputs
 Input channels and filter parameters to event process.
 
GTime_type GTime
 
timeBefore_type timeBefore
 Signal duration before (GTimeS.GTimeN)(seconds)
 
timeAfter_type timeAfter
 Signal duration after (GTimeS.GTimeN)(seconds)
 
eventStatus_type eventStatus
 Defined by event search algorithm.
 
amplitude_type amplitude
 Continuous output amplitude returned by event.
 
probability_type probability
 
statistics_type statistics
 
ParamList_type Params
 Array of parameters.
 
data_type data
 Container of additional event results.
 
table_type table
 Table containing additional event information.
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 2 }
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_inputs_type
 
typedef STRING io_statistics_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > object_base_type
 

Private Member Functions

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

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 
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

◆ amplitude_type

◆ comment_type

◆ data_type

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ eventStatus_type

◆ frame_spec_version_type

◆ GTime_type

typedef LDASTools::AL::GPSTime FrameCPP::Version_9::FrEventImpl::Data::GTime_type
inherited

◆ inputs_type

◆ io_comment_type

template<typename T >
typedef STRING FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::io_comment_type
private

◆ io_inputs_type

template<typename T >
typedef STRING FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::io_inputs_type
private

◆ io_name_type

template<typename T >
typedef STRING FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::io_name_type
private

◆ io_statistics_type

template<typename T >
typedef STRING FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::io_statistics_type
private

◆ istream_type

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::istream_type
inherited

◆ name_type

◆ nParam_type

◆ object_base_type

◆ object_type

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

◆ ostream_type

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::ostream_type
inherited

◆ Param_type

◆ Param_v5_type

◆ ParamList_type

◆ ParamList_v5_type

◆ paramName_type

◆ paramValue_type

◆ paramValue_v5_type

◆ probability_type

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ self_type

◆ statistics_type

◆ string_2_type

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

◆ table_type

◆ timeAfter_type

◆ timeBefore_type

◆ unique_object_type

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

◆ ClassicIO() [1/4]

template<typename T >
FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [2/4]

template<typename T >
FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::ClassicIO ( const Previous::FrEvent & Source,
stream_base_type * Stream )
inline

◆ ClassicIO() [3/4]

template<typename T >
FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::ClassicIO ( )
inline

◆ ClassicIO() [4/4]

template<typename T >
FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::ClassicIO ( const Previous::FrEvent & Source,
stream_base_type * Stream )
inline

Member Function Documentation

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::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

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

◆ Bytes() [2/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::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

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

◆ CheckSumDataClass() [1/2]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Create() [1/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::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.

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

◆ Create() [4/6]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::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.

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

◆ Create() [5/6]

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

constructor - virtual

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

◆ Create() [6/6]

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

constructor - virtual

Reimplemented from 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]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

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

◆ demote() [2/2]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtual

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

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

◆ DemoteObject() [1/2]

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

Down grade an object.

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

◆ DemoteObject() [2/2]

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

Down grade an object.

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

◆ 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

◆ GetAmplitude() [1/2]

amplitude_type FrameCPP::Version_9::FrEventImpl::Data::GetAmplitude ( ) const
inlineinherited

◆ GetAmplitude() [2/2]

amplitude_type FrameCPP::Version_9::FrEventImpl::Data::GetAmplitude ( ) const
inlineinherited

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

comment_type const & FrameCPP::Version_9::FrEventImpl::Data::GetComment ( ) const
inlineinherited

◆ GetComment() [2/2]

comment_type const & FrameCPP::Version_9::FrEventImpl::Data::GetComment ( ) const
inlineinherited

◆ GetDescription() [1/3]

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

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream) const
inlinevirtual

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

◆ GetDescription() [3/3]

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream) const
inlinevirtual

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

Reimplemented from FrameCPP::Common::FrameSpec::Object.

◆ GetEventStatus() [1/2]

eventStatus_type FrameCPP::Version_9::FrEventImpl::Data::GetEventStatus ( ) const
inlineinherited

◆ GetEventStatus() [2/2]

eventStatus_type FrameCPP::Version_9::FrEventImpl::Data::GetEventStatus ( ) const
inlineinherited

◆ GetGTime() [1/2]

GTime_type const & FrameCPP::Version_9::FrEventImpl::Data::GetGTime ( ) const
inlineinherited

◆ GetGTime() [2/2]

GTime_type const & FrameCPP::Version_9::FrEventImpl::Data::GetGTime ( ) const
inlineinherited

◆ GetInputs() [1/2]

inputs_type const & FrameCPP::Version_9::FrEventImpl::Data::GetInputs ( ) const
inlineinherited

◆ GetInputs() [2/2]

inputs_type const & FrameCPP::Version_9::FrEventImpl::Data::GetInputs ( ) const
inlineinherited

◆ GetMaxRef() [1/2]

static constexpr unsigned int FrameCPP::Version_9::FrEventImpl::Data::GetMaxRef ( )
inlinestaticconstexprinherited

◆ GetMaxRef() [2/2]

static constexpr unsigned int FrameCPP::Version_9::FrEventImpl::Data::GetMaxRef ( )
inlinestaticconstexprinherited

◆ GetName() [1/2]

name_type const & FrameCPP::Version_9::FrEventImpl::Data::GetName ( ) const
inlineinherited

◆ GetName() [2/2]

name_type const & FrameCPP::Version_9::FrEventImpl::Data::GetName ( ) const
inlineinherited

◆ GetParam() [1/4]

ParamList_type & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( )
inlineinherited

◆ GetParam() [2/4]

ParamList_type & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( )
inlineinherited

◆ GetParam() [3/4]

ParamList_type const & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( ) const
inlineinherited

◆ GetParam() [4/4]

ParamList_type const & FrameCPP::Version_9::FrEventImpl::Data::GetParam ( ) const
inlineinherited

◆ GetProbability() [1/2]

probability_type FrameCPP::Version_9::FrEventImpl::Data::GetProbability ( ) const
inlineinherited

◆ GetProbability() [2/2]

probability_type FrameCPP::Version_9::FrEventImpl::Data::GetProbability ( ) const
inlineinherited

◆ GetStatistics() [1/2]

statistics_type const & FrameCPP::Version_9::FrEventImpl::Data::GetStatistics ( ) const
inlineinherited

◆ GetStatistics() [2/2]

statistics_type const & FrameCPP::Version_9::FrEventImpl::Data::GetStatistics ( ) const
inlineinherited

◆ GetTimeAfter() [1/2]

timeAfter_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeAfter ( ) const
inlineinherited

◆ GetTimeAfter() [2/2]

timeAfter_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeAfter ( ) const
inlineinherited

◆ GetTimeBefore() [1/2]

timeBefore_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeBefore ( ) const
inlineinherited

◆ GetTimeBefore() [2/2]

timeBefore_type FrameCPP::Version_9::FrEventImpl::Data::GetTimeBefore ( ) const
inlineinherited

◆ ObjectStructName() [1/2]

template<typename T >
virtual const char * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

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

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

◆ ObjectStructName() [2/2]

template<typename T >
virtual const char * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtual

The name structure name of this object.

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

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

◆ operator==() [1/3]

virtual bool FrameCPP::Common::FrameSpec::ObjectInterface::operator== ( const Object & Obj) const
pure virtualinherited

comparison operator

Implemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrAdcData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrDetector, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEndOfFrame, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrEvent, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_8::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_8::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_8::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_8::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_8::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_8::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrProcData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrAdcData, FrameCPP::Version_9::FrAdcData, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrDetector, FrameCPP::Version_9::FrDetector, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFrame, FrameCPP::Version_9::FrEndOfFrame, FrameCPP::Version_9::FrEvent, FrameCPP::Version_9::FrEvent, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcData, FrameCPP::Version_9::FrProcData, FrameCPP::Version_9::FrRawData, FrameCPP::Version_9::FrRawData, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSerData, FrameCPP::Version_9::FrSerData, FrameCPP::Version_9::FrSH, FrameCPP::Version_9::FrSH, FrameCPP::Version_9::FrSimData, FrameCPP::Version_9::FrSimData, FrameCPP::Version_9::FrSimEvent, FrameCPP::Version_9::FrSimEvent, FrameCPP::Version_9::FrSummary, FrameCPP::Version_9::FrSummary, FrameCPP::Version_9::FrTable, FrameCPP::Version_9::FrTable, FrameCPP::Version_9::FrTOC, FrameCPP::Version_9::FrTOC, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ operator==() [2/3]

bool FrameCPP::Version_9::FrEventImpl::Data::operator== ( Data const & RHS) const
inlineinherited

◆ operator==() [3/3]

bool FrameCPP::Version_9::FrEventImpl::Data::operator== ( Data const & RHS) const
inlineinherited

◆ pBytes() [1/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

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< Common::FrameSpec::Object, checksum_type >.

◆ pBytes() [2/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtual

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< Common::FrameSpec::Object, checksum_type >.

◆ pCreate() [1/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ pCreate() [2/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ Promote() [1/2]

template<typename T >
ClassicIO< T >::promote_ret_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

Promote previous version of object to this version.

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

◆ Promote() [2/2]

template<typename T >
static promote_ret_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
static

Promote previous version of object to this version.

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

◆ promote() [1/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

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

◆ promote() [2/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtual

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

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

◆ pWrite() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ pWrite() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtual

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ RefData() [1/4]

data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( )
inlineinherited

◆ RefData() [2/4]

data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( )
inlineinherited

◆ RefData() [3/4]

const data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( ) const
inlineinherited

◆ RefData() [4/4]

const data_type & FrameCPP::Version_9::FrEventImpl::Data::RefData ( ) const
inlineinherited

◆ RefTable() [1/4]

table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [2/4]

table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( )
inlineinherited

◆ RefTable() [3/4]

const table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( ) const
inlineinherited

◆ RefTable() [4/4]

const table_type & FrameCPP::Version_9::FrEventImpl::Data::RefTable ( ) const
inlineinherited

◆ StructDescription() [1/2]

template<typename T >
static const Common::Description * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

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

◆ StructDescription() [2/2]

template<typename T >
static const Common::Description * FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::StructDescription ( )
inlinestatic

The description of structure.

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

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ VerifyObject() [1/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/2]

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

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ vTOCQuery() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtual

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrEventImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtual

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ Write() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

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

◆ amplitude

amplitude_type FrameCPP::Version_9::FrEventImpl::Data::amplitude
protectedinherited

Continuous output amplitude returned by event.

◆ comment

comment_type FrameCPP::Version_9::FrEventImpl::Data::comment
protectedinherited

Descriptor of event.

◆ data

data_type FrameCPP::Version_9::FrEventImpl::Data::data
protectedinherited

Container of additional event results.

◆ eventStatus

eventStatus_type FrameCPP::Version_9::FrEventImpl::Data::eventStatus
protectedinherited

Defined by event search algorithm.

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

◆ GTime

GTime_type FrameCPP::Version_9::FrEventImpl::Data::GTime
protectedinherited

GPS time corresponding to reference value of event, as defined by the search algorithm.

◆ inputs

inputs_type FrameCPP::Version_9::FrEventImpl::Data::inputs
protectedinherited

Input channels and filter parameters to event process.

◆ m_chkSum

checksum_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::m_chkSum
privateinherited

Structure checksum.

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

◆ m_class

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

Storage for the class identifier.

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

◆ m_desc

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

Description for parent class.

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

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_9::FrEventImpl::Data::MAX_REF { 2 }
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_9::FrEventImpl::Data::name
protectedinherited

Name of event.

◆ Params

ParamList_type FrameCPP::Version_9::FrEventImpl::Data::Params
protectedinherited

Array of parameters.

◆ probability

probability_type FrameCPP::Version_9::FrEventImpl::Data::probability
protectedinherited

Likelihood estimate of event, if available (probability = -1 if cannot be estimated)

◆ statistics

statistics_type FrameCPP::Version_9::FrEventImpl::Data::statistics
protectedinherited

Statistical description of event, if relevant or available.

◆ table

table_type FrameCPP::Version_9::FrEventImpl::Data::table
protectedinherited

Table containing additional event information.

◆ timeAfter

timeAfter_type FrameCPP::Version_9::FrEventImpl::Data::timeAfter
protectedinherited

Signal duration after (GTimeS.GTimeN)(seconds)

◆ timeBefore

timeBefore_type FrameCPP::Version_9::FrEventImpl::Data::timeBefore
protectedinherited

Signal duration before (GTimeS.GTimeN)(seconds)


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