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.
|
| FrEvent () |
| Default constructor.
|
|
| FrEvent (const FrEvent &eventData) |
| Copy constructor.
|
|
| 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.
|
|
| FrEvent (const Previous::FrEvent &Source, istream_type *Stream) |
| Upconvert constructor.
|
|
const std::string & | GetNameSlow () const |
| Retrieve the name of the event.
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object.
|
|
FrEvent & | Merge (const FrEvent &RHS) |
| Merge with another FrEvent.
|
|
bool | operator== (const FrEvent &RHS) const |
| equality operator
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| equality operator for abstract data type
|
|
| FrEvent () |
| Default constructor.
|
|
| FrEvent (const FrEvent &eventData) |
| Copy constructor.
|
|
| 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.
|
|
| FrEvent (const Previous::FrEvent &Source, istream_type *Stream) |
| Upconvert constructor.
|
|
const std::string & | GetNameSlow () const |
| Retrieve the name of the event.
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object.
|
|
FrEvent & | Merge (const FrEvent &RHS) |
| Merge with another FrEvent.
|
|
bool | operator== (const FrEvent &RHS) const |
| equality operator
|
|
virtual bool | operator== (const Common::FrameSpec::Object &Obj) const |
| equality operator for abstract data type
|
|
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.
|
|
|
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
| Promote previous version of object to this version.
|
|
static const char * | StructName () |
| The name structure name of this object.
|
|
static const Common::Description * | StructDescription () |
| The description of structure.
|
|
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
| Promote previous version of object to this version.
|
|
static const char * | StructName () |
| The name structure name of this object.
|
|
static const Common::Description * | StructDescription () |
| The description of structure.
|
|
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.
|
|
|
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.
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
FrEvent * | pCreate (istream_type &Stream) const |
| Virtual constructor.
|
|
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 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.
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure.
|
|
FrEvent * | pCreate (istream_type &Stream) const |
| Virtual constructor.
|
|
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 | pWrite (ostream_type &Stream) const=0 |
| Write the structure to the stream.
|
|
Event data structure definition.
◆ FrEvent() [1/6]
FrameCPP::Version_8::FrEvent::FrEvent |
( |
const FrEvent & | eventData | ) |
|
Copy constructor.
- Parameters
-
[in] | eventData | Source of the event data. |
- Returns
- A new instance of this object.
◆ FrEvent() [2/6]
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.
- Parameters
-
[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. |
- Returns
- A new instance of this object.
◆ FrEvent() [3/6]
FrameCPP::Version_8::FrEvent::FrEvent |
( |
const Previous::FrEvent & | Source, |
|
|
istream_type * | Stream ) |
Upconvert constructor.
- Parameters
-
[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. |
- Returns
- A new instance of this object.
◆ FrEvent() [4/6]
FrameCPP::Version_8::FrEvent::FrEvent |
( |
const FrEvent & | eventData | ) |
|
Copy constructor.
- Parameters
-
[in] | eventData | Source of the event data. |
- Returns
- A new instance of this object.
◆ FrEvent() [5/6]
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.
- Parameters
-
[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. |
- Returns
- A new instance of this object.
◆ FrEvent() [6/6]
FrameCPP::Version_8::FrEvent::FrEvent |
( |
const Previous::FrEvent & | Source, |
|
|
istream_type * | Stream ) |
Upconvert constructor.
- Parameters
-
[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. |
- Returns
- A new instance of this object.
◆ Bytes() [1/2]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream 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]
Return the number of bytes for this object.
- Parameters
-
[in] | Stream | Stream 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 constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ Create() [2/2]
Virtual constructor.
- Parameters
-
[in] | Stream | The input stream from where the object is being read. |
- Returns
- Return pointer to the newly allocated resource.
◆ demote() [1/2]
FrEvent::demote_ret_type FrameCPP::Version_8::FrEvent::demote |
( |
INT_2U | Target, |
|
|
demote_arg_type | Obj, |
|
|
istream_type * | Stream ) const |
|
protectedvirtual |
Down grade an object.
- Parameters
-
[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. |
- Returns
- An object of the previous generation.
◆ demote() [2/2]
virtual demote_ret_type FrameCPP::Version_8::FrEvent::demote |
( |
INT_2U | Target, |
|
|
demote_arg_type | Obj, |
|
|
istream_type * | Stream ) const |
|
protectedvirtual |
Down grade an object.
- Parameters
-
[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. |
- Returns
- An object of the previous generation.
◆ GetNameSlow() [1/2]
const std::string & FrameCPP::Version_8::FrEvent::GetNameSlow |
( |
| ) |
const |
Retrieve the name of the event.
- Returns
- A name of the event via non-inlined function
◆ GetNameSlow() [2/2]
const std::string & FrameCPP::Version_8::FrEvent::GetNameSlow |
( |
| ) |
const |
Retrieve the name of the event.
- Returns
- A name of the event via non-inlined function
◆ Merge() [1/2]
Merge with another FrEvent.
- Parameters
-
[in] | RHS | FrEvent information to incorperate into this object. |
◆ Merge() [2/2]
Merge with another FrEvent.
- Parameters
-
[in] | RHS | FrEvent information to incorperate into this object. |
◆ ObjectStructName() [1/2]
const char * FrameCPP::Version_8::FrEvent::ObjectStructName |
( |
| ) |
const |
|
virtual |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ ObjectStructName() [2/2]
virtual const char * FrameCPP::Version_8::FrEvent::ObjectStructName |
( |
| ) |
const |
|
virtual |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ operator==() [1/4]
equality operator for abstract data type
- Parameters
-
[in] | Obj | The object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [2/4]
equality operator for abstract data type
- Parameters
-
[in] | Obj | The 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_8::FrEvent::operator== |
( |
const FrEvent & | RHS | ) |
const |
|
inline |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [4/4]
bool FrameCPP::Version_8::FrEvent::operator== |
( |
const FrEvent & | RHS | ) |
const |
equality operator
- Parameters
-
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ pBytes() [1/2]
FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrEvent::pBytes |
( |
const Common::StreamBase & | Stream | ) |
const |
|
inlineprotectedvirtual |
◆ pBytes() [2/2]
cmn_streamsize_type FrameCPP::Version_8::FrEvent::pBytes |
( |
const Common::StreamBase & | Stream | ) |
const |
|
protectedvirtual |
◆ pCreate() [1/2]
FrEvent * FrameCPP::Version_8::FrEvent::pCreate |
( |
istream_type & | Stream | ) |
const |
|
protectedvirtual |
◆ pCreate() [2/2]
FrEvent * FrameCPP::Version_8::FrEvent::pCreate |
( |
istream_type & | Stream | ) |
const |
|
protectedvirtual |
◆ Promote() [1/2]
FrEvent::promote_ret_type FrameCPP::Version_8::FrEvent::Promote |
( |
INT_2U | Source, |
|
|
promote_arg_type | Obj, |
|
|
istream_type * | Stream ) |
|
inlinestatic |
Promote previous version of object to this version.
- Parameters
-
[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. |
- Returns
- A new instance of FrEvent based on Obj
◆ Promote() [2/2]
static promote_ret_type FrameCPP::Version_8::FrEvent::Promote |
( |
INT_2U | Source, |
|
|
promote_arg_type | Obj, |
|
|
istream_type * | Stream ) |
|
static |
Promote previous version of object to this version.
- Parameters
-
[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. |
- Returns
- A new instance of FrEvent based on Obj
◆ promote() [1/2]
FrEvent::promote_ret_type FrameCPP::Version_8::FrEvent::promote |
( |
INT_2U | Target, |
|
|
promote_arg_type | Obj, |
|
|
istream_type * | Stream ) const |
|
protectedvirtual |
Upgrade an object.
- Parameters
-
[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. |
- Returns
- An object of this class.
◆ promote() [2/2]
virtual promote_ret_type FrameCPP::Version_8::FrEvent::promote |
( |
INT_2U | Target, |
|
|
promote_arg_type | Obj, |
|
|
istream_type * | Stream ) const |
|
protectedvirtual |
Upgrade an object.
- Parameters
-
[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. |
- Returns
- An object of this class.
◆ pWrite() [1/3]
void FrameCPP::Version_8::FrEvent::pWrite |
( |
ostream_type & | Stream | ) |
const |
|
protectedvirtual |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ pWrite() [2/3]
virtual void FrameCPP::Version_8::FrEvent::pWrite |
( |
ostream_type & | Stream | ) |
const |
|
protectedvirtual |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
◆ pWrite() [3/3]
|
protectedpure virtualinherited |
Write the structure to the stream.
- Parameters
-
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrVect.
◆ StructDescription() [1/2]
const Description * FrameCPP::Version_8::FrEvent::StructDescription |
( |
| ) |
|
|
static |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ StructDescription() [2/2]
static const Common::Description * FrameCPP::Version_8::FrEvent::StructDescription |
( |
| ) |
|
|
static |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ StructName() [1/2]
const char * FrameCPP::Version_8::FrEvent::StructName |
( |
| ) |
|
|
inlinestatic |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ StructName() [2/2]
static const char * FrameCPP::Version_8::FrEvent::StructName |
( |
| ) |
|
|
static |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ vTOCQuery() [1/2]
void FrameCPP::Version_8::FrEvent::vTOCQuery |
( |
int | InfoClass, |
|
|
va_list | vl ) const |
|
protectedvirtual |
Answer requests for information as needed by TOC.
- Parameters
-
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
◆ vTOCQuery() [2/2]
virtual void FrameCPP::Version_8::FrEvent::vTOCQuery |
( |
int | InfoClass, |
|
|
va_list | vl ) const |
|
protectedvirtual |
Answer requests for information as needed by TOC.
- Parameters
-
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrEvent.hh
- Version8/FrEvent.hh
- Version8/FrEvent.cc