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

#include <FrEvent.hh>

Inheritance diagram for FrameCPP::Version_6::FrEvent:
FrameCPP::Common::FrameSpec::Object FrameCPP::Version_6::FrEventStorage FrameCPP::Version_6::FrEventRefsT< TVect, TTable > FrameCPP::Common::TOCInfo FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef FR_EVENT_NAME_TYPE name_type
 
typedef FR_EVENT_COMMENT_TYPE comment_type
 
typedef FR_EVENT_INPUTS_TYPE inputs_type
 
typedef FR_EVENT_TIME_TYPE time_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 FR_EVENT_STATISTICS_TYPE statistics_type
 
typedef FR_EVENT_PARAM_NAME_TYPE paramName_type
 
typedef FR_EVENT_PARAM_VALUE_TYPE paramValue_type
 
typedef FR_EVENT_N_PARAM_TYPE nParam_type
 
typedef std::pair< paramName_type, paramValue_typeParam_type
 
typedef std::vector< Param_typeParamList_type
 
typedef Common::SearchContainer< TVect, &TVect::GetName > data_type
 
typedef data_type::iterator iterator
 
typedef data_type::const_iterator const_iterator
 
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > table_type
 
typedef table_type::iterator table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
enum  {
  DT_CHAR_PTR, DT_STRING_2, DT_INT_2S, DT_INT_2U,
  DT_INT_4S, DT_INT_4U, DT_INT_8S, DT_INT_8U,
  DT_REAL_4, DT_REAL_8
}
 
enum  {
  IC_EOQ, IC_AMPLITUDE, IC_CHANNEL_ID, IC_DATA_QUALITY,
  IC_DATA_VALID, IC_DETECTOR, IC_DETECTOR_PREFIX, IC_DT,
  IC_END, IC_FRAME, IC_GROUP_ID, IC_GTIME_N,
  IC_GTIME_S, IC_ID, IC_LOCAL_TIME, IC_NAME,
  IC_RUN, IC_START, IC_ULEAP_S, IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrEvent ()
 Default constructor. More...
 
 FrEvent (const FrEvent &Source)
 
 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 prob, const statistics_type &statistics, const ParamList_type &parameters)
 
 FrEvent (const Previous::FrTrigData &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...
 
const Description * GetDescription () 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...
 
virtual ObjectCreate () const
 constructor - virtual More...
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual 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...
 
const name_typeGetName () const
 
const comment_typeGetComment () const
 
const inputs_typeGetInputs () const
 
const time_typeGetGTime () const
 
timeBefore_type GetTimeBefore () const
 
timeAfter_type GetTimeAfter () const
 
eventStatus_type GetEventStatus () const
 
amplitude_type GetAmplitude () const
 
probability_type GetProbability () const
 
const statistics_typeGetStatistics () const
 
const ParamList_typeGetParam () const
 
ParamList_typeGetParam ()
 
const data_typeRefData () const
 
data_typeRefData ()
 
const table_typeRefTable () const
 
table_typeRefTable ()
 
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 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...
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 

Static Public Attributes

static const INT_2U MAX_REF = 2
 

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 class_type getClass () const
 Retrieve the class identifier. More...
 

Protected Attributes

data_type m_data
 
ref_type m_refs
 

Member Typedef Documentation

◆ amplitude_type

◆ comment_type

◆ const_iterator

template<typename TVect , typename TTable >
typedef data_type::const_iterator FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::const_iterator
inherited

◆ const_table_iterator

template<typename TVect , typename TTable >
typedef table_type::const_iterator FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::const_table_iterator
inherited

◆ data_type

template<typename TVect , typename TTable >
typedef Common::SearchContainer< TVect, &TVect::GetName > FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::data_type
inherited

◆ demote_arg_type

◆ demote_ret_type

◆ eventStatus_type

◆ frame_spec_version_type

◆ inputs_type

◆ iterator

template<typename TVect , typename TTable >
typedef data_type::iterator FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::iterator
inherited

◆ name_type

◆ nParam_type

◆ object_type

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

◆ Param_type

◆ ParamList_type

◆ paramName_type

◆ paramValue_type

◆ probability_type

◆ promote_arg_type

◆ promote_ret_type

◆ statistics_type

◆ string_2_type

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

◆ table_iterator

template<typename TVect , typename TTable >
typedef table_type::iterator FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::table_iterator
inherited

◆ table_type

template<typename TVect , typename TTable >
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::table_type
inherited

◆ time_type

◆ timeAfter_type

◆ timeBefore_type

◆ unique_object_type

Member Enumeration Documentation

◆ anonymous enum

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

◆ anonymous enum

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

Constructor & Destructor Documentation

◆ FrEvent() [1/4]

FrameCPP::Version_6::FrEvent::FrEvent ( )

Default constructor.

Construct an object using defaults.

◆ FrEvent() [2/4]

FrameCPP::Version_6::FrEvent::FrEvent ( const FrEvent Source)

◆ FrEvent() [3/4]

FrameCPP::Version_6::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  prob,
const statistics_type statistics,
const ParamList_type parameters 
)

◆ FrEvent() [4/4]

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

Member Function Documentation

◆ Bytes()

FrameCPP::cmn_streamsize_type FrameCPP::Version_6::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.

◆ Clone()

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

◆ Create() [1/3]

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

◆ Create() [2/3]

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

constructor - virtual

Reimplemented in FrameCPP::Version_8::FrHeader, and FrameCPP::Version_3::FrHeader.

◆ Create() [3/3]

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

constructor - virtual

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

◆ DataType() [1/2]

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

◆ DataType() [2/2]

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

◆ demote()

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

Down grade an object.

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

◆ DemoteObject()

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.

◆ GetAmplitude()

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

◆ GetClass()

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

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

Retrieve the class identifier.

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

◆ GetComment()

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

◆ GetDescription()

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.

◆ GetEventStatus()

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

◆ GetGTime()

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

◆ GetInputs()

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

◆ GetName()

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

◆ GetNameSlow()

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

◆ GetParam() [1/2]

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

◆ GetParam() [2/2]

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

◆ GetProbability()

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

◆ GetStatistics()

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

◆ GetTimeAfter()

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

◆ GetTimeBefore()

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

◆ Merge()

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

◆ ObjectStructName()

const char * FrameCPP::Version_6::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/2]

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

comparison operator

◆ operator==() [2/2]

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

comparison operator

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

◆ Promote()

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

◆ promote()

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

Upgrade an object.

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

◆ PromoteObject() [1/3]

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

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

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

◆ RefData() [1/2]

template<typename TVect , typename TTable >
const data_type& FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::RefData ( ) const
inlineinherited

◆ RefData() [2/2]

template<typename TVect , typename TTable >
data_type& FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::RefData ( )
inlineinherited

◆ RefTable() [1/2]

template<typename TVect , typename TTable >
const table_type& FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::RefTable ( ) const
inlineinherited

◆ RefTable() [2/2]

template<typename TVect , typename TTable >
table_type& FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::RefTable ( )
inlineinherited

◆ StructDescription()

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

◆ StructName()

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

◆ TOCQuery()

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

◆ VerifyObject()

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

◆ vTOCQuery()

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

◆ Write()

void FrameCPP::Version_6::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()

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_data

data_type FrameCPP::Version_6::FrEventStorage::m_data
protectedinherited

◆ m_refs

template<typename TVect , typename TTable >
ref_type FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::m_refs
protectedinherited

◆ MAX_REF

template<typename TVect , typename TTable >
const INT_2U FrameCPP::Version_6::FrEventRefsT< TVect, TTable >::MAX_REF = 2
staticinherited

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