ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_6::FrSimEvent Class Reference

#include <FrSimEvent.hh>

Inheritance diagram for FrameCPP::Version_6::FrSimEvent:
FrameCPP::Common::FrameSpec::Object FrameCPP::Version_6::FrSimEventNPS FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, 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 INT_2U nParam_type
 
typedef std::pair< STRING, REAL_4 > Param_type
 
typedef std::vector< Param_typeParamList_type
 
typedef
Common::SearchContainer< TData,&TData::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

 FrSimEvent ()
 
 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
 Return the number of bytes for this object. More...
 
virtual FrSimEventCreate (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...
 
FrSimEventMerge (const FrSimEvent &RHS)
 
bool operator== (const FrSimEvent &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 std::string & GetName () const
 
const std::string & GetComment () const
 
const std::string & GetInputs () const
 
const GPSTimeGetGTime () const
 
REAL_4 GetTimeBefore () const
 
REAL_4 GetTimeAfter () const
 
REAL_4 GetAmplitude () 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
 
refs_type m_refs
 

Member Typedef Documentation

template<typename TPTR_STRUCT , typename TData , typename TTable >
typedef data_type::const_iterator FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::const_iterator
inherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
typedef table_type::const_iterator FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::const_table_iterator
inherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
typedef Common::SearchContainer< TData, &TData::GetName > FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::data_type
inherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
typedef data_type::iterator FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::iterator
inherited
typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited
typedef std::pair< STRING, REAL_4 > FrameCPP::Version_6::FrSimEventNPS::Param_type
inherited
typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
typedef table_type::iterator FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::table_iterator
inherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
typedef Common::SearchContainer< TTable, &TTable::GetNameSlow > FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::table_type
inherited

Member Enumeration Documentation

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

FrameCPP::Version_6::FrSimEvent::FrSimEvent ( )
FrameCPP::Version_6::FrSimEvent::FrSimEvent ( const FrSimEvent eventData)
FrameCPP::Version_6::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 
)
FrameCPP::Version_6::FrSimEvent::FrSimEvent ( const Previous::FrSimEvent Source,
istream_type Stream 
)

Member Function Documentation

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

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited
FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const
virtualinherited
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.

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

constructor - virtual

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

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T *  Data)
staticinherited
template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T &  Data)
staticinherited
FrSimEvent::demote_ret_type FrameCPP::Version_6::FrSimEvent::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Down grade an object.

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

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.
REAL_4 FrameCPP::Version_6::FrSimEventNPS::GetAmplitude ( ) const
inlineinherited
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.
FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

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

const std::string& FrameCPP::Version_6::FrSimEventNPS::GetComment ( ) const
inlineinherited
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.

const GPSTime& FrameCPP::Version_6::FrSimEventNPS::GetGTime ( ) const
inlineinherited
const std::string& FrameCPP::Version_6::FrSimEventNPS::GetInputs ( ) const
inlineinherited
const std::string& FrameCPP::Version_6::FrSimEventNPS::GetName ( ) const
inlineinherited
const std::string & FrameCPP::Version_6::FrSimEvent::GetNameSlow ( ) const
const ParamList_type& FrameCPP::Version_6::FrSimEventNPS::GetParam ( ) const
inlineinherited
ParamList_type& FrameCPP::Version_6::FrSimEventNPS::GetParam ( )
inlineinherited
REAL_4 FrameCPP::Version_6::FrSimEventNPS::GetTimeAfter ( ) const
inlineinherited
REAL_4 FrameCPP::Version_6::FrSimEventNPS::GetTimeBefore ( ) const
inlineinherited
FrSimEvent & FrameCPP::Version_6::FrSimEvent::Merge ( const FrSimEvent RHS)
const char * FrameCPP::Version_6::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.

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

comparison operator

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

comparison operator

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

FrSimEvent::promote_ret_type FrameCPP::Version_6::FrSimEvent::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type Stream 
)
inlinestatic
FrSimEvent::promote_ret_type FrameCPP::Version_6::FrSimEvent::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type Stream 
) const
protectedvirtual

Upgrade an object.

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

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.
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.
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
template<typename TPTR_STRUCT , typename TData , typename TTable >
const data_type& FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::RefData ( ) const
inlineinherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
data_type& FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::RefData ( )
inlineinherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
const table_type& FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::RefTable ( ) const
inlineinherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
table_type& FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::RefTable ( )
inlineinherited
const Description * FrameCPP::Version_6::FrSimEvent::StructDescription ( )
static
const char * FrameCPP::Version_6::FrSimEvent::StructName ( )
inlinestatic
void FrameCPP::Common::TOCInfo::TOCQuery ( int  InfoClass,
  ... 
) const
inlineinherited
void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited
void FrameCPP::Version_6::FrSimEvent::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
protectedvirtual
void FrameCPP::Version_6::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.

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

data_type FrameCPP::Version_6::FrSimEventNPS::m_data
protectedinherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
refs_type FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::m_refs
protectedinherited
template<typename TPTR_STRUCT , typename TData , typename TTable >
const INT_2U FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >::MAX_REF = 2
staticinherited

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