ldas-tools-framecpp 2.8.1
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
FrameCPP::Version_4::FrStatDataNPS::storage_type Struct Reference

#include <FrStatData.hh>

Public Member Functions

cmn_streamsize_type Bytes () const
 Stream size of object. More...
 
bool operator== (const storage_type &RHS) const
 Comparison operator. More...
 
void operator() (Common::IStream &Stream)
 Input elements from the stream. More...
 
void operator() (Common::OStream &Stream) const
 Output elements to the stream. More...
 
void operator() (const FrStatDataNPS &Source)
 Copy contents. More...
 
void operator() (const Previous::FrStatDataStorage &Source)
 Copy contents. More...
 
cmn_streamsize_type Bytes () const
 Stream size of object. More...
 
bool operator== (const storage_type &RHS) const
 Comparison operator. More...
 
void operator() (Common::IStream &Stream)
 Input elements from the stream. More...
 
void operator() (Common::OStream &Stream) const
 Output elements to the stream. More...
 
void operator() (const FrStatDataNPS &Source)
 Copy contents. More...
 
void operator() (const Previous::FrStatDataStorage &Source)
 Copy contents. More...
 
cmn_streamsize_type Bytes () const
 Stream size of object. More...
 
bool operator== (const storage_type &RHS) const
 Comparison operator. More...
 
void operator() (Common::IStream &Stream)
 Input elements from the stream. More...
 
void operator() (Common::OStream &Stream) const
 Output elements to the stream. More...
 
void operator() (const FrStatDataNPS &Source)
 Copy contents. More...
 
void operator() (const Previous::FrStatDataStorage &Source)
 Copy contents. More...
 

Static Public Member Functions

template<typename SE >
static void Describe (Common::Description &Desc)
 Supply description. More...
 
template<typename SE >
static void Describe (Common::Description &Desc)
 Supply description. More...
 
template<typename SE >
static void Describe (Common::Description &Desc)
 Supply description. More...
 

Private Attributes

STRING name
 Static data name. More...
 
STRING comment
 Comment for static data. More...
 
STRING representation
 
timeStart_type timeStart
 
timeEnd_type timeEnd
 
version_type version
 

Friends

class FrStatDataNPS
 

Detailed Description

Todo:
Needs documentation
Todo:
Needs documentation
Todo:
Needs documentation

Member Function Documentation

◆ Bytes() [1/3]

cmn_streamsize_type FrameCPP::Version_4::FrStatDataNPS::storage_type::Bytes ( ) const
inline

Stream size of object.

Returns
The number of bytes needed to write or read this class of object to or from a stream.

Calculate the number of bytes that will be written to the stream for this strucutre.

◆ Bytes() [2/3]

cmn_streamsize_type FrameCPP::Version_4::FrStatDataNPS::storage_type::Bytes ( ) const

Stream size of object.

Returns
The number of bytes needed to write or read this class of object to or from a stream.

◆ Bytes() [3/3]

cmn_streamsize_type FrameCPP::Version_4::FrStatDataNPS::storage_type::Bytes ( ) const

Stream size of object.

Returns
The number of bytes needed to write or read this class of object to or from a stream.

◆ Describe() [1/3]

template<typename SE >
void FrameCPP::Version_4::FrStatDataNPS::storage_type::Describe ( Common::Description Desc)
inlinestatic

Supply description.

Parameters
[out]DescStorage for the description of the structure.

Supplies the FrSE description for each element of this object that will be written to the stream.

◆ Describe() [2/3]

template<typename SE >
static void FrameCPP::Version_4::FrStatDataNPS::storage_type::Describe ( Common::Description Desc)
static

Supply description.

Parameters
[out]DescStorage for the description of the structure.

◆ Describe() [3/3]

template<typename SE >
static void FrameCPP::Version_4::FrStatDataNPS::storage_type::Describe ( Common::Description Desc)
static

Supply description.

Parameters
[out]DescStorage for the description of the structure.

