ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_9::FrSerData Class Reference

Raw Data Structure Definition. More...

#include <FrSerData.hh>

Inheritance diagram for FrameCPP::Version_9::FrSerData:
Collaboration diagram for FrameCPP::Version_9::FrSerData:

Public Types

enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
typedef STRING< INT_2U > string_2_type
typedef STRING< INT_2U > string_2_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
typedef IStream istream_type
typedef IStream istream_type
typedef OStream ostream_type
typedef OStream ostream_type
typedef FR_SER_DATA_NAME_TYPE name_type
typedef FR_SER_DATA_TIME_TYPE time_type
typedef FR_SER_DATA_SAMPLE_RATE_TYPE sampleRate_type
typedef FR_SER_DATA_DATA_TYPE data_type
typedef Common::SearchContainer< FrVect, &FrVect::GetName > serial_type
typedef serial_type::iterator iterator
typedef serial_type::const_iterator const_iterator
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
typedef table_type::iterator table_iterator
typedef table_type::const_iterator const_table_iterator
typedef const char *const struct_name_type
typedef const char *const struct_desc_type
typedef INT_2U const struct_id_type

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_typeGetNameSlow () const
 Return the name of station producing serial data stream.
FrSerDataMerge (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_typeGetNameSlow () const
 Return the name of station producing serial data stream.
FrSerDataMerge (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::DescriptionGetDescription (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_typeCreate (istream_type &Stream) const
 Virtual constructor.
virtual self_typeCreate (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_typeGetName () const
 Return the name of station producing serial data stream.
const time_typeGetTime () const
 Retrieve the time of data acquisition.
sampleRate_type GetSampleRate () const
 Retrieve the sample rate.
const data_typeGetData () const
 Retrieve string of ASCII-based data.
void SetData (const data_type &Data)
 Establish the string of ASCII-based data.
const serial_typeRefSerial () const
 Identifier for serial data vector.
serial_typeRefSerial ()
 Identifier for serial data vector.
const table_typeRefTable () const
 Identifier for user-defined table structure.
table_typeRefTable ()
 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::DescriptionStructDescription ()
 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_typepCreate (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::Objectobject_type
 Object with checksum data.
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_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_typeobject_base_type

Private Member Functions

virtual ObjectCreate () const
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
virtual ObjectCreate () const
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual

Private Attributes

ChecksumType m_chkSum
 Structure checksum.

Detailed Description

Raw Data Structure Definition.

Member Typedef Documentation

◆ const_iterator

◆ const_table_iterator

◆ data_type

◆ io_data_type

typedef STRING FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::io_data_type
privateinherited

◆ io_name_type

typedef STRING FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::io_name_type
privateinherited

◆ io_timeNsec_type

typedef INT_4U FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::io_timeNsec_type
privateinherited

◆ io_timeSec_type

typedef INT_4U FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::io_timeSec_type
privateinherited

◆ istream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ iterator

◆ name_type

◆ object_base_type

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrSerData::object_type
private

Object with checksum data.

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_9::FrSerData::object_type
private

Object with checksum data.

◆ ostream_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ sampleRate_type

◆ self_type [1/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType, typename ChecksumType>
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ serial_type

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ struct_desc_type

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type

template<typename Object_T>
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

template<typename Object_T>
typedef const char* const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ table_iterator

◆ table_type

◆ time_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

Constructor & Destructor Documentation

◆ FrSerData() [1/8]

FrameCPP::Version_9::FrSerData::FrSerData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [2/8]

FrameCPP::Version_9::FrSerData::FrSerData ( const FrSerData & Source)
default

Copy Constructor.

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

◆ FrSerData() [3/8]

FrameCPP::Version_9::FrSerData::FrSerData ( const std::string & name,
const GPSTime & time,
sampleRate_type 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]

FrameCPP::Version_9::FrSerData::FrSerData ( Previous::FrSerData & Source,
stream_base_type * 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_9::FrSerData::FrSerData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [6/8]

FrameCPP::Version_9::FrSerData::FrSerData ( const FrSerData & Source)
default

Copy Constructor.

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

◆ FrSerData() [7/8]

FrameCPP::Version_9::FrSerData::FrSerData ( const std::string & name,
const GPSTime & time,
sampleRate_type 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_9::FrSerData::FrSerData ( Previous::FrSerData & Source,
stream_base_type * 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]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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]

template<typename ObjectType, typename ChecksumType>
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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

◆ CheckSumDataClass() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType, typename ChecksumType>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType, typename ChecksumType>
template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType, typename ChecksumType>
const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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() [4/6]

template<typename ObjectType, typename ChecksumType>
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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() [5/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType, typename ChecksumType>
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ DataType() [1/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T>
int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote()

virtual demote_ret_type FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Down grade an object.

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.

◆ FrameSpecDescription()

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetData()

const data_type & FrameCPP::Version_9::FrSerDataImpl::Data::GetData ( ) const
inlineinherited

Retrieve string of ASCII-based data.

Returns
The string of ASCII-based data.

◆ GetDescription()

virtual const Common::Description * FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::GetDescription ( ostream_type & Stream) const
inlinevirtualinherited

The data structure description.

Returns
The description of the data structure used to represent this object when written to a GWF stream

◆ GetName()

const name_type & FrameCPP::Version_9::FrSerDataImpl::Data::GetName ( ) const
inlineinherited

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetNameSlow() [1/2]

const name_type & FrameCPP::Version_9::FrSerData::GetNameSlow ( ) const

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_9::FrSerData::GetNameSlow ( ) const

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetSampleRate()

sampleRate_type FrameCPP::Version_9::FrSerDataImpl::Data::GetSampleRate ( ) const
inlineinherited

Retrieve the sample rate.

Returns
The sample rate.

◆ GetTime()

const time_type & FrameCPP::Version_9::FrSerDataImpl::Data::GetTime ( ) const
inlineinherited

Retrieve the time of data acquisition.

Returns
The time of data acquisition.

◆ Merge() [1/2]

FrSerData & FrameCPP::Version_9::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 & FrameCPP::Version_9::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

◆ ObjectStructName()

virtual const char * FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

◆ operator==() [1/5]

virtual bool FrameCPP::Version_9::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==() [2/5]

virtual bool FrameCPP::Version_9::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==() [3/5]

bool FrameCPP::Version_9::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==() [4/5]

bool FrameCPP::Version_9::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==() [5/5]

bool FrameCPP::Version_9::FrSerDataImpl::Data::operator== ( const Data & RHS) const
inlineinherited

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.

◆ pBytes()

cmn_streamsize_type FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

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, ChecksumType >.

◆ pCreate()

virtual self_type * FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe stream from which the earliest version of the FrSerData structure was read.
Returns
A new instance of this object.

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

◆ Promote()

promote_ret_type FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::Promote ( INT_2U Source,
promote_arg_type Obj,
promote_stream_type * Stream )
inlinestaticinherited

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()

virtual promote_ret_type FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Upgrade an object.

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

◆ pWrite()

virtual void FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::pWrite ( ostream_type & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

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

◆ RefSerial() [1/2]

serial_type & FrameCPP::Version_9::FrSerDataImpl::Data::RefSerial ( )
inlineinherited

Identifier for serial data vector.

Returns
A reference the serial data vector.

◆ RefSerial() [2/2]

const serial_type & FrameCPP::Version_9::FrSerDataImpl::Data::RefSerial ( ) const
inlineinherited

Identifier for serial data vector.

Returns
A constant reference the serial data vector.

◆ RefTable() [1/2]

table_type & FrameCPP::Version_9::FrSerDataImpl::Data::RefTable ( )
inlineinherited

Identifier for user-defined table structure.

Returns
A reference to the user-defined table structure.

◆ RefTable() [2/2]

const table_type & FrameCPP::Version_9::FrSerDataImpl::Data::RefTable ( ) const
inlineinherited

Identifier for user-defined table structure.

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

◆ SetData()

void FrameCPP::Version_9::FrSerDataImpl::Data::SetData ( const data_type & Data)
inlineinherited

Establish the string of ASCII-based data.

◆ StructDescription()

const Common::Description * FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName()

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ vTOCQuery()

virtual void FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >::vTOCQuery ( int InfoClass,
va_list vl ) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType, typename ChecksumType>
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ data

data_type FrameCPP::Version_9::FrSerDataImpl::Data::data
protectedinherited

Pointer to strin for ASCII-based data.

◆ m_chkSum

template<typename ObjectType, typename ChecksumType>
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ MAX_REF

constexpr unsigned int FrameCPP::Version_9::FrSerDataImpl::Data::MAX_REF { 2 }
staticconstexprprotectedinherited

◆ name

name_type FrameCPP::Version_9::FrSerDataImpl::Data::name
protectedinherited

Name of station producing serial data stream.

◆ sampleRate

sampleRate_type FrameCPP::Version_9::FrSerDataImpl::Data::sampleRate
protectedinherited

Sample rate, samles per second.

◆ serial

serial_type FrameCPP::Version_9::FrSerDataImpl::Data::serial
protectedinherited

Identifier for serial data vector.

◆ struct_desc

template<typename Object_T>
struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T>
struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T>
struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ table

table_type FrameCPP::Version_9::FrSerDataImpl::Data::table
protectedinherited

Identifier for user-defined table structure.

◆ time

time_type FrameCPP::Version_9::FrSerDataImpl::Data::time
protectedinherited

Time of data acquisition, GPS time in seconds since GPS standard epoch.


The documentation for this class was generated from the following files:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/FrSerData.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrSerData.hh