|
ldas-tools-framecpp 3.0.4
|
Simulated Data Structure Definition. More...
#include <FrSimData.hh>
Public Member Functions | |
| FrSimData ()=default | |
| Default constructor. | |
| FrSimData (const FrSimData &Source)=default | |
| Copy Constructor. | |
| FrSimData (const name_type &Name, const comment_type &Comment, const sampleRate_type SampleRate, const fShift_type FShift, const phase_type Phase, const timeOffset_type TimeOffset=DEFAULT_TIME_OFFSET) | |
| Constructor. | |
| FrSimData (Previous::FrSimData &Source, stream_base_type *Stream) | |
| Promotion Constructor. | |
| const std::string & | GetNameSlow () const |
| Return the name associate with the FrSimData structure. | |
| FrSimData & | Merge (const FrSimData &RHS) |
| Merge with another FrSimData. | |
| bool | operator== (const FrSimData &RHS) const |
| equality operator | |
| virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
| equality operator for abstract data type | |
| FrSimData ()=default | |
| Default constructor. | |
| FrSimData (const FrSimData &Source)=default | |
| Copy Constructor. | |
| FrSimData (const name_type &Name, const comment_type &Comment, const sampleRate_type SampleRate, const fShift_type FShift, const phase_type Phase, const timeOffset_type TimeOffset=DEFAULT_TIME_OFFSET) | |
| Constructor. | |
| FrSimData (Previous::FrSimData &Source, stream_base_type *Stream) | |
| Promotion Constructor. | |
| const std::string & | GetNameSlow () const |
| Return the name associate with the FrSimData structure. | |
| FrSimData & | Merge (const FrSimData &RHS) |
| Merge with another FrSimData. | |
| bool | operator== (const FrSimData &RHS) const |
| equality 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. | |
| 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 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 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 self_type * | Create (istream_type &Stream) const |
| Virtual constructor. | |
| virtual self_type * | Create (istream_type &Stream) const |
| Virtual constructor. | |
| 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. | |
| virtual void | Write (ostream_type &Stream) const |
| Write object to the stream. | |
| virtual void | Write (ostream_type &Stream) const |
| Write object to the stream. | |
| 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 | SetComment (const comment_type &Comment) |
| Establish the value of the comment field. | |
| void | SetSampleRate (sampleRate_type SampleRate) |
| Establish the value of the sampleRate field. | |
| void | SetTimeOffset (timeOffset_type TimeOffset) |
| Establish the value of the timeOffset field. | |
Static Public Member Functions | |
| 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. | |
| static const Common::Description * | StructDescription () |
| The description of structure. | |
| 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 * | 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 * | 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 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 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 struct_desc_type | FrameSpecDescription () |
| Return the dictionary name of the structure. | |
| static struct_id_type | FrameSpecId () |
| Return the dictionary name of the structure. | |
Protected Member Functions | |
| 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. | |
| virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
| Demotes object to previous version of the frame spec. | |
| virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const |
| Demotes object to previous version of the frame spec. | |
| virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
| Promotes object to another version of the frame spec. | |
| virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
| Promotes object to another version of the frame spec. | |
| 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. | |
Simulated Data Structure Definition.
|
default |
Default constructor.
|
default |
Copy Constructor.
| [in] | Source | The object from which to copy the information. |
| FrameCPP::Version_9::FrSimData::FrSimData | ( | const name_type & | Name, |
| const comment_type & | Comment, | ||
| const sampleRate_type | SampleRate, | ||
| const fShift_type | FShift, | ||
| const phase_type | Phase, | ||
| const timeOffset_type | TimeOffset = DEFAULT_TIME_OFFSET ) |
Constructor.
| [in] | Name | Name of simulated data. |
| [in] | Comment | Comment |
| [in] | SampleRate | Simulated data sample rate, samples per second. |
| [in] | FShift | The frequency in the original data that corresponds to 0 Hz in the heterodyned series. |
| [in] | Phase | Phase of heterodyning signal at start of dataset. |
| [in] | TimeOffset | Offset of 1st sample relative to the frame start time. |
| FrameCPP::Version_9::FrSimData::FrSimData | ( | Previous::FrSimData & | Source, |
| stream_base_type * | Stream ) |
|
default |
Default constructor.
|
default |
Copy Constructor.
| [in] | Source | The object from which to copy the information. |
| FrameCPP::Version_9::FrSimData::FrSimData | ( | const name_type & | Name, |
| const comment_type & | Comment, | ||
| const sampleRate_type | SampleRate, | ||
| const fShift_type | FShift, | ||
| const phase_type | Phase, | ||
| const timeOffset_type | TimeOffset = DEFAULT_TIME_OFFSET ) |
Constructor.
| [in] | Name | Name of simulated data. |
| [in] | Comment | Comment |
| [in] | SampleRate | Simulated data sample rate, samples per second. |
| [in] | FShift | The frequency in the original data that corresponds to 0 Hz in the heterodyned series. |
| [in] | Phase | Phase of heterodyning signal at start of dataset. |
| [in] | TimeOffset | Offset of 1st sample relative to the frame start time. |
| FrameCPP::Version_9::FrSimData::FrSimData | ( | Previous::FrSimData & | Source, |
| stream_base_type * | 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 |
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 |
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 |
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. |
|
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. |
|
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. |
|
inlineprotectedvirtualinherited |
Demotes object to previous version of the frame spec.
| [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 |
Demotes object to previous version of the frame spec.
| [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. |
|
inlinevirtualinherited |
The data structure description.
|
inlinevirtualinherited |
The data structure description.
| const std::string & FrameCPP::Version_9::FrSimData::GetNameSlow | ( | ) | const |
| const std::string & FrameCPP::Version_9::FrSimData::GetNameSlow | ( | ) | const |
|
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 |
equality operator
| [in] | RHS | The FrSimData object to be compared. |
|
inline |
equality operator
| [in] | RHS | The FrSimData object to be compared. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
| [in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedinherited |
Number of bytes needed to write this structure.
| [in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
| [in] | Stream | The input stream from where the object is being read. |
|
inlineprotectedvirtualinherited |
Virtual constructor.
| [in] | Stream | The input stream from where the object is being read. |
|
inlinestaticinherited |
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. |
|
inlinestaticinherited |
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 |
Promotes object to another version of the frame spec.
| [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. |
|
inlineprotectedvirtualinherited |
Promotes object to another version of the frame spec.
| [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. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
| [in] | Stream | The output stream where the object is to be written. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
| [in] | Stream | The output stream where the object is to be written. |
|
inlineinherited |
Establish the value of the comment field.
| [in] | Comment | The desired value of the comment field. |
|
inlineinherited |
Establish the value of the sampleRate field.
| [in] | SampleRate | The desired value of the sampleRate field. |
|
inlineinherited |
Establish the value of the timeOffset field.
| [in] | Time | The desired value of the timeOffset field. |
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
The description of structure.
|
inlineprotectedvirtualinherited |
Answer requests for information as needed by TOC.
| [in] | InfoClass | Class of information being requested. |
| [in] | vl | Variable argument list of requested data. |
|
inlineprotectedvirtualinherited |
Answer requests for information as needed by TOC.
| [in] | InfoClass | Class of information being requested. |
| [in] | vl | Variable argument list of requested data. |