◆ operator()() [1/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( Common::IStream Stream)
inline

Input elements from the stream.

Parameters
[in]StreamThe stream from which the elements are read.

◆ operator()() [2/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( Common::IStream Stream)

Input elements from the stream.

Parameters
[in]StreamThe stream from which the elements are read.

◆ operator()() [3/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( Common::IStream Stream)

Input elements from the stream.

Parameters
[in]StreamThe stream from which the elements are read.

◆ operator()() [4/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( Common::OStream Stream) const
inline

Output elements to the stream.

Parameters
[in]StreamThe stream to which the elements are written.

◆ operator()() [5/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( Common::OStream Stream) const

Output elements to the stream.

Parameters
[in]StreamThe stream to which the elements are written.

◆ operator()() [6/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( Common::OStream Stream) const

Output elements to the stream.

Parameters
[in]StreamThe stream to which the elements are written.

◆ operator()() [7/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( const FrStatDataNPS Source)
inline

Copy contents.

Parameters
[in]SourceSource to be copied

◆ operator()() [8/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( const FrStatDataNPS Source)

Copy contents.

Parameters
[in]SourceSource to be copied

◆ operator()() [9/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( const FrStatDataNPS Source)

Copy contents.

Parameters
[in]SourceSource to be copied

◆ operator()() [10/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( const Previous::FrStatDataStorage Source)
inline

Copy contents.

Parameters
[in]SourceSource to be copied
Todo:
Need to modify Version 3 FrStatData to follow NPS

◆ operator()() [11/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( const Previous::FrStatDataStorage Source)

Copy contents.

Parameters
[in]SourceSource to be copied
Todo:
Need to modify Version 3 FrStatData to follow NPS

◆ operator()() [12/12]

void FrameCPP::Version_4::FrStatDataNPS::storage_type::operator() ( const Previous::FrStatDataStorage Source)

Copy contents.

Parameters
[in]SourceSource to be copied
Todo:
Need to modify Version 3 FrStatData to follow NPS

◆ operator==() [1/3]

bool FrameCPP::Version_4::FrStatDataNPS::storage_type::operator== ( const storage_type RHS) const
inline

Comparison operator.

Tests the equality of the two FrTableNPS objects.

Parameters
[in]RHSObject to compare for equality.

◆ operator==() [2/3]

bool FrameCPP::Version_4::FrStatDataNPS::storage_type::operator== ( const storage_type RHS) const

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

◆ operator==() [3/3]

bool FrameCPP::Version_4::FrStatDataNPS::storage_type::operator== ( const storage_type RHS) const

Comparison operator.

Parameters
[in]RHSObject to compare for equality.

Friends And Related Function Documentation

◆ FrStatDataNPS

FrStatDataNPS
friend
Todo:
Needs documentation
Todo:
Needs documentation
Todo:
Needs documentation

Member Data Documentation

◆ comment

STRING FrameCPP::Version_4::FrStatDataNPS::storage_type::comment
private

Comment for static data.

◆ name

STRING FrameCPP::Version_4::FrStatDataNPS::storage_type::name
private

Static data name.

◆ representation

STRING FrameCPP::Version_4::FrStatDataNPS::storage_type::representation
private

Type of static data being represented. e,g., calibration, swept sine, pole-zero, FIR or IIR coefficients...

◆ timeEnd

timeEnd_type FrameCPP::Version_4::FrStatDataNPS::storage_type::timeEnd
private

End time of static data validity. A value of zero represents the end time being unknown. GPS time in integer seconds since GPS standard epoch.

◆ timeStart

timeStart_type FrameCPP::Version_4::FrStatDataNPS::storage_type::timeStart
private

Start time of static data validity. GPS time in integer seconds since GPS standard epoch.

◆ version

version_type FrameCPP::Version_4::FrStatDataNPS::storage_type::version
private

Version number for this static structure. i.e., the counter begins at 0 and is incremented by 1 thereafter. Updated statics for the same time window (e.g., modified calibration data) will be identified by identified by unique version numbers.


The documentation for this struct was generated from the following files: