ldas-tools-framecpp 3.0.4
|
Raw Data Structure Definition. More...
#include <FrSerData.hh>
Public Member Functions | |
FrSerData ()=default | |
Default constructor. | |
FrSerData (const FrSerData &Source)=default | |
Copy Constructor. | |
FrSerData (const std::string &name, const GPSTime &time, sampleRate_type sampleRate) | |
Constructor. | |
FrSerData (Previous::FrSerData &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
const name_type & | GetNameSlow () const |
Return the name of station producing serial data stream. | |
FrSerData & | Merge (const FrSerData &RHS) |
Merge with another FrSerData. | |
bool | operator== (const FrSerData &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
FrSerData ()=default | |
Default constructor. | |
FrSerData (const FrSerData &Source)=default | |
Copy Constructor. | |
FrSerData (const std::string &name, const GPSTime &time, sampleRate_type sampleRate) | |
Constructor. | |
FrSerData (Previous::FrSerData &Source, stream_base_type *Stream) | |
Promotion Constructor. | |
const name_type & | GetNameSlow () const |
Return the name of station producing serial data stream. | |
FrSerData & | Merge (const FrSerData &RHS) |
Merge with another FrSerData. | |
bool | operator== (const FrSerData &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 Common::Description * | GetDescription (ostream_type &Stream) const |
The data structure description. | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
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. | |
const name_type & | GetName () const |
Return the name of station producing serial data stream. | |
const time_type & | GetTime () const |
Retrieve the time of data acquisition. | |
sampleRate_type | GetSampleRate () const |
Retrieve the sample rate. | |
const data_type & | GetData () const |
Retrieve string of ASCII-based data. | |
void | SetData (const data_type &Data) |
Establish the string of ASCII-based data. | |
const serial_type & | RefSerial () const |
Identifier for serial data vector. | |
serial_type & | RefSerial () |
Identifier for serial data vector. | |
const table_type & | RefTable () const |
Identifier for user-defined table structure. | |
table_type & | RefTable () |
Identifier for user-defined table structure. | |
bool | operator== (const Data &RHS) const |
equality operator |
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 const Common::Description * | StructDescription () |
The description of structure. | |
template<class T> | |
static int | DataType (const T *Data) |
template<class T> | |
static int | DataType (const T &Data) |
template<class T> | |
static int | DataType (const T *Data) |
template<class T> | |
static int | DataType (const T &Data) |
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 struct_name_type | FrameSpecName () |
static struct_name_type | StructName () |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. |
Static Public Attributes | |
static struct_name_type | struct_name |
static struct_desc_type | struct_desc |
static struct_id_type | struct_id |
Protected Member Functions | |
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 |
Down grade an object. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const |
Upgrade an object. | |
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 void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. |
Protected Attributes | |
name_type | name |
Name of station producing serial data stream. | |
time_type | time |
sampleRate_type | sampleRate |
Sample rate, samles per second. | |
data_type | data |
Pointer to strin for ASCII-based data. | |
serial_type | serial |
Identifier for serial data vector. | |
table_type | table |
Identifier for user-defined table structure. |
Static Protected Attributes | |
static constexpr unsigned int | MAX_REF { 2 } |
Private Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
Object with checksum data. | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
Object with checksum data. | |
typedef STRING | io_name_type |
typedef STRING | io_data_type |
typedef INT_4U | io_timeSec_type |
typedef INT_4U | io_timeNsec_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual |
Private Attributes | |
ChecksumType | m_chkSum |
Structure checksum. |
Raw Data Structure Definition.
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
privateinherited |
|
private |
Object with checksum data.
|
private |
Object with checksum data.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
default |
Default constructor.
|
default |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_9::FrSerData::FrSerData | ( | const std::string & | name, |
const GPSTime & | time, | ||
sampleRate_type | sampleRate ) |
Constructor.
[in] | name | Name of station producing serial data stream. |
[in] | time | Time of data acquisition. |
[in] | sampleRate | Sample rate, samples per second. |
FrameCPP::Version_9::FrSerData::FrSerData | ( | Previous::FrSerData & | Source, |
stream_base_type * | Stream ) |
|
default |
Default constructor.
|
default |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_9::FrSerData::FrSerData | ( | const std::string & | name, |
const GPSTime & | time, | ||
sampleRate_type | sampleRate ) |
Constructor.
[in] | name | Name of station producing serial data stream. |
[in] | time | Time of data acquisition. |
[in] | sampleRate | Sample rate, samples per second. |
FrameCPP::Version_9::FrSerData::FrSerData | ( | Previous::FrSerData & | 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. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_9::FrTOC, and FrameCPP::Version_9::FrTOC.
|
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. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
inlineprotectedvirtualinherited |
Down grade an object.
[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. |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlineinherited |
Retrieve string of ASCII-based data.
|
inlinevirtualinherited |
The data structure description.
|
inlineinherited |
Return the name of station producing serial data stream.
const name_type & FrameCPP::Version_9::FrSerData::GetNameSlow | ( | ) | const |
Return the name of station producing serial data stream.
const name_type & FrameCPP::Version_9::FrSerData::GetNameSlow | ( | ) | const |
Return the name of station producing serial data stream.
|
inlineinherited |
Retrieve the sample rate.
|
inlineinherited |
Retrieve the time of data acquisition.
|
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 FrSerData object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrSerData object to be compared. |
|
inlineinherited |
equality operator
[in] | RHS | The FrSerData object to be compared. |
|
inlineprotectedvirtualinherited |
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< ObjectType, ChecksumType >.
|
inlineprotectedvirtualinherited |
Virtual constructor.
[in] | Stream | The stream from which the earliest version of the FrSerData structure was read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlinestaticinherited |
|
inlineprotectedvirtualinherited |
Upgrade an object.
[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. |
|
inlineprotectedvirtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlineinherited |
Identifier for serial data vector.
|
inlineinherited |
Identifier for serial data vector.
|
inlineinherited |
Identifier for user-defined table structure.
|
inlineinherited |
Identifier for user-defined table structure.
|
inlineinherited |
Establish the string of ASCII-based data.
|
inlinestaticinherited |
The description of structure.
|
inlinestaticinherited |
|
inlineinherited |
|
inherited |
|
inlineprotectedvirtualinherited |
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.
|
virtualinherited |
Write object to the stream.
|
protectedinherited |
Pointer to strin for ASCII-based data.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
staticconstexprprotectedinherited |
|
protectedinherited |
Name of station producing serial data stream.
|
protectedinherited |
Sample rate, samles per second.
|
protectedinherited |
Identifier for serial data vector.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
protectedinherited |
Identifier for user-defined table structure.
|
protectedinherited |
Time of data acquisition, GPS time in seconds since GPS standard epoch.