ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
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::FrSimEvent Class Reference

#include <FrSimEvent.hh>

Inheritance diagram for FrameCPP::Version_7::FrSimEvent:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_7::FrSimEvent:
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 INT_2U nParam_type
 
typedef INT_2U nParam_type
 
typedef std::pair< STRING, REAL_8 > Param_type
 
typedef std::pair< STRING, REAL_8 > Param_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

 FrSimEvent ()
 Default constructor.
 
 FrSimEvent (const FrSimEvent &eventData)
 
 FrSimEvent (const std::string &name, const std::string &comment, const std::string &inputs, const GPSTime &time, const REAL_4 timeBefore, const REAL_4 timeAfter, const REAL_4 amplitude, const ParamList_type &parameters)
 
 FrSimEvent (const Previous::FrSimEvent &Source, istream_type *Stream)
 
const std::string & GetNameSlow () const
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrSimEventCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
FrSimEventMerge (const FrSimEvent &RHS)
 Merge with another FrSimEvent.
 
bool operator== (const FrSimEvent &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
 FrSimEvent ()
 Default constructor.
 
 FrSimEvent (const FrSimEvent &eventData)
 
 FrSimEvent (const std::string &name, const std::string &comment, const std::string &inputs, const GPSTime &time, const REAL_4 timeBefore, const REAL_4 timeAfter, const REAL_4 amplitude, const ParamList_type &parameters)
 
 FrSimEvent (const Previous::FrSimEvent &Source, istream_type *Stream)
 
const std::string & GetNameSlow () const
 
cmn_streamsize_type Bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrSimEventCreate (istream_type &Stream) const
 constructor - virtual
 
virtual const char * ObjectStructName () const
 Retrieve the class name of the object.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
FrSimEventMerge (const FrSimEvent &RHS)
 Merge with another FrSimEvent.
 
bool operator== (const FrSimEvent &RHS) const
 comparison operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 comparison operator
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectCreate () const
 constructor - virtual
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
void AppendComment (const std::string &Comment)
 
void AppendComment (const std::string &Comment)
 
const std::string & GetName () const
 
const std::string & GetName () const
 
const std::string & GetComment () const
 
const std::string & GetComment () const
 
const std::string & GetInputs () const
 
const std::string & GetInputs () const
 
const GPSTime & GetGTime () const
 
const GPSTime & GetGTime () const
 
REAL_4 GetTimeBefore () const
 
REAL_4 GetTimeBefore () const
 
REAL_4 GetTimeAfter () const
 
REAL_4 GetTimeAfter () const
 
REAL_4 GetAmplitude () const
 
REAL_4 GetAmplitude () 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.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object.
 
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.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
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.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

Protected Attributes

storage_type m_data
 

Private Member Functions

 FrSimEvent (istream_type &Stream)
 
 FrSimEvent (istream_type &Stream)
 

Private Attributes

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

Member Typedef Documentation

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ frame_spec_version_type [1/2]

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

typedef std::pair< STRING, REAL_8 > FrameCPP::Version_7::FrSimEventNPS::Param_type
inherited

◆ Param_type [2/2]

typedef std::pair< STRING, REAL_8 > FrameCPP::Version_7::FrSimEventNPS::Param_type
inherited

◆ ParamList_type [1/2]

◆ ParamList_type [2/2]

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

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

◆ 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

◆ FrSimEvent() [1/10]

FrameCPP::Version_7::FrSimEvent::FrSimEvent ( )

Default constructor.

◆ FrSimEvent() [2/10]

FrameCPP::Version_7::FrSimEvent::FrSimEvent ( const FrSimEvent eventData)

◆ FrSimEvent() [3/10]

FrameCPP::Version_7::FrSimEvent::FrSimEvent ( const std::string &  name,
const std::string &  comment,
const std::string &  inputs,
const GPSTime &  time,
const REAL_4  timeBefore,
const REAL_4  timeAfter,
const REAL_4  amplitude,
const ParamList_type parameters 
)

◆ FrSimEvent() [4/10]

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

◆ FrSimEvent() [5/10]

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

◆ FrSimEvent() [6/10]

FrameCPP::Version_7::FrSimEvent::FrSimEvent ( )

Default constructor.

◆ FrSimEvent() [7/10]

FrameCPP::Version_7::FrSimEvent::FrSimEvent ( const FrSimEvent eventData)

◆ FrSimEvent() [8/10]

FrSimEvent::FrSimEvent ( const std::string &  name,
const std::string &  comment,
const std::string &  inputs,
const GPSTime &  time,
const REAL_4  timeBefore,
const REAL_4  timeAfter,
const REAL_4  amplitude,
const ParamList_type parameters 
)

◆ FrSimEvent() [9/10]

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

◆ FrSimEvent() [10/10]

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

Member Function Documentation

◆ AppendComment() [1/2]

void FrSimEventNPS::AppendComment ( const std::string &  Comment)
inlineinherited

◆ AppendComment() [2/2]

void FrameCPP::Version_7::FrSimEventNPS::AppendComment ( const std::string &  Comment)
inherited

◆ Bytes() [1/2]

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

Number of bytes needed to write this structure.

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

◆ Bytes() [2/2]

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

Number of bytes needed to write this structure.

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

◆ Clone() [1/2]

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

◆ Clone() [2/2]

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

◆ Create() [1/4]

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

◆ Create() [2/4]

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

constructor - virtual

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

◆ Create() [3/4]

virtual FrSimEvent * FrameCPP::Version_7::FrSimEvent::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]

