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

Summary Data Structure Definition. More...

#include <FrSummary.hh>

Inheritance diagram for FrameCPP::Version_8::FrSummary:
Collaboration diagram for FrameCPP::Version_8::FrSummary:

Public Types

typedef Common::SearchContainer< FrVect, &FrVect::GetName > moments_type
 
typedef moments_type::iterator iterator
 
typedef moments_type::const_iterator const_iterator
 
typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > table_type
 
typedef table_type::iterator table_iterator
 
typedef table_type::const_iterator const_table_iterator
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeself_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef boost::shared_ptr< Objectobject_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef stream_base_type demote_stream_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef stream_base_type promote_stream_type
 
typedef FR_SUMMARY_NAME_TYPE name_type
 
typedef FR_SUMMARY_COMMENT_TYPE comment_type
 
typedef FR_SUMMARY_TEST_TYPE test_type
 
typedef GPSTime gtime_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 

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_typeGetName () 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_typeGetName () 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.
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 
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.
 
class_type GetClass () const
 Retrieve the class identifier.
 
class_type GetClass () const
 Retrieve the class identifier.
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
virtual const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object.
 
virtual const DescriptionGetDescription (ostream_type &Stream) const
 
frame_spec_version_type FrameSpecVersion () const
 
frame_spec_version_type FrameSpecVersion () const
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream.
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
virtual ObjectClone () const
 constructor - virtual copy constructor
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object.
 
const comment_typeGetComment () const
 Return the comment.
 
const test_typeGetTest () const
 Return the statistical test(s) used on raw data.
 
const gtime_typeGetGTime () 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.
 
bool operator== (const Data &RHS) const
 

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::DescriptionStructDescription ()
 The description of structure.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
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)
 
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 object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type DemoteObject (frame_spec_version_type Target, object_type Obj, demote_stream_type *Stream)
 Down grade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, stream_base_type *Stream)
 Upgrade an object.
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
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 Public Attributes

static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

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.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 
virtual class_type getClass () const
 Retrieve the class identifier.
 

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
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 3 }
 

Private Types

typedef STRING io_name_type
 
typedef STRING io_comment_type
 
typedef STRING io_test_type
 
typedef INT_4U io_gtimes_type
 
typedef INT_4U io_gtimen_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

checksum_type m_chkSum
 Structure checksum.
 
const class_type m_class
 Storage for the class identifier.
 
const Description *const m_desc
 Description for parent class.
 
const frame_spec_version_type frame_spec_version
 Version of the frame specification.
 

Detailed Description

Summary Data Structure Definition.

Member Typedef Documentation

◆ comment_type

◆ const_iterator

typedef moments_type::const_iterator FrameCPP::Version_8::FrSummary::const_iterator

◆ const_table_iterator

typedef table_type::const_iterator FrameCPP::Version_8::FrSummary::const_table_iterator

◆ demote_arg_type

◆ demote_ret_type

◆ demote_stream_type

◆ frame_spec_version_type

◆ gtime_type

◆ io_comment_type

typedef STRING FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::io_comment_type
privateinherited

◆ io_gtimen_type

typedef INT_4U FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::io_gtimen_type
privateinherited

◆ io_gtimes_type

typedef INT_4U FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::io_gtimes_type
privateinherited

◆ io_name_type

typedef STRING FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::io_name_type
privateinherited

◆ io_test_type

typedef STRING FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::io_test_type
privateinherited

◆ istream_type

◆ iterator

typedef moments_type::iterator FrameCPP::Version_8::FrSummary::iterator

◆ moments_type

typedef Common::SearchContainer< FrVect, &FrVect::GetName > FrameCPP::Version_8::FrSummary::moments_type

◆ name_type

◆ object_base_type

◆ object_type

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type
inherited

◆ ostream_type

◆ promote_arg_type

◆ promote_ret_type

◆ promote_stream_type

◆ self_type

◆ string_2_type

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ struct_desc_type

template<typename Object_T >
typedef const char *const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

template<typename Object_T >
typedef const char *const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ table_iterator

typedef table_type::iterator FrameCPP::Version_8::FrSummary::table_iterator

◆ table_type

typedef Common::SearchContainer< FrTable, &FrTable::GetNameSlow > FrameCPP::Version_8::FrSummary::table_type

◆ test_type

◆ unique_object_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

Constructor & Destructor Documentation

◆ FrSummary() [1/8]

FrameCPP::Version_8::FrSummary::FrSummary ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrSummary() [2/8]

FrameCPP::Version_8::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_8::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_8::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_8::FrSummary::FrSummary ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrSummary() [6/8]

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

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Bytes() [2/2]

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ CheckSumDataClass() [1/2]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Clone() [2/2]

virtual Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT< DC, DI, SPEC_VERSION_T >, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_8::FrSHImpl::ClassicIO< FrSH >, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrameH, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< BASE_TYPE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSEImpl::ClassicIO< FrSE >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FR_SH_T >, FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >, and FrameCPP::Version_9::FrSHImpl::ClassicIO< FrSH >.

◆ Create() [1/6]

◆ Create() [2/6]

