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

Summary Data Structure Definition. More...

#include <FrSummary.hh>

Public Member Functions

 FrSummary ()=default
 Default constructor.
 
 FrSummary (const FrSummary &Source)=default
 Copy Constructor.
 
 FrSummary (const name_type &name, const comment_type &comment, const test_type &test, const gtime_type &gtime)
 Constructor.
 
 FrSummary (Previous::FrSummary &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const name_type & GetName () const
 Return the name of summary statistic.
 
FrSummaryMerge (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
 Default constructor.
 
 FrSummary (const FrSummary &Source)=default
 Copy Constructor.
 
 FrSummary (const name_type &name, const comment_type &comment, const test_type &test, const gtime_type &gtime)
 Constructor.
 
 FrSummary (Previous::FrSummary &Source, stream_base_type *Stream)
 Promotion Constructor.
 
const name_type & GetName () const
 Return the name of summary statistic.
 
FrSummaryMerge (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 const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
virtual const Common::Description * GetDescription (ostream_type &Stream) const
 The data structure description.
 
virtual const Common::Description * GetDescription (ostream_type &Stream) const
 The data structure description.
 
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 comment_type & GetComment () const
 Return the comment.
 
const test_type & GetTest () const
 Return the statistical test(s) used on raw data.
 
const gtime_type & GetGTime () const
 Return the GPS time corresponding to this object.
 
const moments_typeRefMoments () const
 Identifier for vector containing statistical descriptors.
 
moments_typeRefMoments ()
 Identifier for vector containing statistical descriptors.
 
const table_typeRefTable () const
 Identifier for table containing additional summary information.
 
table_typeRefTable ()
 Identifier for table containing additional summary information.
 

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 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::Description * StructDescription ()
 The description of structure.
 
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.
 

Protected Member Functions

virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
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
 Demotes object to previous version of the frame spec.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *Stream) const
 Promotes object to another version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, promote_stream_type *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.
 
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 self_typepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 

Protected Attributes

name_type name
 Name of summary statistic.
 
comment_type comment
 Comment.
 
test_type test
 Statistical test(s) used on raw data.
 
gtime_type gtime
 GPS time corresponding to this object.
 
moments_type moments
 Identifier for vector containing statistical descriptors.
 
table_type table
 

Detailed Description

Summary Data Structure Definition.

Constructor & Destructor Documentation

◆ FrSummary() [1/8]

FrameCPP::Version_9::FrSummary::FrSummary ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrSummary() [2/8]

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

Copy Constructor.

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

◆ FrSummary() [3/8]

FrameCPP::Version_9::FrSummary::FrSummary ( const name_type & name,
const comment_type & comment,
const test_type & test,
const gtime_type & gtime )

Constructor.

Parameters
[in]nameName of summary statistic.
[in]commentComment.
[in]testStatistical test(s) used on raw data.
[in]gtimeGPS time corresponding to this FrSummary.
Returns
A new instance of the object.

◆ FrSummary() [4/8]

FrameCPP::Version_9::FrSummary::FrSummary ( Previous::FrSummary & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrSummary structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrSummary structure was read.
Returns
A new instance of the object.

◆ FrSummary() [5/8]

FrameCPP::Version_9::FrSummary::FrSummary ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrSummary() [6/8]

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

Copy Constructor.

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

◆ FrSummary() [7/8]

FrameCPP::Version_9::FrSummary::FrSummary ( const name_type & name,
const comment_type & comment,
const test_type & test,
const gtime_type & gtime )

Constructor.

Parameters
[in]nameName of summary statistic.
[in]commentComment.
[in]testStatistical test(s) used on raw data.
[in]gtimeGPS time corresponding to this FrSummary.
Returns
A new instance of the object.

◆ FrSummary() [8/8]

FrameCPP::Version_9::FrSummary::FrSummary ( Previous::FrSummary & Source,
stream_base_type * Stream )

Promotion Constructor.

Parameters
[in]SourceAn FrSummary structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrSummary structure was read.
Returns
A new instance of the object.

Member Function Documentation

◆ Bytes() [1/2]

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

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

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

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

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

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

template<typename T >
virtual demote_ret_type FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::demote ( INT_2U Target,
demote_arg_type Obj,
demote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Demotes object to previous version of the frame spec.

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.

◆ GetComment()

const comment_type & FrameCPP::Version_9::FrSummaryImpl::Data::GetComment ( ) const
inlineinherited

Return the comment.

Returns
The comment.

◆ GetDescription() [1/2]

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::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

◆ GetDescription() [2/2]

template<typename T >
virtual const Common::Description * FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::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

◆ GetGTime()

const gtime_type & FrameCPP::Version_9::FrSummaryImpl::Data::GetGTime ( ) const
inlineinherited

Return the GPS time corresponding to this object.

Returns
The GPS time corresponding to this object.

◆ GetName() [1/2]

const name_type & FrameCPP::Version_9::FrSummary::GetName ( ) const

Return the name of summary statistic.

Returns
The name of summary statistic.

◆ GetName() [2/2]

const name_type & FrameCPP::Version_9::FrSummary::GetName ( ) const

Return the name of summary statistic.

Returns
The name of summary statistic.

◆ GetTest()

const test_type & FrameCPP::Version_9::FrSummaryImpl::Data::GetTest ( ) const
inlineinherited

Return the statistical test(s) used on raw data.

Returns
The the statistical test(s) used on raw data.

◆ Merge() [1/2]

FrSummary & FrameCPP::Version_9::FrSummary::Merge ( const FrSummary & RHS)

Merge with another FrSummary.

Parameters
[in]RHSThe source of the information to append to this FrSummary structure.
Returns
A reference to this object

◆ Merge() [2/2]

FrSummary & FrameCPP::Version_9::FrSummary::Merge ( const FrSummary & RHS)

Merge with another FrSummary.

Parameters
[in]RHSThe source of the information to append to this FrSummary structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

template<typename T >
virtual const char * FrameCPP::Version_9::FrSummaryImpl::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/2]

template<typename T >
virtual const char * FrameCPP::Version_9::FrSummaryImpl::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/4]

virtual bool FrameCPP::Version_9::FrSummary::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/4]

virtual bool FrameCPP::Version_9::FrSummary::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/4]

bool FrameCPP::Version_9::FrSummary::operator== ( const FrSummary & RHS) const
inline

equality operator

Parameters
[in]RHSThe FrSummary object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_9::FrSummary::operator== ( const FrSummary & RHS) const
inline

equality operator

Parameters
[in]RHSThe FrSummary object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ pBytes() [1/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrSummaryImpl::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/2]

template<typename T >
cmn_streamsize_type FrameCPP::Version_9::FrSummaryImpl::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/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ pCreate() [2/2]

template<typename T >
virtual self_type * FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.

◆ Promote() [1/2]

template<typename T >
static promote_ret_type FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::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() [2/2]

template<typename T >
static promote_ret_type FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::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() [1/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

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

◆ promote() [2/2]

template<typename T >
virtual promote_ret_type FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::promote ( INT_2U Target,
promote_arg_type Obj,
promote_stream_type * Stream ) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

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

◆ pWrite() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ pWrite() [2/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ RefMoments() [1/2]

moments_type & FrameCPP::Version_9::FrSummaryImpl::Data::RefMoments ( )
inlineinherited

Identifier for vector containing statistical descriptors.

Returns
A reference to the statistical descriptors.

◆ RefMoments() [2/2]

const moments_type & FrameCPP::Version_9::FrSummaryImpl::Data::RefMoments ( ) const
inlineinherited

Identifier for vector containing statistical descriptors.

Returns
A constant reference to the statistical descriptors.

◆ RefTable() [1/2]

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

Identifier for table containing additional summary information.

Returns
A reference to the table containing additional summary Information.

◆ RefTable() [2/2]

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

Identifier for table containing additional summary information.

Returns
A constant reference to the table containing additional summary Information.

◆ StructDescription() [1/2]

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

The description of structure.

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

◆ StructDescription() [2/2]

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

The description of structure.

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

◆ vTOCQuery() [1/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSummaryImpl::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/2]

template<typename T >
virtual void FrameCPP::Version_9::FrSummaryImpl::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

◆ table

table_type FrameCPP::Version_9::FrSummaryImpl::Data::table
protectedinherited

Indentifier for table containing additional summary information.


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