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

#include <FrEvent.hh>

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

Public Types

typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 
typedef FR_EVENT_NAME_TYPE name_type
 
typedef FR_EVENT_NAME_TYPE name_type
 
typedef FR_EVENT_COMMENT_TYPE comment_type
 
typedef FR_EVENT_COMMENT_TYPE comment_type
 
typedef FR_EVENT_INPUTS_TYPE inputs_type
 
typedef FR_EVENT_INPUTS_TYPE inputs_type
 
typedef FR_EVENT_TIME_TYPE time_type
 
typedef FR_EVENT_TIME_TYPE time_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_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_PROBABILITY_TYPE probability_type
 
typedef FR_EVENT_PROBABILITY_TYPE probability_type
 
typedef FR_EVENT_STATISTICS_TYPE statistics_type
 
typedef FR_EVENT_STATISTICS_TYPE statistics_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_N_PARAM_TYPE nParam_type
 
typedef FR_EVENT_N_PARAM_TYPE nParam_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
 
enum  {
  DT_CHAR_PTR, DT_STRING_2, DT_INT_2S, DT_INT_2U,
  DT_INT_4S, DT_INT_4U, DT_INT_8S, DT_INT_8U,
  DT_REAL_4, DT_REAL_8
}
 
enum  {
  IC_EOQ, IC_AMPLITUDE, IC_CHANNEL_ID, IC_DATA_QUALITY,
  IC_DATA_VALID, IC_DETECTOR, IC_DETECTOR_PREFIX, IC_DT,
  IC_END, IC_FRAME, IC_GROUP_ID, IC_GTIME_N,
  IC_GTIME_S, IC_ID, IC_LOCAL_TIME, IC_NAME,
  IC_RUN, IC_START, IC_ULEAP_S, IC_VERSION
}
 
enum  {
  DT_CHAR_PTR, DT_STRING_2, DT_INT_2S, DT_INT_2U,
  DT_INT_4S, DT_INT_4U, DT_INT_8S, DT_INT_8U,
  DT_REAL_4, DT_REAL_8
}
 
enum  {
  IC_EOQ, IC_AMPLITUDE, IC_CHANNEL_ID, IC_DATA_QUALITY,
  IC_DATA_VALID, IC_DETECTOR, IC_DETECTOR_PREFIX, IC_DT,
  IC_END, IC_FRAME, IC_GROUP_ID, IC_GTIME_N,
  IC_GTIME_S, IC_ID, IC_LOCAL_TIME, IC_NAME,
  IC_RUN, IC_START, IC_ULEAP_S, IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrEvent ()
 
 FrEvent (const FrEvent &eventData)
 
 FrEvent (const std::string &name, const std::string &comment, const std::string &inputs, const GPSTime &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const eventStatus_type eventStatus, const amplitude_type amplitude, const probability_type prob, const std::string &statistics, const ParamList_type &parameters)
 
 FrEvent (const Previous::FrEvent &Source, istream_type *Stream)
 
const std::string & GetNameSlow () const
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrEventCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
FrEventMerge (const FrEvent &RHS)
 
bool operator== (const FrEvent &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
 FrEvent ()
 
 FrEvent (const FrEvent &eventData)
 
 FrEvent (const std::string &name, const std::string &comment, const std::string &inputs, const GPSTime &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const eventStatus_type eventStatus, const amplitude_type amplitude, const probability_type prob, const std::string &statistics, const ParamList_type &parameters)
 
 FrEvent (const Previous::FrEvent &Source, istream_type *Stream)
 
const std::string & GetNameSlow () const
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Return the number of bytes for this object. More...
 
virtual FrEventCreate (istream_type &Stream) const
 constructor - virtual More...
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object. More...
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
FrEventMerge (const FrEvent &RHS)
 
bool operator== (const FrEvent &RHS) const
 comparison operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 
const name_typeGetName () const
 
const name_typeGetName () const
 
const comment_typeGetComment () const
 
const comment_typeGetComment () const
 
const inputs_typeGetInputs () const
 
const inputs_typeGetInputs () const
 
const time_typeGetGTime () const
 
const time_typeGetGTime () const
 
timeBefore_type GetTimeBefore () const
 
timeBefore_type GetTimeBefore () const
 
timeAfter_type GetTimeAfter () const
 
timeAfter_type GetTimeAfter () const
 
eventStatus_type GetEventStatus () const
 
eventStatus_type GetEventStatus () const
 
amplitude_type GetAmplitude () const
 
amplitude_type GetAmplitude () const
 
probability_type GetProbability () const
 
probability_type GetProbability () const
 
const statistics_typeGetStatistics () const
 
const statistics_typeGetStatistics () const
 
const ParamList_typeGetParam () const
 
ParamList_typeGetParam ()
 
const ParamList_typeGetParam () const
 
ParamList_typeGetParam ()
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 
static const char * StructName ()
 
static const Common::DescriptionStructDescription ()
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. 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)
 

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 promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
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 void vTOCQuery (int InfoClass, va_list vl) const
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

data_type m_data
 

Private Member Functions

 FrEvent (istream_type &Stream)
 
 FrEvent (istream_type &Stream)
 

Private Attributes

const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. More...
 

Member Typedef Documentation

◆ amplitude_type [1/2]

◆ amplitude_type [2/2]

◆ comment_type [1/2]

◆ comment_type [2/2]

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ eventStatus_type [1/2]

◆ eventStatus_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ inputs_type [1/2]

◆ inputs_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nParam_type [1/2]

◆ nParam_type [2/2]

◆ object_type [1/2]

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

◆ object_type [2/2]

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

◆ Param_type [1/2]

◆ Param_type [2/2]

◆ ParamList_type [1/2]

◆ ParamList_type [2/2]

◆ paramName_type [1/2]

◆ paramName_type [2/2]

◆ paramValue_type [1/2]

◆ paramValue_type [2/2]

◆ probability_type [1/2]

◆ probability_type [2/2]

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ statistics_type [1/2]

◆ statistics_type [2/2]

◆ string_2_type [1/2]

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

◆ string_2_type [2/2]

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

◆ time_type [1/2]

◆ time_type [2/2]

◆ timeAfter_type [1/2]

◆ timeAfter_type [2/2]

◆ timeBefore_type [1/2]

◆ timeBefore_type [2/2]

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Member Enumeration Documentation

◆ anonymous enum

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

◆ anonymous enum

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

◆ anonymous enum

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

◆ anonymous enum

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

Constructor & Destructor Documentation

◆ FrEvent() [1/10]

FrameCPP::Version_7::FrEvent::FrEvent ( )

◆ FrEvent() [2/10]

FrameCPP::Version_7::FrEvent::FrEvent ( const FrEvent eventData)

◆ FrEvent() [3/10]

FrameCPP::Version_7::FrEvent::FrEvent ( const std::string &  name,
const std::string &  comment,
const std::string &  inputs,
const GPSTime time,
const timeBefore_type  timeBefore,
const timeAfter_type  timeAfter,
const eventStatus_type  eventStatus,
const amplitude_type  amplitude,
const probability_type  prob,
const std::string &  statistics,
const ParamList_type parameters 
)

◆ FrEvent() [4/10]

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

◆ FrEvent() [5/10]

FrameCPP::Version_7::FrEvent::FrEvent ( istream_type Stream)
private

◆ FrEvent() [6/10]

FrameCPP::Version_7::FrEvent::FrEvent ( )

◆ FrEvent() [7/10]

FrameCPP::Version_7::FrEvent::FrEvent ( const FrEvent eventData)

◆ FrEvent() [8/10]

FrameCPP::Version_7::FrEvent::FrEvent ( const std::string &  name,
const std::string &  comment,
const std::string &  inputs,
const GPSTime time,
const timeBefore_type  timeBefore,
const timeAfter_type  timeAfter,
const eventStatus_type  eventStatus,
const amplitude_type  amplitude,
const probability_type  prob,
const std::string &  statistics,
const ParamList_type parameters 
)

◆ FrEvent() [9/10]

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

◆ FrEvent() [10/10]

FrameCPP::Version_7::FrEvent::FrEvent ( istream_type Stream)
private

Member Function Documentation

◆ Bytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_7::FrEvent::Bytes ( const Common::StreamBase Stream) const
inlinevirtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_7::FrEvent::Bytes ( const Common::StreamBase Stream) const
virtual

Return the number of bytes for this object.

Parameters
[in]StreamThe stream on which the object will be written or read.
Returns
The number of bytes required by this object for the specified stream.

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

◆ Clone() [1/2]

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

constructor - virtual copy constructor

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

◆ Clone() [2/2]

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

constructor - virtual copy constructor

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

◆ Create() [1/4]

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

◆ Create() [2/4]

FrEvent * FrameCPP::Version_7::FrEvent::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [3/4]

virtual FrEvent* FrameCPP::Version_7::FrEvent::Create ( istream_type Stream) const
virtual

constructor - virtual

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

◆ Create() [4/4]

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

◆ DataType() [1/4]

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

◆ DataType() [2/4]

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

◆ DataType() [3/4]

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

◆ DataType() [4/4]

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

◆ demote() [1/2]

FrEvent::demote_ret_type FrameCPP::Version_7::FrEvent::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_7::FrEvent::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

◆ DemoteObject() [1/2]

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

Down grade an object.

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

◆ DemoteObject() [2/2]

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

Down grade an object.

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

◆ GetAmplitude() [1/2]

FrEventStorage::amplitude_type FrEventStorage::GetAmplitude ( ) const
inlineinherited

◆ GetAmplitude() [2/2]

amplitude_type FrameCPP::Version_7::FrEventStorage::GetAmplitude ( ) const
inherited

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ GetComment() [1/2]

const FrEventStorage::comment_type & FrEventStorage::GetComment ( ) const
inlineinherited

◆ GetComment() [2/2]

const comment_type& FrameCPP::Version_7::FrEventStorage::GetComment ( ) const
inherited

◆ GetDescription() [1/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetDescription() [2/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

◆ GetEventStatus() [1/2]

FrEventStorage::eventStatus_type FrEventStorage::GetEventStatus ( ) const
inlineinherited

◆ GetEventStatus() [2/2]

eventStatus_type FrameCPP::Version_7::FrEventStorage::GetEventStatus ( ) const
inherited

◆ GetGTime() [1/2]

const FrEventStorage::time_type & FrEventStorage::GetGTime ( ) const
inlineinherited

◆ GetGTime() [2/2]

const time_type& FrameCPP::Version_7::FrEventStorage::GetGTime ( ) const
inherited

◆ GetInputs() [1/2]

const FrEventStorage::inputs_type & FrEventStorage::GetInputs ( ) const
inlineinherited

◆ GetInputs() [2/2]

const inputs_type& FrameCPP::Version_7::FrEventStorage::GetInputs ( ) const
inherited

◆ GetName() [1/2]

const FrEventStorage::name_type & FrEventStorage::GetName ( ) const
inlineinherited

◆ GetName() [2/2]

const name_type& FrameCPP::Version_7::FrEventStorage::GetName ( ) const
inherited

◆ GetNameSlow() [1/2]

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

◆ GetNameSlow() [2/2]

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

◆ GetParam() [1/4]

FrEventStorage::ParamList_type & FrEventStorage::GetParam ( )
inlineinherited

◆ GetParam() [2/4]

ParamList_type& FrameCPP::Version_7::FrEventStorage::GetParam ( )
inherited

◆ GetParam() [3/4]

const FrEventStorage::ParamList_type & FrEventStorage::GetParam ( ) const
inlineinherited

◆ GetParam() [4/4]

const ParamList_type& FrameCPP::Version_7::FrEventStorage::GetParam ( ) const
inherited

◆ GetProbability() [1/2]

FrEventStorage::probability_type FrEventStorage::GetProbability ( ) const
inlineinherited

◆ GetProbability() [2/2]

probability_type FrameCPP::Version_7::FrEventStorage::GetProbability ( ) const
inherited

◆ GetStatistics() [1/2]

const FrEventStorage::statistics_type & FrEventStorage::GetStatistics ( ) const
inlineinherited

◆ GetStatistics() [2/2]

const statistics_type& FrameCPP::Version_7::FrEventStorage::GetStatistics ( ) const
inherited

◆ GetTimeAfter() [1/2]

FrEventStorage::timeAfter_type FrEventStorage::GetTimeAfter ( ) const
inlineinherited

◆ GetTimeAfter() [2/2]

timeAfter_type FrameCPP::Version_7::FrEventStorage::GetTimeAfter ( ) const
inherited

◆ GetTimeBefore() [1/2]

FrEventStorage::timeBefore_type FrEventStorage::GetTimeBefore ( ) const
inlineinherited

◆ GetTimeBefore() [2/2]

timeBefore_type FrameCPP::Version_7::FrEventStorage::GetTimeBefore ( ) const
inherited

◆ Merge() [1/2]

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

◆ Merge() [2/2]

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

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_7::FrEvent::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

virtual const char* FrameCPP::Version_7::FrEvent::ObjectStructName ( ) const
virtual

Retrieve the class name of the object.

Returns
The name of the class associated with the object.

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

◆ operator==() [1/4]

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

comparison operator

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

◆ operator==() [2/4]

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

comparison operator

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

◆ operator==() [3/4]

bool FrameCPP::Version_7::FrEvent::operator== ( const FrEvent RHS) const
inline

comparison operator

◆ operator==() [4/4]

bool FrameCPP::Version_7::FrEvent::operator== ( const FrEvent RHS) const

comparison operator

◆ Promote() [1/2]

FrEvent::promote_ret_type FrameCPP::Version_7::FrEvent::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_7::FrEvent::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
static

◆ promote() [1/2]

FrEvent::promote_ret_type FrameCPP::Version_7::FrEvent::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_7::FrEvent::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

◆ PromoteObject() [1/5]

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

Upgrade an object.

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

◆ PromoteObject() [2/5]

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

Upgrade an object.

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

◆ PromoteObject() [3/5]

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

Upgrade an object.

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

◆ PromoteObject() [4/5]

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

Upgrade an object.

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

◆ PromoteObject() [5/5]

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

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_7::FrEvent::StructDescription ( )
static

◆ StructDescription() [2/2]

static const Common::Description* FrameCPP::Version_7::FrEvent::StructDescription ( )
static

◆ StructName() [1/2]

const char * FrameCPP::Version_7::FrEvent::StructName ( )
inlinestatic

◆ StructName() [2/2]

static const char* FrameCPP::Version_7::FrEvent::StructName ( )
static

◆ TOCQuery() [1/2]

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

◆ TOCQuery() [2/2]

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

◆ VerifyObject() [1/2]

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

◆ VerifyObject() [2/2]

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

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_7::FrEvent::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_7::FrEvent::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual

◆ Write() [1/2]

void FrameCPP::Version_7::FrEvent::Write ( ostream_type Stream) const
virtual

Write object to the stream.

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

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

◆ Write() [2/2]

virtual void FrameCPP::Version_7::FrEvent::Write ( ostream_type Stream) const
virtual

Write object to the stream.

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

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

◆ WriteNext() [1/2]

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

Write a next pointer to the parent to the stream.

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

◆ WriteNext() [2/2]

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

Write a next pointer to the parent to the stream.

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

Member Data Documentation

◆ m_class

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

Storage for the class identifier.

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

◆ m_data

data_type FrEventStorage::m_data
protectedinherited

◆ m_desc

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

Description for parent class.

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


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