ldas-tools-framecpp
2.5.8
|
Simulated Data Structure Definition. More...
#include <FrSimData.hh>
Public Member Functions | |
FrSimData () | |
Default constructor. More... | |
FrSimData (const FrSimData &Source) | |
Copy Constructor. More... | |
FrSimData (const std::string &Name, const std::string &Comment, const REAL_8 SampleRate, const REAL_8 FShift, const REAL_4 Phase, const REAL_8 TimeOffset=DEFAULT_TIME_OFFSET) | |
Constructor. More... | |
FrSimData (Previous::FrSimData &Source, Common::IStream *Stream) | |
Promotion Constructor. More... | |
void | SetComment (const comment_type &Comment) |
Establish the value of the comment field. More... | |
void | SetSampleRate (sampleRate_type SampleRate) |
Establish the value of the sampleRate field. More... | |
void | SetTimeOffset (timeOffset_type time) |
Establish the value of the timeOffset field. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const std::string & | GetNameSlow () const |
Return the name associate with the FrSimData structure. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
FrSimData & | Merge (const FrSimData &RHS) |
Merge with another FrSimData. More... | |
bool | operator== (const FrSimData &RHS) const |
equality 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 self_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. More... | |
class_type | GetClass () const |
Retrieve the class identifier. More... | |
const Description * | GetDescription () const |
Retrieve FrSH/FrSE description of the parent object. More... | |
ostream_type & | WriteNext (ostream_type &Stream) const |
Write a next pointer to the parent to the stream. More... | |
virtual Object * | Clone () const |
constructor - virtual copy constructor More... | |
template<typename PreviousType , typename CurrentType > | |
FrameSpec::ObjectInterface::promote_ret_type | PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream) |
virtual void | VerifyObject (Verify &Verifier, IFrameStream &Stream) const |
Verify an object. More... | |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
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. More... | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. More... | |
static object_type | DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream) |
Down grade an object. More... | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<typename PreviousType , typename CurrentType > | |
static object_type | PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream) |
Upgrade an object. More... | |
template<class T > | |
static int | DataType (const T *Data) |
template<class T > | |
static int | DataType (const T &Data) |
Protected Member Functions | |
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 FrSimData * | 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 class_type | getClass () const |
Retrieve the class identifier. More... | |
Simulated Data Structure Definition.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrSimData::FrSimData | ( | ) |
Default constructor.
FrSimData::FrSimData | ( | const FrSimData & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrSimData::FrSimData | ( | const std::string & | Name, |
const std::string & | Comment, | ||
const REAL_8 | SampleRate, | ||
const REAL_8 | FShift, | ||
const REAL_4 | Phase, | ||
const REAL_8 | 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. |
FrSimData::FrSimData | ( | Previous::FrSimData & | Source, |
Common::IStream * | 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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
virtualinherited |
constructor - virtual copy constructor
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, and FrameCPP::Version_3::FrHeader.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
|
staticinherited |
|
protectedvirtual |
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Down grade an object.
[in] | Target | This is the version of the frame specification of the demoted object. |
[in] | Obj | The base object. |
[in] | Stream | Stream from which Obj was created. |
|
inlineinherited |
Retrieve the class identifier.
|
protectedvirtualinherited |
Retrieve the class identifier.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inlinevirtualinherited |
Retrieve FrSH/FrSE description of the parent object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
const std::string & FrSimData::GetNameSlow | ( | ) | const |
|
inline |
The data acquisition rate.
|
virtual |
The name structure name of this object.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inline |
equality operator
[in] | RHS | The FrSimData object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
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< Common::FrameSpec::Object, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, 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. |
|
protectedvirtual |
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. |
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
staticinherited |
Upgrade an object.
[in] | Target | Promote Obj to this version of the frame specification. |
[in] | Source | Obj conforms to this version of the frame specification. |
[in] | Obj | Object to be converted |
[in] | Stream | Originating stream for Obj. |
|
inherited |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.
|
inline |
Establish the value of the comment field.
[in] | Comment | The desired value of the comment field. |
|
inline |
Establish the value of the sampleRate field.
[in] | SampleRate | The desired value of the sampleRate field. |
|
inline |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
inlineinherited |
|
virtualinherited |
Verify an object.
[in,out] | Verifier | Set of rules to use in verification of the object. If an error occurs, the violation is logged here. |
[in] | Stream | The stream that is being used to read the object. |
Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
Implements FrameCPP::Common::FrameSpec::ObjectInterface.
|
inherited |
Write a next pointer to the parent to the stream.
[in,out] | Stream | The output stream to receive the next pointer. |