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.

FrSummary &	Merge (const FrSummary &RHS)
	Merge with another FrSummary.

bool	operator== (const FrSummary &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type

	FrSummary ()=default
	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.

FrSummary &	Merge (const FrSummary &RHS)
	Merge with another FrSummary.

bool	operator== (const FrSummary &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type

virtual 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 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 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 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 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 streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

virtual void	Write (ostream_type &Stream) const
	Write object to the stream.

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_type &	RefMoments () const
	Identifier for vector containing statistical descriptors.

moments_type &	RefMoments ()
	Identifier for vector containing statistical descriptors.

const table_type &	RefTable () const
	Identifier for table containing additional summary information.

table_type &	RefTable ()
	Identifier for table containing additional summary information.

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 *	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 *	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 *	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 *	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 *	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 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 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 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 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 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 struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure.

static struct_id_type	FrameSpecId ()
	Return the dictionary name of the structure.

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_type *	pCreate (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	pCreate (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] Source The 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]	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.

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]	Source	An FrSummary structure from a previous frame specification.
[in]	Stream	The 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] Source The 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]	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.

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]	Source	An FrSummary structure from a previous frame specification.
[in]	Stream	The stream from which the earliest version of the FrSummary structure was read.

Returns: A new instance of the object.

Member Function Documentation

◆ Bytes() [1/12]

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] Stream Stream 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/12]

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] Stream Stream 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() [3/12]

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] Stream Stream 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() [4/12]

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] Stream Stream 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() [5/12]

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] Stream Stream 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() [6/12]

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] Stream Stream 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() [7/12]

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] Stream Stream 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() [8/12]

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] Stream Stream 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() [9/12]

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] Stream Stream 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() [10/12]

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] Stream Stream 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() [11/12]

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] Stream Stream 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() [12/12]

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] Stream Stream 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/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [2/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [3/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [4/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [5/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [6/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [7/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [8/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [9/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [10/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [11/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [12/12]

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The 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]	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.

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]	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.

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] RHS The 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] RHS The 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] RHS The 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] RHS The 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] RHS The 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] RHS The 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] Stream The 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] Stream The 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] Stream The 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] Stream The 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]	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.

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]	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.

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]	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.

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]	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.

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] Stream The 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] Stream The 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]	InfoClass	Class of information being requested.
[in]	vl	Variable 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]	InfoClass	Class of information being requested.
[in]	vl	Variable 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:

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version9/FrSummary.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version9/FrSummary.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FrSummary() [1/8]

◆ FrSummary() [2/8]

◆ FrSummary() [3/8]

◆ FrSummary() [4/8]

◆ FrSummary() [5/8]

◆ FrSummary() [6/8]

◆ FrSummary() [7/8]

◆ FrSummary() [8/8]

Member Function Documentation

◆ Bytes() [1/12]

◆ Bytes() [2/12]

◆ Bytes() [3/12]

◆ Bytes() [4/12]

◆ Bytes() [5/12]

◆ Bytes() [6/12]

◆ Bytes() [7/12]

◆ Bytes() [8/12]

◆ Bytes() [9/12]

◆ Bytes() [10/12]

◆ Bytes() [11/12]

◆ Bytes() [12/12]

◆ Create() [1/12]

◆ Create() [2/12]

◆ Create() [3/12]

◆ Create() [4/12]

◆ Create() [5/12]

◆ Create() [6/12]

◆ Create() [7/12]

◆ Create() [8/12]

◆ Create() [9/12]

◆ Create() [10/12]

◆ Create() [11/12]

◆ Create() [12/12]

◆ demote() [1/2]

◆ demote() [2/2]

◆ GetComment()

◆ GetDescription() [1/2]

◆ GetDescription() [2/2]

◆ GetGTime()

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetTest()

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ pBytes() [1/2]

◆ pBytes() [2/2]

◆ pCreate() [1/2]

◆ pCreate() [2/2]

◆ Promote() [1/2]

◆ Promote() [2/2]

◆ promote() [1/2]

◆ promote() [2/2]

◆ pWrite() [1/2]

◆ pWrite() [2/2]

◆ RefMoments() [1/2]

◆ RefMoments() [2/2]

◆ RefTable() [1/2]

◆ RefTable() [2/2]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]

◆ vTOCQuery() [1/2]

◆ vTOCQuery() [2/2]

Member Data Documentation

◆ table