ldas-tools-framecpp  2.7.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrSerData Class Reference

Raw Data Structure Definition. More...

#include <FrSerData.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.

Public Member Functions

 FrSerData ()
 Default constructor. More...
 
 FrSerData (const FrSerData &Source)
 Copy Constructor. More...
 
 FrSerData (const std::string &name, const GPSTime &time, REAL_8 sampleRate)
 Constructor. More...
 
 FrSerData (Previous::FrSerData &Source, Common::IStream *Stream)
 Promotion Constructor. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetName () const
 Return the name of station producing serial data stream. More...
 
const GPSTime & GetTime () const
 Retrieve the time of data acquisition. More...
 
REAL_8 GetSampleRate () const
 Retrieve the sample rate. More...
 
const std::string & GetData () const
 Retrieve string of ASCII-based data. More...
 
void SetData (const std::string &Data)
 Establish the string of ASCII-based data.
 
const serial_typeRefSerial () const
 Identifier for serial data vector. More...
 
serial_typeRefSerial ()
 Identifier for serial data vector. More...
 
const table_typeRefTable () const
 Identifier for user-defined table structure. More...
 
FrSerDataMerge (const FrSerData &RHS)
 Merge with another FrSerData. More...
 
bool operator== (const FrSerData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
 FrSerData ()
 Default constructor. More...
 
 FrSerData (const FrSerData &Source)
 Copy Constructor. More...
 
 FrSerData (const std::string &name, const GPSTime &time, REAL_8 sampleRate)
 Constructor. More...
 
 FrSerData (Previous::FrSerData &Source, Common::IStream *Stream)
 Promotion Constructor. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetName () const
 Return the name of station producing serial data stream. More...
 
const GPSTime & GetTime () const
 Retrieve the time of data acquisition. More...
 
REAL_8 GetSampleRate () const
 Retrieve the sample rate. More...
 
const std::string & GetData () const
 Retrieve string of ASCII-based data. More...
 
void SetData (const std::string &Data)
 Establish the string of ASCII-based data.
 
const serial_typeRefSerial () const
 Identifier for serial data vector. More...
 
serial_typeRefSerial ()
 Identifier for serial data vector. More...
 
const table_typeRefTable () const
 Identifier for user-defined table structure. More...
 
FrSerDataMerge (const FrSerData &RHS)
 Merge with another FrSerData. More...
 
bool operator== (const FrSerData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. 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_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (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 Public Member Functions

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 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 * 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, 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 FrSerDatapCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. 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 FrSerDatapCreate (Common::IStream &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream. More...
 

Detailed Description

Raw Data Structure Definition.

Constructor & Destructor Documentation

◆ FrSerData() [1/8]

FrSerData::FrSerData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [2/8]

FrSerData::FrSerData ( const FrSerData Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrSerData() [3/8]

FrSerData::FrSerData ( const std::string &  name,
const GPSTime &  time,
REAL_8  sampleRate 
)

Constructor.

Parameters
[in]nameName of station producing serial data stream.
[in]timeTime of data acquisition.
[in]sampleRateSample rate, samples per second.
Returns
A new instance of the object.

◆ FrSerData() [4/8]

FrSerData::FrSerData ( Previous::FrSerData &  Source,
Common::IStream *  Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrSerData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrSerData structure was read.
Returns
A new instance of the object.

◆ FrSerData() [5/8]

FrameCPP::Version_8::FrSerData::FrSerData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [6/8]

FrameCPP::Version_8::FrSerData::FrSerData ( const FrSerData Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrSerData() [7/8]

FrameCPP::Version_8::FrSerData::FrSerData ( const std::string &  name,
const GPSTime &  time,
REAL_8  sampleRate 
)

Constructor.

Parameters
[in]nameName of station producing serial data stream.
[in]timeTime of data acquisition.
[in]sampleRateSample rate, samples per second.
Returns
A new instance of the object.

◆ FrSerData() [8/8]

FrameCPP::Version_8::FrSerData::FrSerData ( Previous::FrSerData &  Source,
Common::IStream *  Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrSerData structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrSerData structure was read.
Returns
A new instance of the 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]

FrSerData::demote_ret_type FrSerData::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

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::FrSerData::demote ( INT_2U  Target,
demote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

Demotes object to previous version of the frame spec.

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.

◆ GetData() [1/2]

const std::string & FrameCPP::Version_8::FrSerData::GetData ( ) const
inline

Retrieve string of ASCII-based data.

Returns
The string of ASCII-based data.

◆ GetData() [2/2]

const std::string& FrameCPP::Version_8::FrSerData::GetData ( ) const

Retrieve string of ASCII-based data.

Returns
The string of ASCII-based data.

◆ GetName() [1/2]

const std::string & FrSerData::GetName ( ) const

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetName() [2/2]

const std::string& FrameCPP::Version_8::FrSerData::GetName ( ) const

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetSampleRate() [1/2]

REAL_8 FrameCPP::Version_8::FrSerData::GetSampleRate ( ) const

Retrieve the sample rate.

Returns
The sample rate.

◆ GetSampleRate() [2/2]

REAL_8 FrameCPP::Version_8::FrSerData::GetSampleRate ( ) const
inline

Retrieve the sample rate.

Returns
The sample rate.

◆ GetTime() [1/2]

const GPSTime & FrameCPP::Version_8::FrSerData::GetTime ( ) const
inline

Retrieve the time of data acquisition.

Returns
The time of data acquisition.

◆ GetTime() [2/2]

const GPSTime& FrameCPP::Version_8::FrSerData::GetTime ( ) const

Retrieve the time of data acquisition.

Returns
The time of data acquisition.

◆ Merge() [1/2]

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

Merge with another FrSerData.

Parameters
[in]RHSThe source of the information to append to this FrSerData structure.
Returns
A reference to this object

◆ Merge() [2/2]

FrSerData & FrSerData::Merge ( const FrSerData RHS)

Merge with another FrSerData.

Parameters
[in]RHSThe source of the information to append to this FrSerData structure.
Returns
A reference to this object
Todo:
Need to implement Merge routine

◆ ObjectStructName() [1/2]

const char * FrSerData::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::FrSerData::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::FrSerData::operator== ( const FrSerData RHS) const

equality operator

Parameters
[in]RHSThe FrSerData object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

bool FrameCPP::Version_8::FrSerData::operator== ( const FrSerData RHS) const
inline

equality operator

Parameters
[in]RHSThe FrSerData 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 FrSerData::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

virtual bool FrameCPP::Version_8::FrSerData::operator== ( const Common::FrameSpec::Object RHS) const
virtual

equality operator for abstract data type

Parameters
[in]RHSThe 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 FrSerData::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 >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrSerData::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]

FrSerData * FrSerData::pCreate ( Common::IStream &  Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

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

◆ pCreate() [2/2]

virtual FrSerData* FrameCPP::Version_8::FrSerData::pCreate ( Common::IStream &  Stream) const
protectedvirtual

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

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

◆ Promote() [1/2]

static promote_ret_type FrameCPP::Version_8::FrSerData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream *  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 FrameH based on Obj

◆ Promote() [2/2]

FrSerData::promote_ret_type FrameCPP::Version_8::FrSerData::Promote ( INT_2U  Source,
promote_arg_type  Obj,
Common::IStream *  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 FrameH based on Obj

◆ promote() [1/2]

virtual promote_ret_type FrameCPP::Version_8::FrSerData::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ promote() [2/2]

FrSerData::promote_ret_type FrSerData::promote ( INT_2U  Target,
promote_arg_type  Obj,
Common::IStream *  Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

void FrSerData::pWrite ( Common::OStream &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrSerData::pWrite ( Common::OStream &  Stream) const
protectedvirtual

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ RefSerial() [1/4]

const FrSerData::serial_type & FrameCPP::Version_8::FrSerData::RefSerial ( ) const
inline

Identifier for serial data vector.

Returns
A constant reference the serial data vector.

◆ RefSerial() [2/4]

const serial_type& FrameCPP::Version_8::FrSerData::RefSerial ( ) const

Identifier for serial data vector.

Returns
A constant reference the serial data vector.

◆ RefSerial() [3/4]

serial_type& FrameCPP::Version_8::FrSerData::RefSerial ( )

Identifier for serial data vector.

Returns
A reference the serial data vector.

◆ RefSerial() [4/4]

FrSerData::serial_type & FrameCPP::Version_8::FrSerData::RefSerial ( )
inline

Identifier for serial data vector.

Returns
A reference the serial data vector.

◆ RefTable() [1/2]

const table_type& FrameCPP::Version_8::FrSerData::RefTable ( ) const

Identifier for user-defined table structure.

Returns
A constant reference to the user-defined table structure.

◆ RefTable() [2/2]

const FrSerData::table_type & FrameCPP::Version_8::FrSerData::RefTable ( ) const
inline

Identifier for user-defined table structure.

Returns
A constant reference to the user-defined table structure.

◆ StructDescription() [1/2]

static const Common::Description* FrameCPP::Version_8::FrSerData::StructDescription ( )
static

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/2]

const Description * FrSerData::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::FrSerData::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::FrSerData::StructName ( )
static

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::FrSerData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
virtual

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::FrSerData::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
virtual

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: