ldas-tools-framecpp  2.9.3
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrEvent Class Reference

Event data. More...

#include <FrEvent.hh>

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

Public Types

typedef GTime_type time_type
 
typedef GTime_type time_type
 
typedef GTime_type time_type
 
typedef FR_EVENT_N_PARAM_TYPE nParam_type
 
typedef FR_EVENT_N_PARAM_TYPE nParam_type
 
typedef FR_EVENT_N_PARAM_TYPE nParam_type
 
typedef FR_EVENT_PARAM_NAME_TYPE paramName_type
 
typedef FR_EVENT_PARAM_NAME_TYPE paramName_type
 
typedef FR_EVENT_PARAM_NAME_TYPE paramName_type
 
typedef FR_EVENT_PARAM_VALUE_TYPE paramValue_type
 
typedef FR_EVENT_PARAM_VALUE_TYPE paramValue_type
 
typedef FR_EVENT_PARAM_VALUE_TYPE paramValue_type
 
typedef std::pair< paramName_type, paramValue_typeParam_type
 
typedef std::pair< paramName_type, paramValue_typeParam_type
 
typedef std::pair< paramName_type, paramValue_typeParam_type
 
typedef std::vector< Param_typeParamList_type
 
typedef std::vector< Param_typeParamList_type
 
typedef std::vector< Param_typeParamList_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string name_type
 
typedef std::string comment_type
 
typedef std::string comment_type
 
typedef std::string comment_type
 
typedef std::string inputs_type
 
typedef std::string inputs_type
 
typedef std::string inputs_type
 
typedef GPSTime GTime_type
 
typedef GPSTime GTime_type
 
typedef GPSTime GTime_type
 
typedef FR_EVENT_TIME_BEFORE_TYPE timeBefore_type
 
typedef FR_EVENT_TIME_BEFORE_TYPE timeBefore_type
 
typedef FR_EVENT_TIME_BEFORE_TYPE timeBefore_type
 
typedef FR_EVENT_TIME_AFTER_TYPE timeAfter_type
 
typedef FR_EVENT_TIME_AFTER_TYPE timeAfter_type
 
typedef FR_EVENT_TIME_AFTER_TYPE timeAfter_type
 
typedef FR_EVENT_EVENT_STATUS_TYPE eventStatus_type
 
typedef FR_EVENT_EVENT_STATUS_TYPE eventStatus_type
 
typedef FR_EVENT_EVENT_STATUS_TYPE eventStatus_type
 
typedef FR_EVENT_AMPLITUDE_TYPE amplitude_type
 
typedef FR_EVENT_AMPLITUDE_TYPE amplitude_type
 
typedef FR_EVENT_AMPLITUDE_TYPE amplitude_type
 
typedef FR_EVENT_PROBABILITY_TYPE probability_type
 
typedef FR_EVENT_PROBABILITY_TYPE probability_type
 
typedef FR_EVENT_PROBABILITY_TYPE probability_type
 
typedef std::string statistics_type
 
typedef std::string statistics_type
 
typedef std::string statistics_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamedata_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamedata_type
 
typedef Common::SearchContainer< FrVect, &FrVect::GetNamedata_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlowtable_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlowtable_type
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlowtable_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 

Public Member Functions

 FrEvent ()
 Default constructor. More...
 
 FrEvent (const FrEvent &eventData)
 Copy constructor. More...
 
 FrEvent (const name_type &name, const comment_type &comment, const inputs_type &inputs, const time_type &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const eventStatus_type eventStatus, const amplitude_type amplitude, const probability_type probability, const statistics_type &statistics, const ParamList_type &parameters)
 Constructor. More...
 
 FrEvent (const Previous::FrEvent &Source, istream_type *Stream)
 Upconvert constructor. More...
 
const std::string & GetNameSlow () const
 Retrieve the name of the event. More...
 
FrEventMerge (const FrEvent &RHS)
 Merge with another FrEvent. More...
 
bool operator== (FrEvent const &RHS) const
 equality operator More...
 
virtual bool operator== (Common::FrameSpec::Object const &Obj) const
 equality operator for abstract data type More...
 
 FrEvent ()
 Default constructor. More...
 
 FrEvent (const FrEvent &eventData)
 Copy constructor. More...
 
 FrEvent (const name_type &name, const comment_type &comment, const inputs_type &inputs, const time_type &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const eventStatus_type eventStatus, const amplitude_type amplitude, const probability_type probability, const statistics_type &statistics, const ParamList_type &parameters)
 Constructor. More...
 
 FrEvent (const Previous::FrEvent &Source, istream_type *Stream)
 Upconvert constructor. More...
 
const std::string & GetNameSlow () const
 Retrieve the name of the event. More...
 
FrEventMerge (const FrEvent &RHS)
 Merge with another FrEvent. More...
 
bool operator== (FrEvent const &RHS) const
 equality operator More...
 
virtual bool operator== (Common::FrameSpec::Object const &Obj) const
 equality operator for abstract data type More...
 
 FrEvent ()
 Default constructor. More...
 
 FrEvent (const FrEvent &eventData)
 Copy constructor. More...
 
 FrEvent (const name_type &name, const comment_type &comment, const inputs_type &inputs, const time_type &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const eventStatus_type eventStatus, const amplitude_type amplitude, const probability_type probability, const statistics_type &statistics, const ParamList_type &parameters)
 Constructor. More...
 
 FrEvent (const Previous::FrEvent &Source, istream_type *Stream)
 Upconvert constructor. More...
 
const std::string & GetNameSlow () const
 Retrieve the name of the event. More...
 
FrEventMerge (const FrEvent &RHS)
 Merge with another FrEvent. More...
 
bool operator== (FrEvent const &RHS) const
 equality operator More...
 
virtual bool operator== (Common::FrameSpec::Object const &Obj) const
 equality operator for abstract data type More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
name_type const & GetName () const
 
name_type const & GetName () const
 
name_type const & GetName () const
 
comment_type const & GetComment () const
 
comment_type const & GetComment () const
 
comment_type const & GetComment () const
 
inputs_type const & GetInputs () const
 
inputs_type const & GetInputs () const
 
inputs_type const & GetInputs () const
 
GTime_type const & GetGTime () const
 
GTime_type const & GetGTime () const
 
GTime_type const & GetGTime () const
 
timeBefore_type GetTimeBefore () const
 
timeBefore_type GetTimeBefore () const
 
timeBefore_type GetTimeBefore () const
 
timeAfter_type GetTimeAfter () const
 
timeAfter_type GetTimeAfter () const
 
timeAfter_type GetTimeAfter () const
 
eventStatus_type GetEventStatus () const
 
eventStatus_type GetEventStatus () const
 
eventStatus_type GetEventStatus () const
 
amplitude_type GetAmplitude () const
 
amplitude_type GetAmplitude () const
 
amplitude_type GetAmplitude () const
 
probability_type GetProbability () const
 
probability_type GetProbability () const
 
probability_type GetProbability () const
 
statistics_type const & GetStatistics () 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 ()
 
ParamList_type const & GetParam () const
 
ParamList_typeGetParam ()
 
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 ()
 
bool operator== (Data const &RHS) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 

Static Public Member Functions

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

Static Public Attributes

static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 

Protected Attributes

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

Static Protected Attributes

static constexpr unsigned int MAX_REF { 2 }
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_comment_type
 
typedef STRING io_comment_type
 
typedef STRING io_inputs_type
 
typedef STRING io_inputs_type
 
typedef STRING io_inputs_type
 
typedef STRING io_statistics_type
 
typedef STRING io_statistics_type
 
typedef STRING io_statistics_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
void load (Archive &archiver, const unsigned int version)
 
void load (Archive &archiver, const unsigned int version)
 
void load (Archive &archiver, const unsigned int version)
 
void save (Archive &archiver, const unsigned int version) const
 
void save (Archive &archiver, const unsigned int version) const
 
void save (Archive &archiver, const unsigned int version) const
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum. More...
 

Detailed Description

Event data.

Member Typedef Documentation

◆ amplitude_type [1/3]

◆ amplitude_type [2/3]

◆ amplitude_type [3/3]

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ data_type [1/3]

◆ data_type [2/3]

◆ data_type [3/3]

◆ eventStatus_type [1/3]

◆ eventStatus_type [2/3]

◆ eventStatus_type [3/3]

◆ GTime_type [1/3]

◆ GTime_type [2/3]

◆ GTime_type [3/3]

◆ inputs_type [1/3]

◆ inputs_type [2/3]

◆ inputs_type [3/3]

◆ io_comment_type [1/3]

◆ io_comment_type [2/3]

◆ io_comment_type [3/3]

◆ io_inputs_type [1/3]

◆ io_inputs_type [2/3]

◆ io_inputs_type [3/3]

◆ io_name_type [1/3]

◆ io_name_type [2/3]

◆ io_name_type [3/3]

◆ io_statistics_type [1/3]

◆ io_statistics_type [2/3]

◆ io_statistics_type [3/3]

◆ istream_type [1/3]

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

◆ istream_type [2/3]

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

◆ istream_type [3/3]

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

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nParam_type [1/3]

◆ nParam_type [2/3]

◆ nParam_type [3/3]

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ ostream_type [1/3]

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

◆ ostream_type [2/3]

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

◆ ostream_type [3/3]

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

◆ Param_type [1/3]

◆ Param_type [2/3]

◆ Param_type [3/3]

◆ ParamList_type [1/3]

◆ ParamList_type [2/3]

◆ ParamList_type [3/3]

◆ paramName_type [1/3]

◆ paramName_type [2/3]

◆ paramName_type [3/3]

◆ paramValue_type [1/3]

◆ paramValue_type [2/3]

◆ paramValue_type [3/3]

◆ probability_type [1/3]

◆ probability_type [2/3]

◆ probability_type [3/3]

◆ self_type [1/3]

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

◆ self_type [2/3]

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

◆ self_type [3/3]

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

◆ statistics_type [1/3]

◆ statistics_type [2/3]

◆ statistics_type [3/3]

◆ string_2_type [1/3]

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

◆ string_2_type [2/3]

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

◆ string_2_type [3/3]

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

◆ struct_desc_type [1/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [2/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_desc_type [3/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type [1/3]

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [2/3]

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_id_type [3/3]

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type [1/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [2/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ struct_name_type [3/3]

template<typename Object_T >
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ table_type [1/3]

◆ table_type [2/3]

◆ table_type [3/3]

◆ time_type [1/3]

typedef GTime_type FrameCPP::Version_8::FrEvent::time_type

◆ time_type [2/3]

typedef GTime_type FrameCPP::Version_8::FrEvent::time_type

◆ time_type [3/3]

typedef GTime_type FrameCPP::Version_8::FrEvent::time_type

◆ timeAfter_type [1/3]

◆ timeAfter_type [2/3]

◆ timeAfter_type [3/3]

◆ timeBefore_type [1/3]

◆ timeBefore_type [2/3]

◆ timeBefore_type [3/3]

Member Enumeration Documentation

◆ anonymous enum

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

◆ anonymous enum

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

◆ anonymous enum

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

◆ anonymous enum

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

◆ anonymous enum

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

◆ anonymous enum

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

Constructor & Destructor Documentation

◆ FrEvent() [1/12]

FrameCPP::Version_8::FrEvent::FrEvent ( )

Default constructor.

◆ FrEvent() [2/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const FrEvent eventData)

Copy constructor.

Parameters
[in]eventDataSource of the event data.
Returns
A new instance of this object.

◆ FrEvent() [3/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const name_type name,
const comment_type comment,
const inputs_type inputs,
const time_type time,
const timeBefore_type  timeBefore,
const timeAfter_type  timeAfter,
const eventStatus_type  eventStatus,
const amplitude_type  amplitude,
const probability_type  probability,
const statistics_type statistics,
const ParamList_type parameters 
)

Constructor.

Parameters
[in]nameName of event.
[in]commentDescriptor of event.
[in]inputsInput channels and filter parameters to event process.
[in]timeGPS time corresponding to reference value of event.
[in]timeBeforeSignal duration before time.
[in]timeAfterSignal duration after time.
[in]eventStatusDefined by event search algorithm.
[in]amplitudeContinuous output amplitude returned by event.
[in]probabilityLikelihood estimate of event.
[in]statisticsStatistical description of event.
[in]parametersArray of additional event parameters.
Returns
A new instance of this object.

◆ FrEvent() [4/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const Previous::FrEvent &  Source,
istream_type Stream 
)

Upconvert constructor.

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

◆ FrEvent() [5/12]

FrameCPP::Version_8::FrEvent::FrEvent ( )

Default constructor.

◆ FrEvent() [6/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const FrEvent eventData)

Copy constructor.

Parameters
[in]eventDataSource of the event data.
Returns
A new instance of this object.

◆ FrEvent() [7/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const name_type name,
const comment_type comment,
const inputs_type inputs,
const time_type time,
const timeBefore_type  timeBefore,
const timeAfter_type  timeAfter,
const eventStatus_type  eventStatus,
const amplitude_type  amplitude,
const probability_type  probability,
const statistics_type statistics,
const ParamList_type parameters 
)

Constructor.

Parameters
[in]nameName of event.
[in]commentDescriptor of event.
[in]inputsInput channels and filter parameters to event process.
[in]timeGPS time corresponding to reference value of event.
[in]timeBeforeSignal duration before time.
[in]timeAfterSignal duration after time.
[in]eventStatusDefined by event search algorithm.
[in]amplitudeContinuous output amplitude returned by event.
[in]probabilityLikelihood estimate of event.
[in]statisticsStatistical description of event.
[in]parametersArray of additional event parameters.
Returns
A new instance of this object.

◆ FrEvent() [8/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const Previous::FrEvent &  Source,
istream_type Stream 
)

Upconvert constructor.

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

◆ FrEvent() [9/12]

FrameCPP::Version_8::FrEvent::FrEvent ( )

Default constructor.

◆ FrEvent() [10/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const FrEvent eventData)

Copy constructor.

Parameters
[in]eventDataSource of the event data.
Returns
A new instance of this object.

◆ FrEvent() [11/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const name_type name,
const comment_type comment,
const inputs_type inputs,
const time_type time,
const timeBefore_type  timeBefore,
const timeAfter_type  timeAfter,
const eventStatus_type  eventStatus,
const amplitude_type  amplitude,
const probability_type  probability,
const statistics_type statistics,
const ParamList_type parameters 
)

Constructor.

Parameters
[in]nameName of event.
[in]commentDescriptor of event.
[in]inputsInput channels and filter parameters to event process.
[in]timeGPS time corresponding to reference value of event.
[in]timeBeforeSignal duration before time.
[in]timeAfterSignal duration after time.
[in]eventStatusDefined by event search algorithm.
[in]amplitudeContinuous output amplitude returned by event.
[in]probabilityLikelihood estimate of event.
[in]statisticsStatistical description of event.
[in]parametersArray of additional event parameters.
Returns
A new instance of this object.

◆ FrEvent() [12/12]

FrameCPP::Version_8::FrEvent::FrEvent ( const Previous::FrEvent &  Source,
istream_type Stream 
)

Upconvert constructor.

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

Member Function Documentation

◆ Bytes() [1/3]

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

Return the number of bytes for this object.

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

◆ Bytes() [2/3]

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

Return the number of bytes for this object.

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

◆ Bytes() [3/3]

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

Return the number of bytes for this object.

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

◆ CheckSumDataClass() [1/3]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/3]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [3/3]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/3]

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/3]

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [3/3]

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

Comment to be used in comment field of FrSE.

◆ Create() [1/9]

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

◆ Create() [2/9]

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

◆ Create() [3/9]

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

◆ Create() [4/9]

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

Virtual constructor.

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

◆ Create() [5/9]

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

Virtual constructor.

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

◆ Create() [6/9]

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

Virtual constructor.

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

◆ Create() [7/9]

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

constructor - virtual

◆ Create() [8/9]

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

constructor - virtual

◆ Create() [9/9]

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

constructor - virtual

◆ DataType() [1/6]

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

◆ DataType() [2/6]

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

◆ DataType() [3/6]

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

◆ DataType() [4/6]

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

◆ DataType() [5/6]

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

◆ DataType() [6/6]

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

◆ demote() [1/3]

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

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.

◆ demote() [2/3]

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

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.

◆ demote() [3/3]

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

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.

◆ FrameSpecDescription() [1/3]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/3]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [3/3]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/3]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/3]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [3/3]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [3/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetAmplitude() [1/3]

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

◆ GetAmplitude() [2/3]

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

◆ GetAmplitude() [3/3]

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

◆ GetComment() [1/3]

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

◆ GetComment() [2/3]

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

◆ GetComment() [3/3]

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

◆ GetEventStatus() [1/3]

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

◆ GetEventStatus() [2/3]

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

◆ GetEventStatus() [3/3]

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

◆ GetGTime() [1/3]

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

◆ GetGTime() [2/3]

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

◆ GetGTime() [3/3]

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

◆ GetInputs() [1/3]

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

◆ GetInputs() [2/3]

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

◆ GetInputs() [3/3]

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

◆ GetName() [1/3]

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

◆ GetName() [2/3]

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

◆ GetName() [3/3]

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

◆ GetNameSlow() [1/3]

const std::string& FrameCPP::Version_8::FrEvent::GetNameSlow ( ) const

Retrieve the name of the event.

Returns
A name of the event via non-inlined function

◆ GetNameSlow() [2/3]

const std::string& FrameCPP::Version_8::FrEvent::GetNameSlow ( ) const

Retrieve the name of the event.

Returns
A name of the event via non-inlined function

◆ GetNameSlow() [3/3]

const std::string& FrameCPP::Version_8::FrEvent::GetNameSlow ( ) const

Retrieve the name of the event.

Returns
A name of the event via non-inlined function

◆ GetParam() [1/6]

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

◆ GetParam() [2/6]

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

◆ GetParam() [3/6]

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

◆ GetParam() [4/6]

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

◆ GetParam() [5/6]

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

◆ GetParam() [6/6]

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

◆ GetProbability() [1/3]

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

◆ GetProbability() [2/3]

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

◆ GetProbability() [3/3]

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

◆ GetStatistics() [1/3]

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

◆ GetStatistics() [2/3]

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

◆ GetStatistics() [3/3]

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

◆ GetTimeAfter() [1/3]

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

◆ GetTimeAfter() [2/3]

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

◆ GetTimeAfter() [3/3]

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

◆ GetTimeBefore() [1/3]

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

◆ GetTimeBefore() [2/3]

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

◆ GetTimeBefore() [3/3]

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

◆ load() [1/3]

void FrameCPP::Version_8::FrEventImpl::SerialIO< FrEvent >::load ( Archive &  archiver,
const unsigned int  version 
)
inlineprivateinherited

◆ load() [2/3]

void FrameCPP::Version_8::FrEventImpl::SerialIO< FrEvent >::load ( Archive &  archiver,
const unsigned int  version 
)
inlineprivateinherited

◆ load() [3/3]

void FrameCPP::Version_8::FrEventImpl::SerialIO< FrEvent >::load ( Archive &  archiver,
const unsigned int  version 
)
inlineprivateinherited

◆ Merge() [1/3]

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

Merge with another FrEvent.

Parameters
[in]RHSFrEvent information to incorperate into this object.

◆ Merge() [2/3]

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

Merge with another FrEvent.

Parameters
[in]RHSFrEvent information to incorperate into this object.

◆ Merge() [3/3]

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

Merge with another FrEvent.

Parameters
[in]RHSFrEvent information to incorperate into this object.

◆ ObjectStructName() [1/3]

virtual const char* FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/3]

virtual const char* FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [3/3]

virtual const char* FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/7]

virtual bool FrameCPP::Version_8::FrEvent::operator== ( Common::FrameSpec::Object const &  Obj) const
virtual

equality operator for abstract data type

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

◆ operator==() [2/7]

virtual bool FrameCPP::Version_8::FrEvent::operator== ( Common::FrameSpec::Object const &  Obj) const
virtual

equality operator for abstract data type

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

◆ operator==() [3/7]

virtual bool FrameCPP::Version_8::FrEvent::operator== ( Common::FrameSpec::Object const &  Obj) const
virtual

equality operator for abstract data type

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

◆ operator==() [4/7]

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

◆ operator==() [5/7]

bool FrameCPP::Version_8::FrEvent::operator== ( FrEvent const &  RHS) const
inline

equality operator

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

◆ operator==() [6/7]

bool FrameCPP::Version_8::FrEvent::operator== ( FrEvent const &  RHS) const

equality operator

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

◆ operator==() [7/7]

bool FrameCPP::Version_8::FrEvent::operator== ( FrEvent const &  RHS) const

equality operator

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

◆ pBytes() [1/3]

cmn_streamsize_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

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

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

◆ pBytes() [2/3]

cmn_streamsize_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

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

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

◆ pBytes() [3/3]

cmn_streamsize_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::pBytes ( const Common::StreamBase Stream) const
inlineprotectedvirtualinherited

Number of bytes needed to write this structure.

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

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

◆ pCreate() [1/3]

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

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

◆ pCreate() [2/3]

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

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

◆ pCreate() [3/3]

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

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

◆ Promote() [1/3]

ClassicIO< FrEvent >::promote_ret_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
staticinherited

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

static promote_ret_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
staticinherited

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

static promote_ret_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
staticinherited

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

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

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.

◆ promote() [2/3]

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

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.

◆ promote() [3/3]

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

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.

◆ pWrite() [1/3]

virtual void FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

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

◆ pWrite() [2/3]

virtual void FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

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

◆ pWrite() [3/3]

virtual void FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

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

◆ RefData() [1/6]

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

◆ RefData() [2/6]

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

◆ RefData() [3/6]

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

◆ RefData() [4/6]

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

◆ RefData() [5/6]

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

◆ RefData() [6/6]

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

◆ RefTable() [1/6]

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

◆ RefTable() [2/6]

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

◆ RefTable() [3/6]

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

◆ RefTable() [4/6]

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

◆ RefTable() [5/6]

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

◆ RefTable() [6/6]

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

◆ save() [1/3]

void FrameCPP::Version_8::FrEventImpl::SerialIO< FrEvent >::save ( Archive &  archiver,
const unsigned int  version 
) const
inlineprivateinherited

◆ save() [2/3]

void FrameCPP::Version_8::FrEventImpl::SerialIO< FrEvent >::save ( Archive &  archiver,
const unsigned int  version 
) const
inlineprivateinherited

◆ save() [3/3]

void FrameCPP::Version_8::FrEventImpl::SerialIO< FrEvent >::save ( Archive &  archiver,
const unsigned int  version 
) const
inlineprivateinherited

◆ StructDescription() [1/3]

static const Common::Description* FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/3]

static const Common::Description* FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [3/3]

static const Common::Description* FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName() [1/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [3/3]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ TOCQuery() [1/3]

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

◆ TOCQuery() [2/3]

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

◆ TOCQuery() [3/3]

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

◆ vTOCQuery() [1/3]

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

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/3]

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

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [3/3]

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

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/3]

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

Write object to the stream.

◆ Write() [2/3]

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

Write object to the stream.

◆ Write() [3/3]

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

Write object to the stream.

Member Data Documentation

◆ amplitude

amplitude_type FrameCPP::Version_8::FrEventImpl::Data::amplitude
protectedinherited

Continuous output amplitude returned by event.

◆ comment

comment_type FrameCPP::Version_8::FrEventImpl::Data::comment
protectedinherited

Descriptor of event.

◆ data

data_type FrameCPP::Version_8::FrEventImpl::Data::data
protectedinherited

Container of additional event results.

◆ eventStatus

eventStatus_type FrameCPP::Version_8::FrEventImpl::Data::eventStatus
protectedinherited

Defined by event search algorithm.

◆ GTime

GTime_type FrameCPP::Version_8::FrEventImpl::Data::GTime
protectedinherited

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

◆ inputs

inputs_type FrameCPP::Version_8::FrEventImpl::Data::inputs
protectedinherited

Input channels and filter parameters to event process.

◆ m_chkSum

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

Structure checksum.

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

◆ MAX_REF

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

◆ name

name_type FrameCPP::Version_8::FrEventImpl::Data::name
protectedinherited

Name of event.

◆ Params

ParamList_type FrameCPP::Version_8::FrEventImpl::Data::Params
protectedinherited

Array of parameters.

◆ probability

probability_type FrameCPP::Version_8::FrEventImpl::Data::probability
protectedinherited

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

◆ statistics

statistics_type FrameCPP::Version_8::FrEventImpl::Data::statistics
protectedinherited

Statistical description of event, if relevant or available.

◆ struct_desc

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ table

table_type FrameCPP::Version_8::FrEventImpl::Data::table
protectedinherited

Table containing additional event information.

◆ timeAfter

timeAfter_type FrameCPP::Version_8::FrEventImpl::Data::timeAfter
protectedinherited

Signal duration after (GTimeS.GTimeN)(seconds)

◆ timeBefore

timeBefore_type FrameCPP::Version_8::FrEventImpl::Data::timeBefore
protectedinherited

Signal duration before (GTimeS.GTimeN)(seconds)


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