Simulated Event Data Structure Definition.
More...
#include <FrSimEvent.hh>
Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrSimEventNPS, FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrSimEventNPS, FrameCPP::Version_4::FrSimEventPST< TPTR_STRUCT, TData, TTable >, and FrameCPP::Common::TOCInfo.
|
| FrSimEvent () |
| Default constructor. More...
|
|
| FrSimEvent (const FrSimEvent &Source) |
| Copy Constructor. More...
|
|
| 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. More...
|
|
| FrSimEvent (const Previous::FrSimEvent &Source, Common::IStream *Stream) |
| Promotion Constructor. More...
|
|
const std::string & | GetNameSlow () const |
| Retrieve the name of event. More...
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object. More...
|
|
FrSimEvent & | Merge (const FrSimEvent &RHS) |
| Merge with another FrSimEvent. More...
|
|
bool | operator== (const FrSimEvent &RHS) const |
| inequality operator More...
|
|
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
| equality operator for abstract data type More...
|
|
| FrSimEvent () |
| Default constructor. More...
|
|
| FrSimEvent (const FrSimEvent &Source) |
| Copy Constructor. More...
|
|
| 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. More...
|
|
| FrSimEvent (const Previous::FrSimEvent &Source, Common::IStream *Stream) |
| Promotion Constructor. More...
|
|
const std::string & | GetNameSlow () const |
| Retrieve the name of event. More...
|
|
virtual const char * | ObjectStructName () const |
| The name structure name of this object. More...
|
|
FrSimEvent & | Merge (const FrSimEvent &RHS) |
| Merge with another FrSimEvent. More...
|
|
bool | operator== (const FrSimEvent &RHS) const |
| inequality operator More...
|
|
virtual bool | operator== (const Common::FrameSpec::Object &RHS) 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 promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *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, Common::IStream *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.
|
|
|
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const |
| Demotes object to previous version of the frame spec. More...
|
|
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const |
| Promotes object to another version of the frame spec. More...
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure. More...
|
|
virtual FrSimEvent * | pCreate (Common::IStream &Stream) const |
| Virtual constructor. More...
|
|
virtual void | pWrite (Common::OStream &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, Common::IStream *Stream) const |
| Demotes object to previous version of the frame spec. More...
|
|
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const |
| Promotes object to another version of the frame spec. More...
|
|
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
| Number of bytes needed to write this structure. More...
|
|
virtual FrSimEvent * | pCreate (Common::IStream &Stream) const |
| Virtual constructor. More...
|
|
virtual void | pWrite (Common::OStream &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...
|
|
Simulated Event Data Structure Definition.
◆ FrSimEvent() [1/8]
FrSimEvent::FrSimEvent |
( |
| ) |
|
Default constructor.
- Returns
- A new instance of this object.
◆ FrSimEvent() [2/8]
FrSimEvent::FrSimEvent |
( |
const FrSimEvent & |
Source | ) |
|
Copy Constructor.
- Parameters
-
[in] | Source | The object from which to copy the information. |
- Returns
- A new instance of this object.
◆ FrSimEvent() [3/8]
FrameCPP::Version_8::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] | 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. |
- Returns
- A new instance of this object.
◆ FrSimEvent() [4/8]
FrSimEvent::FrSimEvent |
( |
const Previous::FrSimEvent & |
Source, |
|
|
Common::IStream * |
Stream |
|
) |
| |
Promotion Constructor.
- Parameters
-
[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. |
- Returns
- A new instance of the object.
◆ FrSimEvent() [5/8]
FrameCPP::Version_8::FrSimEvent::FrSimEvent |
( |
| ) |
|
Default constructor.
- Returns
- A new instance of this object.
◆ FrSimEvent() [6/8]
FrameCPP::Version_8::FrSimEvent::FrSimEvent |
( |
const FrSimEvent & |
Source | ) |
|
Copy Constructor.
- Parameters
-
[in] | Source | The object from which to copy the information. |
- Returns
- A new instance of this object.
◆ FrSimEvent() [7/8]
FrameCPP::Version_8::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] | 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. |
- Returns
- A new instance of this object.
◆ FrSimEvent() [8/8]
FrameCPP::Version_8::FrSimEvent::FrSimEvent |
( |
const Previous::FrSimEvent & |
Source, |
|
|
Common::IStream * |
Stream |
|
) |
| |
Promotion Constructor.
- Parameters
-
[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. |
- Returns
- A new instance of the 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]
virtual demote_ret_type FrameCPP::Version_8::FrSimEvent::demote |
( |
INT_2U |
Target, |
|
|
demote_arg_type |
Obj, |
|
|
Common::IStream * |
Stream |
|
) |
| const |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
- 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]
FrSimEvent::demote_ret_type FrSimEvent::demote |
( |
INT_2U |
Target, |
|
|
demote_arg_type |
Obj, |
|
|
Common::IStream * |
Stream |
|
) |
| const |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
- 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 & FrSimEvent::GetNameSlow |
( |
| ) |
const |
Retrieve the name of event.
- Returns
- The name of event.
◆ GetNameSlow() [2/2]
const std::string& FrameCPP::Version_8::FrSimEvent::GetNameSlow |
( |
| ) |
const |
Retrieve the name of event.
- Returns
- The name of event.
◆ Merge() [1/2]
Merge with another FrSimEvent.
- Parameters
-
[in] | RHS | The source of the information to append to this FrSimEvent structure. |
- Returns
- A reference to this object
◆ Merge() [2/2]
Merge with another FrSimEvent.
- Parameters
-
[in] | RHS | The source of the information to append to this FrSimEvent structure. |
- Returns
- A reference to this object
◆ ObjectStructName() [1/2]
const char * FrSimEvent::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::FrSimEvent::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::FrSimEvent::operator== |
( |
const FrSimEvent & |
RHS | ) |
const |
inequality operator
- Parameters
-
- Returns
- The value true is returned if this object is not equivelent to the RHS instance; false otherwise.
◆ operator==() [2/4]
bool FrameCPP::Version_8::FrSimEvent::operator== |
( |
const FrSimEvent & |
RHS | ) |
const |
|
inline |
inequality operator
- Parameters
-
- Returns
- The value true is returned if this object is not equivelent to the RHS instance; false otherwise.
◆ operator==() [3/4]
equality operator for abstract data type
- Parameters
-
[in] | RHS | The object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ operator==() [4/4]
equality operator for abstract data type
- Parameters
-
[in] | RHS | The object to be compared. |
- Returns
- The value true is returned if this object is equivelent to the RHS instance; false otherwise.
◆ pBytes() [1/2]
cmn_streamsize_type FrameCPP::Version_8::FrSimEvent::pBytes |
( |
const Common::StreamBase & |
Stream | ) |
const |
|
protectedvirtual |
◆ pBytes() [2/2]
FrameCPP::cmn_streamsize_type FrSimEvent::pBytes |
( |
const Common::StreamBase & |
Stream | ) |
const |
|
protectedvirtual |
◆ pCreate() [1/2]
FrSimEvent * FrSimEvent::pCreate |
( |
Common::IStream & |
Stream | ) |
const |
|
protectedvirtual |
◆ pCreate() [2/2]
virtual FrSimEvent* FrameCPP::Version_8::FrSimEvent::pCreate |
( |
Common::IStream & |
Stream | ) |
const |
|
protectedvirtual |
◆ Promote() [1/2]
static promote_ret_type FrameCPP::Version_8::FrSimEvent::Promote |
( |
INT_2U |
Source, |
|
|
promote_arg_type |
Obj, |
|
|
Common::IStream * |
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 FrameH based on Obj
◆ Promote() [2/2]
FrSimEvent::promote_ret_type FrameCPP::Version_8::FrSimEvent::Promote |
( |
INT_2U |
Source, |
|
|
promote_arg_type |
Obj, |
|
|
Common::IStream * |
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 FrameH based on Obj
◆ promote() [1/2]
FrSimEvent::promote_ret_type FrSimEvent::promote |
( |
INT_2U |
Target, |
|
|
promote_arg_type |
Obj, |
|
|
Common::IStream * |
Stream |
|
) |
| const |
|
protectedvirtual |
Promotes object to another version of the frame spec.
- Parameters
-
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object promoted to the next generation.
◆ promote() [2/2]
virtual promote_ret_type FrameCPP::Version_8::FrSimEvent::promote |
( |
INT_2U |
Target, |
|
|
promote_arg_type |
Obj, |
|
|
Common::IStream * |
Stream |
|
) |
| const |
|
protectedvirtual |
Promotes object to another version of the frame spec.
- Parameters
-
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
- Returns
- An object promoted to the next generation.
◆ pWrite() [1/2]
virtual void FrameCPP::Version_8::FrSimEvent::pWrite |
( |
Common::OStream & |
Stream | ) |
const |
|
protectedvirtual |
◆ pWrite() [2/2]
void FrSimEvent::pWrite |
( |
Common::OStream & |
Stream | ) |
const |
|
protectedvirtual |
◆ StructDescription() [1/2]
const Description * FrSimEvent::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::FrSimEvent::StructDescription |
( |
| ) |
|
|
static |
The description of structure.
- Returns
- A Description object which describes this structure as specified by the frame specification.
◆ StructName() [1/2]
static const char* FrameCPP::Version_8::FrSimEvent::StructName |
( |
| ) |
|
|
static |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ StructName() [2/2]
const char * FrameCPP::Version_8::FrSimEvent::StructName |
( |
| ) |
|
|
inlinestatic |
The name structure name of this object.
- Returns
- The name of the structure as specified by the frame specification.
◆ vTOCQuery() [1/2]
virtual void FrameCPP::Version_8::FrSimEvent::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::FrSimEvent::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/FrSimEvent.hh
- Version8/FrSimEvent.cc