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 ¶meters) | |
Constructor. | |
FrSimEvent (const Previous::FrSimEvent &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
const std::string & | GetNameSlow () const |
Retrieve the name of event. | |
FrSimEvent & | Merge (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 ¶meters) | |
Constructor. | |
FrSimEvent (const Previous::FrSimEvent &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
const std::string & | GetNameSlow () const |
Retrieve the name of event. | |
FrSimEvent & | Merge (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. | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
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_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (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. | |
void | AppendComment (const comment_type &Comment) |
name_type const & | GetName () const |
comment_type const & | GetComment () const |
inputs_type const & | GetInputs () const |
GTime_type const & | GetGTime () const |
timeBefore_type | GetTimeBefore () const |
timeAfter_type | GetTimeAfter () const |
amplitude_type | GetAmplitude () const |
ParamList_type const & | GetParam () const |
ParamList_type & | GetParam () |
const data_type & | RefData () const |
data_type & | RefData () |
const table_type & | RefTable () const |
table_type & | RefTable () |
bool | operator== (Data const &RHS) const |
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. | |
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) |
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. | |
static constexpr unsigned int | GetMaxRef () |
static struct_name_type | FrameSpecName () |
static struct_name_type | StructName () |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. | |
Static Public Attributes | |
static struct_name_type | struct_name |
static struct_desc_type | struct_desc |
static struct_id_type | struct_id |
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_type * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | pCreate (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. | |
Static Protected Attributes | |
static constexpr unsigned int | MAX_REF { 2 } |
Private Types | |
typedef STRING | io_name_type |
typedef STRING | io_name_type |
typedef STRING | io_comment_type |
typedef STRING | io_comment_type |
typedef STRING | io_inputs_type |
typedef STRING | io_inputs_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
Private Attributes | |
ChecksumType | m_chkSum |
Structure checksum. | |
Event data.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef GTime_type FrameCPP::Version_9::FrSimEvent::time_type |
typedef GTime_type FrameCPP::Version_9::FrSimEvent::time_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrameCPP::Version_9::FrSimEvent::FrSimEvent | ( | ) |
Default constructor.
FrameCPP::Version_9::FrSimEvent::FrSimEvent | ( | const FrSimEvent & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
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.
[in] | name | Name of event. |
[in] | comment | Descriptor of event. |
[in] | inputs | Input channels and filter parameters to event process. |
[in] | time | GPS time corresponding to reference value of event. |
[in] | timeBefore | Signal duration before time. |
[in] | timeAfter | Signal duration after time. |
[in] | amplitude | Continuous output amplitude returned by event. |
[in] | parameters | Array of additional event parameters. |
FrameCPP::Version_9::FrSimEvent::FrSimEvent | ( | const Previous::FrSimEvent & | Source, |
stream_base_type * | Stream ) |
Promotion Constructor.
[in] | Source | An FrSimEvent structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrSimEvent structure was read. |
FrameCPP::Version_9::FrSimEvent::FrSimEvent | ( | ) |
Default constructor.
FrameCPP::Version_9::FrSimEvent::FrSimEvent | ( | const FrSimEvent & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
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.
[in] | name | Name of event. |
[in] | comment | Descriptor of event. |
[in] | inputs | Input channels and filter parameters to event process. |
[in] | time | GPS time corresponding to reference value of event. |
[in] | timeBefore | Signal duration before time. |
[in] | timeAfter | Signal duration after time. |
[in] | amplitude | Continuous output amplitude returned by event. |
[in] | parameters | Array of additional event parameters. |
FrameCPP::Version_9::FrSimEvent::FrSimEvent | ( | const Previous::FrSimEvent & | Source, |
stream_base_type * | Stream ) |
Promotion Constructor.
[in] | Source | An FrSimEvent structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrSimEvent structure was read. |
|
inlineinherited |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inlineprotectedvirtualinherited |
Down grade an object.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Down grade an object.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinevirtualinherited |
The data structure description.
|
inlinevirtualinherited |
The data structure description.
|
inlineinherited |
|
inlineinherited |
|
inlinestaticconstexprinherited |
|
inlineinherited |
const std::string & FrameCPP::Version_9::FrSimEvent::GetNameSlow | ( | ) | const |
Retrieve the name of event.
const std::string & FrameCPP::Version_9::FrSimEvent::GetNameSlow | ( | ) | const |
Retrieve the name of event.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
FrSimEvent & FrameCPP::Version_9::FrSimEvent::Merge | ( | const FrSimEvent & | RHS | ) |
Merge with another FrSimEvent.
[in] | RHS | The source of the information to append to this FrSimEvent structure. |
FrSimEvent & FrameCPP::Version_9::FrSimEvent::Merge | ( | const FrSimEvent & | RHS | ) |
Merge with another FrSimEvent.
[in] | RHS | The source of the information to append to this FrSimEvent structure. |
|
inlinevirtualinherited |
The name structure name of this object.
|
inlinevirtualinherited |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
inline |
inequality operator
[in] | RHS | The FrSimEvent object to be compared. |
bool FrameCPP::Version_9::FrSimEvent::operator== | ( | const FrSimEvent & | RHS | ) | const |
inequality operator
[in] | RHS | The FrSimEvent object to be compared. |
|
inlineinherited |
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
staticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
staticinherited |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlineprotectedvirtualinherited |
Upgrade an object.
[in] | Target | The version of the frame specification to promote too. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Upgrade an object.
[in] | Target | The version of the frame specification to promote too. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
|
inlineinherited |
|
inherited |
|
inlineprotectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
inlineprotectedvirtualinherited |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
protectedinherited |
Continuous output amplitude returned by event.
|
protectedinherited |
Descriptor of event.
|
protectedinherited |
Container of additional event results.
|
protectedinherited |
GPS time corresponding to reference value of event, as defined by the search algorithm.
|
protectedinherited |
Input channels and filter parameters to event process.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
staticconstexprprotectedinherited |
|
protectedinherited |
Name of event.
|
protectedinherited |
Array of parameters.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
protectedinherited |
Table containing additional event information.
|
protectedinherited |
Signal duration after (GTimeS.GTimeN)(seconds)
|
protectedinherited |
Signal duration before (GTimeS.GTimeN)(seconds)