ldas-tools-framecpp
2.7.0
|
Summary Data Structure Definition. More...
#include <FrSummary.hh>
Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.
Public Member Functions | |
FrSummary () | |
Default constructor. More... | |
FrSummary (const FrSummary &Source) | |
Copy Constructor. More... | |
FrSummary (const std::string &name, const std::string &comment, const std::string &test, const GPSTime >ime) | |
Constructor. More... | |
FrSummary (Previous::FrSummary &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 summary statistic. More... | |
const std::string & | GetComment () const |
Return the comment. More... | |
const std::string & | GetTest () const |
Return the statistical test(s) used on raw data. More... | |
const GPSTime & | GetGTime () const |
Return the GPS time corresponding to this object. More... | |
const moments_type & | RefMoments () const |
Identifier for vector containing statistical descriptors. More... | |
moments_type & | RefMoments () |
Identifier for vector containing statistical descriptors. More... | |
const table_type & | RefTable () const |
Identifier for table containing additional summary information. More... | |
table_type & | RefTable () |
Identifier for table containing additional summary information. More... | |
FrSummary & | Merge (const FrSummary &RHS) |
Merge with another FrSummary. More... | |
bool | operator== (const FrSummary &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
FrSummary () | |
Default constructor. More... | |
FrSummary (const FrSummary &Source) | |
Copy Constructor. More... | |
FrSummary (const std::string &name, const std::string &comment, const std::string &test, const GPSTime >ime) | |
Constructor. More... | |
FrSummary (Previous::FrSummary &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 summary statistic. More... | |
const std::string & | GetComment () const |
Return the comment. More... | |
const std::string & | GetTest () const |
Return the statistical test(s) used on raw data. More... | |
const GPSTime & | GetGTime () const |
Return the GPS time corresponding to this object. More... | |
const moments_type & | RefMoments () const |
Identifier for vector containing statistical descriptors. More... | |
moments_type & | RefMoments () |
Identifier for vector containing statistical descriptors. More... | |
const table_type & | RefTable () const |
Identifier for table containing additional summary information. More... | |
table_type & | RefTable () |
Identifier for table containing additional summary information. More... | |
FrSummary & | Merge (const FrSummary &RHS) |
Merge with another FrSummary. More... | |
bool | operator== (const FrSummary &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type 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_type * | Create (istream_type &Stream) const |
Virtual constructor. More... | |
virtual self_type * | Create (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 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 * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. 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 FrSummary * | pCreate (Common::IStream &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. 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, 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 FrSummary * | pCreate (Common::IStream &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (Common::OStream &Stream) const |
Write the structure to the stream. More... | |
virtual void | vTOCQuery (int InfoClass, va_list vl) const |
Answer requests for information as needed by TOC. More... | |
Summary Data Structure Definition.
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 | ||
) |
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 | ||
) |
|
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. |
|
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. |
|
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.
bool FrameCPP::Version_8::FrSummary::operator== | ( | const FrSummary & | RHS | ) | const |
equality operator
[in] | RHS | The FrSummary object to be compared. |
|
inline |
equality operator
[in] | RHS | The FrSummary object to be compared. |
|
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. |
|
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, checksum_type >.
|
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, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
static |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
inlinestatic |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
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, checksum_type >.
|
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, checksum_type >.
|
inline |
Identifier for vector containing statistical descriptors.
const moments_type& FrameCPP::Version_8::FrSummary::RefMoments | ( | ) | const |
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 table_type& FrameCPP::Version_8::FrSummary::RefTable | ( | ) | const |
Identifier for table containing additional summary information.
|
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.
|
static |
The description of structure.
|
static |
The description of structure.
|
static |
The name structure name of this object.
|
inlinestatic |
The name structure name of this object.
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |
|
protectedvirtual |
Answer requests for information as needed by TOC.
[in] | InfoClass | Class of information being requested. |
[in] | vl | Variable argument list of requested data. |