ldas-tools-framecpp
2.7.0
|
Event data structure definition. More...
#include <FrEvent.hh>
Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrEventStorage, FrEventRefsT< FrVect, FrTable >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrEventStorage, FrEventRefsT< FrVect, FrTable >, and FrameCPP::Common::TOCInfo.
Public Member Functions | |
FrEvent () | |
Default constructor. | |
FrEvent (const FrEvent &eventData) | |
Copy constructor. More... | |
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 ¶meters) | |
Constructor. More... | |
FrEvent (const Previous::FrEvent &Source, istream_type *Stream) | |
Upconvert constructor. More... | |
const std::string & | GetNameSlow () const |
Retrieve the name of the event. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
FrEvent & | Merge (const FrEvent &RHS) |
Merge with another FrEvent. More... | |
bool | operator== (const FrEvent &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
equality operator for abstract data type More... | |
FrEvent () | |
Default constructor. | |
FrEvent (const FrEvent &eventData) | |
Copy constructor. More... | |
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 ¶meters) | |
Constructor. More... | |
FrEvent (const Previous::FrEvent &Source, istream_type *Stream) | |
Upconvert constructor. More... | |
const std::string & | GetNameSlow () const |
Retrieve the name of the event. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
FrEvent & | Merge (const FrEvent &RHS) |
Merge with another FrEvent. More... | |
bool | operator== (const FrEvent &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
equality operator for abstract data type More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
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 promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
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, 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... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
FrEvent * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
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... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
FrEvent * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
virtual void | pWrite (ostream_type &Stream) const=0 |
Write the structure to the stream. More... | |
Event data structure definition.
FrameCPP::Version_8::FrEvent::FrEvent | ( | const FrEvent & | eventData | ) |
Copy constructor.
[in] | eventData | Source of the event data. |
FrameCPP::Version_8::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 | ||
) |
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] | eventStatus | Defined by event search algorithm. |
[in] | amplitude | Continuous output amplitude returned by event. |
[in] | prob | Likelihood estimate of event. |
[in] | statistics | Statistical description of event. |
[in] | parameters | Array of additional event parameters. |
FrameCPP::Version_8::FrEvent::FrEvent | ( | const Previous::FrEvent & | Source, |
istream_type * | Stream | ||
) |
Upconvert constructor.
[in] | Source | An instance of a similiar object from a previous version of the frame specification. |
[in] | Stream | The stream from which the origional object was read. |
FrameCPP::Version_8::FrEvent::FrEvent | ( | const FrEvent & | eventData | ) |
Copy constructor.
[in] | eventData | Source of the event data. |
FrameCPP::Version_8::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 | ||
) |
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] | eventStatus | Defined by event search algorithm. |
[in] | amplitude | Continuous output amplitude returned by event. |
[in] | prob | Likelihood estimate of event. |
[in] | statistics | Statistical description of event. |
[in] | parameters | Array of additional event parameters. |
FrameCPP::Version_8::FrEvent::FrEvent | ( | const Previous::FrEvent & | Source, |
istream_type * | Stream | ||
) |
Upconvert constructor.
[in] | Source | An instance of a similiar object from a previous version of the frame specification. |
[in] | Stream | The stream from which the origional object was read. |
|
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. |
|
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. |
|
protectedvirtual |
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. |
|
protectedvirtual |
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. |
const std::string & FrameCPP::Version_8::FrEvent::GetNameSlow | ( | ) | const |
Retrieve the name of the event.
const std::string& FrameCPP::Version_8::FrEvent::GetNameSlow | ( | ) | const |
Retrieve the name of the event.
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | Obj | The object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrEndOfFrame object to be compared. |
bool FrameCPP::Version_8::FrEvent::operator== | ( | const FrEvent & | RHS | ) | const |
equality operator
[in] | RHS | The FrEndOfFrame object to be compared. |
|
inlineprotectedvirtual |
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, checksum_type >.
|
protectedvirtual |
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, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
inlinestatic |
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. |
|
static |
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. |
|
protectedvirtual |
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. |
|
protectedvirtual |
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. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedpure virtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrRawData.
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |