ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrSimEvent Class Reference

Event data. More...

#include <FrSimEvent.hh>

Public Member Functions

 FrSimEvent ()
 Default constructor.
 
 FrSimEvent (const FrSimEvent &Source)
 Copy Constructor.
 
 FrSimEvent (const name_type &name, const comment_type &comment, const inputs_type &inputs, const GPSTime &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const amplitude_type amplitude, const ParamList_type &parameters)
 Constructor.
 
 FrSimEvent (const Previous::FrSimEvent &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const std::string & GetNameSlow () const
 Retrieve the name of event.
 
FrSimEventMerge (const FrSimEvent &RHS)
 Merge with another FrSimEvent.
 
bool operator== (const FrSimEvent &RHS) const
 inequality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrSimEvent ()
 Default constructor.
 
 FrSimEvent (const FrSimEvent &Source)
 Copy Constructor.
 
 FrSimEvent (const name_type &name, const comment_type &comment, const inputs_type &inputs, const GPSTime &time, const timeBefore_type timeBefore, const timeAfter_type timeAfter, const amplitude_type amplitude, const ParamList_type &parameters)
 Constructor.
 
 FrSimEvent (const Previous::FrSimEvent &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const std::string & GetNameSlow () const
 Retrieve the name of event.
 
FrSimEventMerge (const FrSimEvent &RHS)
 Merge with another FrSimEvent.
 
bool operator== (const FrSimEvent &RHS) const
 inequality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::Description * GetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual const Common::Description * GetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual streamsize_type Bytes (const StreamBase &Stream) const
 Return the number of bytes for this object.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

static const Common::Description * StructDescription ()
 The description of structure.
 
static const Common::Description * StructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
 Promote previous version of object to this version.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 

Protected Attributes

name_type name
 Name of event.
 
comment_type comment
 Descriptor of event.
 
inputs_type inputs
 Input channels and filter parameters to event process.
 
GTime_type GTime
 
timeBefore_type timeBefore
 Signal duration before (GTimeS.GTimeN)(seconds)
 
timeAfter_type timeAfter
 Signal duration after (GTimeS.GTimeN)(seconds)
 
amplitude_type amplitude
 Continuous output amplitude returned by event.
 
ParamList_type Params
 Array of parameters.
 
data_type data
 Container of additional event results.
 
table_type table
 Table containing additional event information.
 

Detailed Description

Event data.

Constructor & Destructor Documentation

◆ FrSimEvent() [1/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( )

Default constructor.

Returns
A new instance of this object.

◆ FrSimEvent() [2/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( const FrSimEvent & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrSimEvent() [3/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( const name_type & name,
const comment_type & comment,
const inputs_type & inputs,
const GPSTime & time,
const timeBefore_type timeBefore,
const timeAfter_type timeAfter,
const amplitude_type amplitude,
const ParamList_type & parameters )

Constructor.

Parameters
[in]nameName of event.
[in]commentDescriptor of event.
[in]inputsInput channels and filter parameters to event process.
[in]timeGPS time corresponding to reference value of event.
[in]timeBeforeSignal duration before time.
[in]timeAfterSignal duration after time.
[in]amplitudeContinuous output amplitude returned by event.
[in]parametersArray of additional event parameters.
Returns
A new instance of this object.

◆ FrSimEvent() [4/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( const Previous::FrSimEvent & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrSimEvent structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrSimEvent structure was read.
Returns
A new instance of the object.

◆ FrSimEvent() [5/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( )

Default constructor.

Returns
A new instance of this object.

◆ FrSimEvent() [6/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( const FrSimEvent & Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrSimEvent() [7/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( const name_type & name,
const comment_type & comment,
const inputs_type & inputs,
const GPSTime & time,
const timeBefore_type timeBefore,
const timeAfter_type timeAfter,
const amplitude_type amplitude,
const ParamList_type & parameters )

Constructor.

Parameters
[in]nameName of event.
[in]commentDescriptor of event.
[in]inputsInput channels and filter parameters to event process.
[in]timeGPS time corresponding to reference value of event.
[in]timeBeforeSignal duration before time.
[in]timeAfterSignal duration after time.
[in]amplitudeContinuous output amplitude returned by event.
[in]parametersArray of additional event parameters.
Returns
A new instance of this object.

◆ FrSimEvent() [8/8]

FrameCPP::Version_9::FrSimEvent::FrSimEvent ( const Previous::FrSimEvent & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrSimEvent structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrSimEvent structure was read.
Returns
A new instance of the object.

Member Function Documentation

◆ Bytes() [1/2]

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

Return the number of bytes for this object.

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

◆ Bytes() [2/2]

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

Return the number of bytes for this object.

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

◆ Create() [1/2]

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

Virtual constructor.

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

◆ Create() [2/2]

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

Virtual constructor.

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

◆ demote() [1/2]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Down grade an object.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ GetDescription() [1/2]

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetDescription() [2/2]

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetNameSlow() [1/2]

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

Retrieve the name of event.

Returns
The name of event.

◆ GetNameSlow() [2/2]

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

Retrieve the name of event.

Returns
The name of event.

◆ Merge() [1/2]

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

Merge with another FrSimEvent.

Parameters
[in]RHSThe source of the information to append to this FrSimEvent structure.
Returns
A reference to this object

◆ Merge() [2/2]

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

Merge with another FrSimEvent.

Parameters
[in]RHSThe source of the information to append to this FrSimEvent structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

template<typename T >
virtual const char * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ ObjectStructName() [2/2]

template<typename T >
virtual const char * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/4]

virtual bool FrameCPP::Version_9::FrSimEvent::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

virtual bool FrameCPP::Version_9::FrSimEvent::operator== ( const Common::FrameSpec::Object & RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [3/4]

bool FrameCPP::Version_9::FrSimEvent::operator== ( const FrSimEvent & RHS) const
inline

inequality operator

Parameters
[in]RHSThe FrSimEvent object to be compared.
Returns
The value true is returned if this object is not equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_9::FrSimEvent::operator== ( const FrSimEvent & RHS) const

inequality operator

Parameters
[in]RHSThe FrSimEvent object to be compared.
Returns
The value true is returned if this object is not equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ pBytes() [2/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedinherited

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

◆ pCreate() [1/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

◆ pCreate() [2/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

◆ Promote() [1/2]

template<typename T >
ClassicIO< T >::promote_ret_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
staticinherited

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrSimEvent based on Obj

◆ Promote() [2/2]

template<typename T >
static promote_ret_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
staticinherited

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrSimEvent based on Obj

◆ promote() [1/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ promote() [2/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ pWrite() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ pWrite() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

◆ StructDescription() [1/2]

template<typename T >
static const Common::Description * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

template<typename T >
static const Common::Description * FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ vTOCQuery() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

◆ vTOCQuery() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Member Data Documentation

◆ GTime

GTime_type FrameCPP::Version_9::FrSimEventImpl::Data::GTime
protectedinherited

GPS time corresponding to reference value of event, as defined by the search algorithm.


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