ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrEvent Class Reference

Event data. More...

#include <FrEvent.hh>

Inheritance diagram for FrameCPP::Version_8::FrEvent:
Collaboration diagram for FrameCPP::Version_8::FrEvent:

Public Types

typedef GTime_type time_type
typedef GTime_type time_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 STRING< INT_2U > string_2_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef IStream istream_type
typedef IStream istream_type
typedef OStream ostream_type
typedef OStream ostream_type
typedef 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 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 const char *const struct_name_type
typedef const char *const struct_desc_type
typedef INT_2U const struct_id_type

Public Member Functions

 FrEvent ()
 Default constructor.
 FrEvent (const FrEvent &eventData)
 Copy constructor.
 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.
 FrEvent (const Previous::FrEvent &Source, stream_base_type *Stream)
 Upconvert constructor.
const std::string & GetNameSlow () const
 Retrieve the name of the event.
FrEventMerge (const FrEvent &RHS)
 Merge with another FrEvent.
bool operator== (FrEvent const &RHS) const
 equality operator
virtual bool operator== (Common::FrameSpec::Object const &Obj) const
 equality operator for abstract data type
 FrEvent ()
 Default constructor.
 FrEvent (const FrEvent &eventData)
 Copy constructor.
 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.
 FrEvent (const Previous::FrEvent &Source, stream_base_type *Stream)
 Upconvert constructor.
const std::string & GetNameSlow () const
 Retrieve the name of the event.
FrEventMerge (const FrEvent &RHS)
 Merge with another FrEvent.
bool operator== (FrEvent const &RHS) const
 equality operator
virtual bool operator== (Common::FrameSpec::Object const &Obj) const
 equality operator for abstract data type
virtual const char * ObjectStructName () const
 The name structure name of this object.
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.
name_type const & GetName () const
comment_type const & GetComment () const
inputs_type const & GetInputs () const
GTime_type const & GetGTime () const
timeBefore_type GetTimeBefore () const
timeAfter_type GetTimeAfter () const
eventStatus_type GetEventStatus () const
amplitude_type GetAmplitude () const
probability_type GetProbability () const
statistics_type const & GetStatistics () const
ParamList_type const & GetParam () const
ParamList_typeGetParam ()
const data_typeRefData () const
data_typeRefData ()
const table_typeRefTable () const
table_typeRefTable ()
bool operator== (Data const &RHS) const

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.
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 struct_name_type FrameSpecName ()
static struct_name_type StructName ()
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.

Static Public Attributes

static constexpr unsigned int MAX_REF
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, 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.

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.

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_typeobject_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
void load (Archive &archiver, const unsigned int version)
void save (Archive &archiver, const unsigned int version) const

Private Attributes

ChecksumType m_chkSum
 Structure checksum.

Detailed Description

Event data.

Member Typedef Documentation

◆ amplitude_type

◆ comment_type

◆ data_type

◆ eventStatus_type

◆ GTime_type

◆ inputs_type

◆ io_comment_type

typedef STRING FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::io_comment_type
privateinherited

◆ io_inputs_type

typedef STRING FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::io_inputs_type
privateinherited

◆ io_name_type

typedef STRING FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::io_name_type
privateinherited

◆ io_statistics_type

typedef STRING FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::io_statistics_type
privateinherited

◆ istream_type [1/2]

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

◆ istream_type [2/2]

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

◆ name_type

◆ nParam_type

◆ object_base_type

◆ ostream_type [1/2]

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

◆ ostream_type [2/2]

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

◆ Param_type

◆ ParamList_type

◆ paramName_type

◆ paramValue_type

◆ probability_type

◆ self_type [1/2]

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

◆ self_type [2/2]

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

◆ statistics_type

◆ string_2_type [1/2]

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

◆ string_2_type [2/2]

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

◆ struct_desc_type

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

◆ struct_id_type

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

◆ struct_name_type

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

◆ table_type

◆ time_type [1/2]

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

◆ time_type [2/2]

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

◆ timeAfter_type

◆ timeBefore_type

Member Enumeration Documentation

◆ 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 

Constructor & Destructor Documentation

◆ FrEvent() [1/8]

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

Default constructor.

◆ FrEvent() [2/8]

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

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

FrameCPP::Version_8::FrEvent::FrEvent ( const Previous::FrEvent & Source,
stream_base_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/8]

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

Default constructor.

◆ FrEvent() [6/8]

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

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

FrameCPP::Version_8::FrEvent::FrEvent ( const Previous::FrEvent & Source,
stream_base_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/2]

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

Return the number of bytes for this object.

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

◆ Bytes() [2/2]

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

Return the number of bytes for this object.

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

◆ CheckSumDataClass() [1/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

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

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

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

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

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

◆ Create() [2/6]

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

◆ Create() [3/6]

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

Virtual constructor.

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

◆ Create() [4/6]

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

Virtual constructor.

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

◆ Create() [5/6]

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

constructor - virtual

◆ Create() [6/6]

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

constructor - virtual

◆ DataType() [1/4]

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

◆ DataType() [2/4]

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

◆ DataType() [3/4]

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

◆ DataType() [4/4]

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

◆ demote()

virtual demote_ret_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_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()

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

Return the dictionary name of the structure.

◆ FrameSpecId()

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

Return the dictionary name of the structure.

◆ FrameSpecName()

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

◆ GetAmplitude()

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

◆ GetComment()

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

◆ GetEventStatus()

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

◆ GetGTime()

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

◆ GetInputs()

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

◆ GetName()

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

◆ GetNameSlow() [1/2]

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

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

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

◆ GetParam() [2/2]

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

◆ GetProbability()

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

◆ GetStatistics()

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

◆ GetTimeAfter()

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

◆ GetTimeBefore()

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

◆ load()

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

◆ Merge() [1/2]

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

Merge with another FrEvent.

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

◆ Merge() [2/2]

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

Merge with another FrEvent.

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

◆ ObjectStructName()

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

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

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

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

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

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

◆ pBytes()

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()

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()

promote_ret_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_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()

virtual promote_ret_type FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_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()

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

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

◆ RefData() [2/2]

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

◆ RefTable() [1/2]

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

◆ RefTable() [2/2]

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

◆ save()

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

◆ StructDescription()

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()

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

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ vTOCQuery()

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

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

Write object to the stream.

◆ Write() [2/2]

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

Write object to the stream.

Member Data Documentation

◆ 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

constexpr unsigned int FrameCPP::Version_8::FrEventImpl::ClassicIO< FrEvent >::MAX_REF
staticconstexprinherited

◆ 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>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

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

◆ struct_name

template<typename Object_T>
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 files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version8/FrEvent.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/FrEvent.hh