FrSimEvent::demote_ret_type FrameCPP::Version_7::FrSimEvent::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::FrSimEvent::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]

REAL_4 FrameCPP::Version_7::FrSimEventNPS::GetAmplitude ( ) const
inlineinherited

◆ GetAmplitude() [2/2]

REAL_4 FrameCPP::Version_7::FrSimEventNPS::GetAmplitude ( ) const
inlineinherited

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [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 std::string & FrameCPP::Version_7::FrSimEventNPS::GetComment ( ) const
inlineinherited

◆ GetComment() [2/2]

const std::string & FrameCPP::Version_7::FrSimEventNPS::GetComment ( ) const
inlineinherited

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

◆ GetGTime() [1/2]

const GPSTime & FrameCPP::Version_7::FrSimEventNPS::GetGTime ( ) const
inlineinherited

◆ GetGTime() [2/2]

const GPSTime & FrameCPP::Version_7::FrSimEventNPS::GetGTime ( ) const
inlineinherited

◆ GetInputs() [1/2]

const std::string & FrameCPP::Version_7::FrSimEventNPS::GetInputs ( ) const
inlineinherited

◆ GetInputs() [2/2]

const std::string & FrameCPP::Version_7::FrSimEventNPS::GetInputs ( ) const
inlineinherited

◆ GetName() [1/2]

const std::string & FrameCPP::Version_7::FrSimEventNPS::GetName ( ) const
inlineinherited

◆ GetName() [2/2]

const std::string & FrameCPP::Version_7::FrSimEventNPS::GetName ( ) const
inlineinherited

◆ GetNameSlow() [1/2]

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

◆ GetNameSlow() [2/2]

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

◆ GetParam() [1/4]

ParamList_type & FrameCPP::Version_7::FrSimEventNPS::GetParam ( )
inlineinherited

◆ GetParam() [2/4]

ParamList_type & FrameCPP::Version_7::FrSimEventNPS::GetParam ( )
inlineinherited

◆ GetParam() [3/4]

const ParamList_type & FrameCPP::Version_7::FrSimEventNPS::GetParam ( ) const
inlineinherited

◆ GetParam() [4/4]

const ParamList_type & FrameCPP::Version_7::FrSimEventNPS::GetParam ( ) const
inlineinherited

◆ GetTimeAfter() [1/2]

REAL_4 FrameCPP::Version_7::FrSimEventNPS::GetTimeAfter ( ) const
inlineinherited

◆ GetTimeAfter() [2/2]

REAL_4 FrameCPP::Version_7::FrSimEventNPS::GetTimeAfter ( ) const
inlineinherited

◆ GetTimeBefore() [1/2]

REAL_4 FrameCPP::Version_7::FrSimEventNPS::GetTimeBefore ( ) const
inlineinherited

◆ GetTimeBefore() [2/2]

REAL_4 FrameCPP::Version_7::FrSimEventNPS::GetTimeBefore ( ) const
inlineinherited

◆ Merge() [1/2]

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

Merge with another FrSimEvent.

◆ Merge() [2/2]

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

Merge with another FrSimEvent.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_7::FrSimEvent::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::FrSimEvent::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::FrSimEvent::operator== ( const Common::FrameSpec::Object Obj) const
virtual

comparison operator

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

◆ operator==() [2/4]

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

comparison operator

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

◆ operator==() [3/4]

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

comparison operator

◆ operator==() [4/4]

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

comparison operator

◆ Promote() [1/2]

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

◆ Promote() [2/2]

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

◆ promote() [1/2]

FrSimEvent::promote_ret_type FrameCPP::Version_7::FrSimEvent::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::FrSimEvent::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::FrSimEvent::StructDescription ( )
static

◆ StructDescription() [2/2]

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

◆ StructName() [1/2]

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

◆ StructName() [2/2]

static const char * FrameCPP::Version_7::FrSimEvent::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]

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

◆ vTOCQuery() [2/2]

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

◆ Write() [1/2]

void FrameCPP::Version_7::FrSimEvent::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::FrSimEvent::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

storage_type FrSimEventNPS::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: