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

Raw Data Structure Definition. More...

#include <FrSerData.hh>

Inherits FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >, and FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >.

Public Member Functions

 FrSerData ()=default
 Default constructor. More...
 
 FrSerData (const FrSerData &Source)=default
 Copy Constructor. More...
 
 FrSerData (const std::string &name, const GPSTime &time, sampleRate_type sampleRate)
 Constructor. More...
 
 FrSerData (Previous::FrSerData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
const name_type & GetNameSlow () const
 Return the name of station producing serial data stream. 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...
 
 FrSerData ()=default
 Default constructor. More...
 
 FrSerData (const FrSerData &Source)=default
 Copy Constructor. More...
 
 FrSerData (const std::string &name, const GPSTime &time, sampleRate_type sampleRate)
 Constructor. More...
 
 FrSerData (Previous::FrSerData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
const name_type & GetNameSlow () const
 Return the name of station producing serial data stream. 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...
 
 FrSerData ()=default
 Default constructor. More...
 
 FrSerData (const FrSerData &Source)=default
 Copy Constructor. More...
 
 FrSerData (const std::string &name, const GPSTime &time, sampleRate_type sampleRate)
 Constructor. More...
 
 FrSerData (Previous::FrSerData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
const name_type & GetNameSlow () const
 Return the name of station producing serial data stream. 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 const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const name_type & GetName () const
 Return the name of station producing serial data stream. More...
 
const name_type & GetName () const
 Return the name of station producing serial data stream. More...
 
const name_type & GetName () const
 Return the name of station producing serial data stream. More...
 
const time_type & GetTime () const
 Retrieve the time of data acquisition. More...
 
const time_type & GetTime () const
 Retrieve the time of data acquisition. More...
 
const time_type & GetTime () const
 Retrieve the time of data acquisition. More...
 
sampleRate_type GetSampleRate () const
 Retrieve the sample rate. More...
 
sampleRate_type GetSampleRate () const
 Retrieve the sample rate. More...
 
sampleRate_type GetSampleRate () const
 Retrieve the sample rate. More...
 
const data_type & GetData () const
 Retrieve string of ASCII-based data. More...
 
const data_type & GetData () const
 Retrieve string of ASCII-based data. More...
 
const data_type & GetData () const
 Retrieve string of ASCII-based data. More...
 
void SetData (const data_type &Data)
 Establish the string of ASCII-based data.
 
void SetData (const data_type &Data)
 Establish the 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. More...
 
serial_typeRefSerial ()
 Identifier for serial data vector. More...
 
const serial_typeRefSerial () const
 Identifier for serial data vector. More...
 
serial_typeRefSerial ()
 Identifier for serial data vector. More...
 
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...
 
table_typeRefTable ()
 Identifier for user-defined table structure. More...
 
const table_typeRefTable () const
 Identifier for user-defined table structure. More...
 
table_typeRefTable ()
 Identifier for user-defined table structure. More...
 
const table_typeRefTable () const
 Identifier for user-defined table structure. More...
 
table_typeRefTable ()
 Identifier for user-defined table structure. More...
 
bool operator== (const Data &RHS) const
 equality operator 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 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 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.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
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 struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the 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 * 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.
 

Protected Member Functions

virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
 Down grade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 

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.
 

Detailed Description

Raw Data Structure Definition.

Constructor & Destructor Documentation

◆ FrSerData() [1/12]

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

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [2/12]

FrameCPP::Version_8::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/12]

FrameCPP::Version_8::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/12]

FrameCPP::Version_8::FrSerData::FrSerData ( Previous::FrSerData &  Source,
istream_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/12]

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

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [6/12]

FrameCPP::Version_8::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/12]

FrameCPP::Version_8::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/12]

FrameCPP::Version_8::FrSerData::FrSerData ( Previous::FrSerData &  Source,
istream_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() [9/12]

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

Default constructor.

Returns
A new instance of this object.

◆ FrSerData() [10/12]

FrameCPP::Version_8::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() [11/12]

FrameCPP::Version_8::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() [12/12]

FrameCPP::Version_8::FrSerData::FrSerData ( Previous::FrSerData &  Source,
istream_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/3]

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/3]

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() [3/3]

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/3]

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/3]

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() [3/3]

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/3]

template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_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.

◆ demote() [2/3]

template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_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.

◆ demote() [3/3]

template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_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.

◆ GetData() [1/3]

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

Retrieve string of ASCII-based data.

Returns
The string of ASCII-based data.

◆ GetData() [2/3]

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

Retrieve string of ASCII-based data.

Returns
The string of ASCII-based data.

◆ GetData() [3/3]

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

Retrieve string of ASCII-based data.

Returns
The string of ASCII-based data.

◆ GetName() [1/3]

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

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetName() [2/3]

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

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetName() [3/3]

const name_type& FrameCPP::Version_8::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/3]

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

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetNameSlow() [2/3]

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

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetNameSlow() [3/3]

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

Return the name of station producing serial data stream.

Returns
The name associated of station producing serial data stream.

◆ GetSampleRate() [1/3]

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

Retrieve the sample rate.

Returns
The sample rate.

◆ GetSampleRate() [2/3]

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

Retrieve the sample rate.

Returns
The sample rate.

◆ GetSampleRate() [3/3]

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

Retrieve the sample rate.

Returns
The sample rate.

◆ GetTime() [1/3]

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

Retrieve the time of data acquisition.

Returns
The time of data acquisition.

◆ GetTime() [2/3]

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

Retrieve the time of data acquisition.

Returns
The time of data acquisition.

◆ GetTime() [3/3]

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

Retrieve the time of data acquisition.

Returns
The time of data acquisition.

◆ Merge() [1/3]

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/3]

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() [3/3]

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

◆ ObjectStructName() [1/3]

template<typename T >
virtual const char* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/3]

template<typename T >
virtual const char* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [3/3]

template<typename T >
virtual const char* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/7]

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.

◆ operator==() [2/7]

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.

◆ operator==() [3/7]

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.

◆ operator==() [4/7]

bool FrameCPP::Version_8::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.

◆ operator==() [5/7]

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==() [6/7]

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==() [7/7]

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.

◆ pBytes() [1/3]

template<typename T >
cmn_streamsize_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase &  Stream) const
inlineprotectedinherited

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.

◆ pBytes() [2/3]

template<typename T >
cmn_streamsize_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase &  Stream) const
inlineprotectedinherited

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.

◆ pBytes() [3/3]

template<typename T >
cmn_streamsize_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase &  Stream) const
inlineprotectedinherited

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.

◆ pCreate() [1/3]

template<typename T >
virtual self_type* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::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.

◆ pCreate() [2/3]

template<typename T >
virtual self_type* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::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.

◆ pCreate() [3/3]

template<typename T >
virtual self_type* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::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.

◆ Promote() [1/3]

template<typename T >
static promote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_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() [2/3]

template<typename T >
static promote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_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() [3/3]

template<typename T >
static promote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_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() [1/3]

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_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.

◆ promote() [2/3]

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_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.

◆ promote() [3/3]

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_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.

◆ RefSerial() [1/6]

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

Identifier for serial data vector.

Returns
A reference the serial data vector.

◆ RefSerial() [2/6]

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

Identifier for serial data vector.

Returns
A reference the serial data vector.

◆ RefSerial() [3/6]

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

Identifier for serial data vector.

Returns
A reference the serial data vector.

◆ RefSerial() [4/6]

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

Identifier for serial data vector.

Returns
A constant reference the serial data vector.

◆ RefSerial() [5/6]

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

Identifier for serial data vector.

Returns
A constant reference the serial data vector.

◆ RefSerial() [6/6]

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

Identifier for serial data vector.

Returns
A constant reference the serial data vector.

◆ RefTable() [1/6]

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

Identifier for user-defined table structure.

Returns
A reference to the user-defined table structure.

◆ RefTable() [2/6]

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

Identifier for user-defined table structure.

Returns
A reference to the user-defined table structure.

◆ RefTable() [3/6]

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

Identifier for user-defined table structure.

Returns
A reference to the user-defined table structure.

◆ RefTable() [4/6]

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

Identifier for user-defined table structure.

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

◆ RefTable() [5/6]

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

Identifier for user-defined table structure.

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

◆ RefTable() [6/6]

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

Identifier for user-defined table structure.

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

◆ StructDescription() [1/3]

template<typename T >
static const Common::Description* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/3]

template<typename T >
static const Common::Description* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [3/3]

template<typename T >
static const Common::Description* FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ vTOCQuery() [1/3]

template<typename T >
virtual void FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::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.

◆ vTOCQuery() [2/3]

template<typename T >
virtual void FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::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.

◆ vTOCQuery() [3/3]

template<typename T >
virtual void FrameCPP::Version_8::FrSerDataImpl::ClassicIO< T >::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.

Member Data Documentation

◆ time

time_type FrameCPP::Version_8::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 file: