ldas-tools-framecpp 2.7.0
|
Summary Data Structure Definition. More...
#include <FrSummary.hh>
Classes | |
struct | fr_summary_data_type |
Public Member Functions | |
FrSummary () | |
Default constructor. | |
FrSummary (const FrSummary &Source) | |
Copy Constructor. | |
FrSummary (const std::string &name, const std::string &comment, const std::string &test, const GPSTime >ime) | |
Constructor. | |
FrSummary (Previous::FrSummary &Source, Common::IStream *Stream) | |
Promotion Constructor. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
const std::string & | GetName () const |
Return the name of summary statistic. | |
const std::string & | GetComment () const |
Return the comment. | |
const std::string & | GetTest () const |
Return the statistical test(s) used on raw data. | |
const GPSTime & | GetGTime () const |
Return the GPS time corresponding to this object. | |
const moments_type & | RefMoments () const |
Identifier for vector containing statistical descriptors. | |
moments_type & | RefMoments () |
Identifier for vector containing statistical descriptors. | |
const table_type & | RefTable () const |
Identifier for table containing additional summary information. | |
table_type & | RefTable () |
Identifier for table containing additional summary information. | |
FrSummary & | Merge (const FrSummary &RHS) |
Merge with another FrSummary. | |
bool | operator== (const FrSummary &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
FrSummary () | |
Default constructor. | |
FrSummary (const FrSummary &Source) | |
Copy Constructor. | |
FrSummary (const std::string &name, const std::string &comment, const std::string &test, const GPSTime >ime) | |
Constructor. | |
FrSummary (Previous::FrSummary &Source, Common::IStream *Stream) | |
Promotion Constructor. | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. | |
const std::string & | GetName () const |
Return the name of summary statistic. | |
const std::string & | GetComment () const |
Return the comment. | |
const std::string & | GetTest () const |
Return the statistical test(s) used on raw data. | |
const GPSTime & | GetGTime () const |
Return the GPS time corresponding to this object. | |
const moments_type & | RefMoments () const |
Identifier for vector containing statistical descriptors. | |
moments_type & | RefMoments () |
Identifier for vector containing statistical descriptors. | |
const table_type & | RefTable () const |
Identifier for table containing additional summary information. | |
table_type & | RefTable () |
Identifier for table containing additional summary information. | |
FrSummary & | Merge (const FrSummary &RHS) |
Merge with another FrSummary. | |
bool | operator== (const FrSummary &RHS) const |
equality operator | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual streamsize_type | Bytes (const StreamBase &Stream) const |
Return the number of bytes for this object. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
void | TOCQuery (int InfoClass,...) const |
void | TOCQuery (int InfoClass,...) const |
Static Public Member Functions | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream) |
Promote previous version of object to this version. | |
static const char * | StructName () |
The name structure name of this object. | |
static const Common::Description * | StructDescription () |
The description of structure. | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream) |
Promote previous version of object to this version. | |
static const char * | StructName () |
The name structure name of this object. | |
static const Common::Description * | StructDescription () |
The description of 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 * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
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) |
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. | |
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. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual FrSummary * | pCreate (Common::IStream &Stream) const |
Virtual constructor. | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. | |
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, Common::IStream *Stream) const |
Demotes object to previous version of the frame spec. | |
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. | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual FrSummary * | pCreate (Common::IStream &Stream) const |
Virtual constructor. | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. | |
Private Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
Object with checksum data. | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
Object with checksum data. | |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
FrSummary (Common::IStream &Stream) | |
Stream Constructor. | |
FrSummary (Common::IStream &Stream) | |
Stream Constructor. | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
Private Attributes | |
fr_summary_data_type | m_data |
ChecksumType | m_chkSum |
Structure checksum. | |
Summary Data Structure Definition.
typedef moments_type::const_iterator FrameCPP::Version_8::FrSummary::const_iterator |
typedef moments_type::const_iterator FrameCPP::Version_8::FrSummary::const_iterator |
typedef table_type::const_iterator FrameCPP::Version_8::FrSummary::const_table_iterator |
typedef table_type::const_iterator FrameCPP::Version_8::FrSummary::const_table_iterator |
|
inherited |
|
inherited |
typedef moments_type::iterator FrameCPP::Version_8::FrSummary::iterator |
typedef moments_type::iterator FrameCPP::Version_8::FrSummary::iterator |
typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrSummary::moments_type |
typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrSummary::moments_type |
|
privateinherited |
|
privateinherited |
|
private |
Object with checksum data.
|
private |
Object with checksum data.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
typedef table_type::iterator FrameCPP::Version_8::FrSummary::table_iterator |
typedef table_type::iterator FrameCPP::Version_8::FrSummary::table_iterator |
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrSummary::table_type |
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrSummary::table_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
FrSummary::FrSummary | ( | ) |
Default constructor.
FrSummary::FrSummary | ( | const FrSummary & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrSummary::FrSummary | ( | const std::string & | name, |
const std::string & | comment, | ||
const std::string & | test, | ||
const GPSTime & | gtime ) |
Constructor.
[in] | name | Name of summary statistic. |
[in] | comment | Comment. |
[in] | test | Statistical test(s) used on raw data. |
[in] | gtime | GPS time corresponding to this FrSummary. |
FrSummary::FrSummary | ( | Previous::FrSummary & | Source, |
Common::IStream * | Stream ) |
|
private |
Stream Constructor.
[in] | Stream | The stream from which the object is being read. |
FrameCPP::Version_8::FrSummary::FrSummary | ( | ) |
Default constructor.
FrameCPP::Version_8::FrSummary::FrSummary | ( | const FrSummary & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_8::FrSummary::FrSummary | ( | const std::string & | name, |
const std::string & | comment, | ||
const std::string & | test, | ||
const GPSTime & | gtime ) |
Constructor.
[in] | name | Name of summary statistic. |
[in] | comment | Comment. |
[in] | test | Statistical test(s) used on raw data. |
[in] | gtime | GPS time corresponding to this FrSummary. |
FrameCPP::Version_8::FrSummary::FrSummary | ( | Previous::FrSummary & | Source, |
Common::IStream * | Stream ) |
|
private |
Stream Constructor.
[in] | Stream | The stream from which the object is being read. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[in] | Target | The version of the frame specification to demote too. |
[in] | Obj | The version of the object to demote. |
[in] | Stream | The input stream from which the original object was read. |
|
inline |
Return the comment.
const std::string & FrameCPP::Version_8::FrSummary::GetComment | ( | ) | const |
Return the comment.
|
inline |
Return the GPS time corresponding to this object.
const GPSTime & FrameCPP::Version_8::FrSummary::GetGTime | ( | ) | const |
Return the GPS time corresponding to this object.
const std::string & FrSummary::GetName | ( | ) | const |
Return the name of summary statistic.
const std::string & FrameCPP::Version_8::FrSummary::GetName | ( | ) | const |
Return the name of summary statistic.
|
inline |
Return the statistical test(s) used on raw data.
const std::string & FrameCPP::Version_8::FrSummary::GetTest | ( | ) | const |
Return the statistical test(s) used on raw data.
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrSummary object to be compared. |
bool FrameCPP::Version_8::FrSummary::operator== | ( | const FrSummary & | RHS | ) | const |
equality operator
[in] | RHS | The FrSummary object to be compared. |
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inlinestatic |
|
static |
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Target | The version of the promoted frame specification. |
[in] | Obj | The object to be promoted. |
[in] | Stream | The input stream from which the original object was read. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
inline |
Identifier for vector containing statistical descriptors.
moments_type & FrameCPP::Version_8::FrSummary::RefMoments | ( | ) |
Identifier for vector containing statistical descriptors.
|
inline |
Identifier for vector containing statistical descriptors.
const moments_type & FrameCPP::Version_8::FrSummary::RefMoments | ( | ) | const |
Identifier for vector containing statistical descriptors.
|
inline |
Identifier for table containing additional summary information.
table_type & FrameCPP::Version_8::FrSummary::RefTable | ( | ) |
Identifier for table containing additional summary information.
|
inline |
Identifier for table containing additional summary information.
const table_type & FrameCPP::Version_8::FrSummary::RefTable | ( | ) | const |
Identifier for table containing additional summary information.
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
|
inlineinherited |
|
inherited |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
Implements FrameCPP::Common::TOCInfo.
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
private |