ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrEvent Class Referenceabstract

Event data structure definition. More...

#include <FrEvent.hh>

Inherits 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.
 
 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.
 
 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.
 
FrEventMerge (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 &parameters)
 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.
 
FrEventMerge (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_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 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.
 

Protected Member Functions

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.
 
FrEventpCreate (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.
 
FrEventpCreate (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.
 

Detailed Description

Event data structure definition.

Constructor & Destructor Documentation

◆ FrEvent() [1/6]

FrameCPP::Version_8::FrEvent::FrEvent ( const FrEvent eventData)

Copy constructor.

Parameters
[in]eventDataSource 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]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]eventStatusDefined by event search algorithm.
[in]amplitudeContinuous output amplitude returned by event.
[in]probLikelihood estimate of event.
[in]statisticsStatistical description of event.
[in]parametersArray 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]SourceAn instance of a similiar object from a previous version of the frame specification.
[in]StreamThe 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]eventDataSource 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]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]eventStatusDefined by event search algorithm.
[in]amplitudeContinuous output amplitude returned by event.
[in]probLikelihood estimate of event.
[in]statisticsStatistical description of event.
[in]parametersArray 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]SourceAn instance of a similiar object from a previous version of the frame specification.
[in]StreamThe stream from which the origional object was read.
Returns
A new instance of this 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]

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

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

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

FrEvent & FrameCPP::Version_8::FrEvent::Merge ( const FrEvent RHS)

Merge with another FrEvent.

Parameters
[in]RHSFrEvent information to incorperate into this object.

◆ Merge() [2/2]

FrEvent & FrameCPP::Version_8::FrEvent::Merge ( const FrEvent RHS)

Merge with another FrEvent.

Parameters
[in]RHSFrEvent 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]

bool FrameCPP::Version_8::FrEvent::operator== ( const Common::FrameSpec::Object Obj) const
virtual

equality operator for abstract data type

Parameters
[in]ObjThe 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_8::FrEvent::operator== ( const Common::FrameSpec::Object Obj) const
virtual

equality operator for abstract data type

Parameters
[in]ObjThe 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
[in]RHSThe FrEndOfFrame object to be compared.
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
[in]RHSThe FrEndOfFrame object to be compared.
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

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrEvent::pBytes ( const Common::StreamBase &  Stream) const
protectedvirtual

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [1/2]

FrEvent * FrameCPP::Version_8::FrEvent::pCreate ( istream_type &  Stream) const
protectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

◆ pCreate() [2/2]

FrEvent * FrameCPP::Version_8::FrEvent::pCreate ( istream_type &  Stream) const
protectedvirtual

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.

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

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]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/3]

void FrameCPP::Version_8::FrEvent::pWrite ( ostream_type &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe 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]StreamThe output stream where the object is to be written.

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type &  Stream) const
protectedpure virtualinherited

◆ 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]InfoClassClass of information being requested.
[in]vlVariable 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]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

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