◆ Create() [3/6]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [4/6]

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [5/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [6/6]

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DataType() [1/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote() [1/2]

virtual demote_ret_type FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type Target,
object_type Obj,
demote_stream_type * Stream )
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ FrameSpecDescription()

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId()

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName()

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecVersion() [1/2]

FrameSpec::Object::frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inlineinherited

◆ FrameSpecVersion() [2/2]

frame_spec_version_type FrameCPP::Common::FrameSpec::Object::FrameSpecVersion ( ) const
inherited

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetComment()

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

Return the comment.

Returns
The comment.

◆ GetDescription() [1/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [3/4]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream) const
virtualinherited

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Reimplemented in FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ GetDescription() [4/4]

virtual const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ostream_type & Stream) const
virtualinherited

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

Reimplemented in FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrAdcDataImpl::ClassicIO< FrAdcData >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< T >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrDetectorImpl::ClassicIO< FrDetector >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrEventImpl::ClassicIO< FrEvent >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< T >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrHistoryImpl::ClassicIO< FrHistory >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< T >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrMsgImpl::ClassicIO< FrMsg >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrProcDataImpl::ClassicIO< FrProcData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrRawDataImpl::ClassicIO< FrRawData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSerDataImpl::ClassicIO< FrSerData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimDataImpl::ClassicIO< FrSimData >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< T >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSimEventImpl::ClassicIO< FrSimEvent >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< T >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrSummaryImpl::ClassicIO< FrSummary >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< T >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrTableImpl::ClassicIO< FrTable >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ GetGTime()

const gtime_type & FrameCPP::Version_8::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_8::FrSummary::GetName ( ) const

Return the name of summary statistic.

Returns
The name of summary statistic.

◆ GetName() [2/2]

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

Return the name of summary statistic.

Returns
The name of summary statistic.

◆ GetTest()

const test_type & FrameCPP::Version_8::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_8::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_8::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]

virtual const char * FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/2]

virtual const char * FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/5]

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [2/5]

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [3/5]

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

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

bool FrameCPP::Version_8::FrSummaryImpl::Data::operator== ( const Data & RHS) const
inlineinherited

◆ pBytes() [1/2]

cmn_streamsize_type FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::pBytes ( const Common::StreamBase & Stream) const
inlineprotectedvirtualinherited

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.

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ pCreate() [1/2]

virtual self_type * FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ pCreate() [2/2]

virtual self_type * FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::pCreate ( istream_type & Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ Promote() [1/2]

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]

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]

virtual promote_ret_type FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/5]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/5]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/5]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/5]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type Target,
frame_spec_version_type Source,
object_type Obj,
stream_base_type * Stream )
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [5/5]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type Target,
FrameSpec::ObjectInterface::frame_spec_version_type Source,
FrameSpec::ObjectInterface::promote_arg_type Obj,
promote_stream_type * Stream )
inherited

◆ pWrite() [1/2]

virtual void FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::pWrite ( Common::OStream & Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >.

◆ RefMoments() [1/2]

moments_type & FrameCPP::Version_8::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_8::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_8::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_8::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]

static const Common::Description * FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::StructDescription ( )
inlinestaticinherited

The description of structure.

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

◆ StructName()

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ VerifyObject() [1/2]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify & Verifier,
IFrameStream & Stream ) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ VerifyObject() [2/2]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify & Verifier,
IFrameStream & Stream ) const
virtualinherited

Verify an object.

Parameters
[in,out]VerifierSet of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]StreamThe stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< T >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_8::FrVectImpl::ClassicIO< FrVect >, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< T >, FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >, and FrameCPP::Version_9::FrVectImpl::ClassicIO< FrVect >.

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::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.

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_8::FrSummaryImpl::ClassicIO< FrSummary >::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.

Implements FrameCPP::Common::TOCInfo.

◆ Write() [1/2]

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/2]

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

◆ WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

Member Data Documentation

◆ comment

comment_type FrameCPP::Version_8::FrSummaryImpl::Data::comment
protectedinherited

Comment.

◆ frame_spec_version

const frame_spec_version_type FrameCPP::Common::FrameSpec::Object::frame_spec_version
privateinherited

Version of the frame specification.

The version of the frame specification for which this object was created.

◆ gtime

gtime_type FrameCPP::Version_8::FrSummaryImpl::Data::gtime
protectedinherited

GPS time corresponding to this object.

◆ m_chkSum

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_8::FrSummaryImpl::Data::MAX_REF { 3 }
staticconstexprprotectedinherited

◆ moments

moments_type FrameCPP::Version_8::FrSummaryImpl::Data::moments
protectedinherited

Identifier for vector containing statistical descriptors.

◆ name

name_type FrameCPP::Version_8::FrSummaryImpl::Data::name
protectedinherited

Name of summary statistic.

◆ struct_desc

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ table

table_type FrameCPP::Version_8::FrSummaryImpl::Data::table
protectedinherited

Indentifier for table containing additional summary information.

◆ test

test_type FrameCPP::Version_8::FrSummaryImpl::Data::test
protectedinherited

Statistical test(s) used on raw data.


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