Summary Data Structure Definition. More...

#include <FrSummary.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, FrameCPP::Common::TOCInfo, FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and FrameCPP::Common::TOCInfo.

Public Member Functions
	FrSummary ()
	Default constructor. More...

	FrSummary (const FrSummary &Source)
	Copy Constructor. More...

	FrSummary (const std::string &name, const std::string &comment, const std::string &test, const GPSTime &gtime)
	Constructor. More...

	FrSummary (Previous::FrSummary &Source, Common::IStream *Stream)
	Promotion Constructor. More...

virtual const char *	ObjectStructName () const
	The name structure name of this object. More...

const std::string &	GetName () const
	Return the name of summary statistic. More...

const std::string &	GetComment () const
	Return the comment. More...

const std::string &	GetTest () const
	Return the statistical test(s) used on raw data. More...

const GPSTime &	GetGTime () const
	Return the GPS time corresponding to this object. More...

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

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

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

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

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

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

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

	FrSummary ()
	Default constructor. More...

	FrSummary (const FrSummary &Source)
	Copy Constructor. More...

	FrSummary (const std::string &name, const std::string &comment, const std::string &test, const GPSTime &gtime)
	Constructor. More...

	FrSummary (Previous::FrSummary &Source, Common::IStream *Stream)
	Promotion Constructor. More...

virtual const char *	ObjectStructName () const
	The name structure name of this object. More...

const std::string &	GetName () const
	Return the name of summary statistic. More...

const std::string &	GetComment () const
	Return the comment. More...

const std::string &	GetTest () const
	Return the statistical test(s) used on raw data. More...

const GPSTime &	GetGTime () const
	Return the GPS time corresponding to this object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
	Promote previous version of object to this version. More...

static const char *	StructName ()
	The name structure name of this object. More...

static const Common::Description *	StructDescription ()
	The description of structure. More...

static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
	Promote previous version of object to this version. More...

static const char *	StructName ()
	The name structure name of this object. More...

static const Common::Description *	StructDescription ()
	The description of structure. More...

static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.

static const char *	CheckSumDataClass ()
	Data class to be used in class field of FrSE.

static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

static const char *	CheckSumDataComment ()
	Comment to be used in comment field of FrSE.

Protected Member Functions
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
	Demotes object to previous version of the frame spec. More...

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
	Promotes object to another version of the frame spec. More...

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

virtual FrSummary *	pCreate (Common::IStream &Stream) const
	Virtual constructor. More...

virtual void	pWrite (Common::OStream &Stream) const
	Write the structure to the stream. More...

virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC. More...

virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
	Demotes object to previous version of the frame spec. More...

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, Common::IStream *Stream) const
	Promotes object to another version of the frame spec. More...

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. More...

virtual FrSummary *	pCreate (Common::IStream &Stream) const
	Virtual constructor. More...

virtual void	pWrite (Common::OStream &Stream) const
	Write the structure to the stream. More...

virtual void	vTOCQuery (int InfoClass, va_list vl) const
	Answer requests for information as needed by TOC. More...

Detailed Description

Summary Data Structure Definition.

Constructor & Destructor Documentation

◆ FrSummary() [1/8]

FrSummary::FrSummary ( )

Default constructor.

Returns: A new instance of this object.

◆ FrSummary() [2/8]

FrSummary::FrSummary ( const FrSummary & Source )

Copy Constructor.

Parameters

[in] Source The object from which to copy the information.

Returns: A new instance of this object.

◆ FrSummary() [3/8]

FrSummary::FrSummary	(	const std::string &	name,
		const std::string &	comment,
		const std::string &	test,
		const GPSTime &	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]

FrSummary::FrSummary	(	Previous::FrSummary &	Source,
		Common::IStream *	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_8::FrSummary::FrSummary ( )

Default constructor.

Returns: A new instance of this object.

◆ FrSummary() [6/8]

FrameCPP::Version_8::FrSummary::FrSummary ( const FrSummary & Source )

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_8::FrSummary::FrSummary	(	const std::string &	name,
		const std::string &	comment,
		const std::string &	test,
		const GPSTime &	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_8::FrSummary::FrSummary	(	Previous::FrSummary &	Source,
		Common::IStream *	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/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] 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/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] 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/2]

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

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]

virtual demote_ret_type FrameCPP::Version_8::FrSummary::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		Common::IStream *	Stream
	)		const

protectedvirtual

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]

FrSummary::demote_ret_type FrSummary::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		Common::IStream *	Stream
	)		const

protectedvirtual

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() [1/2]

const std::string & FrameCPP::Version_8::FrSummary::GetComment ( ) const

inline

Return the comment.

Returns: The comment.

◆ GetComment() [2/2]

const std::string& FrameCPP::Version_8::FrSummary::GetComment ( ) const

Return the comment.

Returns: The comment.

◆ GetGTime() [1/2]

const GPSTime & FrameCPP::Version_8::FrSummary::GetGTime ( ) const

inline

Return the GPS time corresponding to this object.

Returns: The GPS time corresponding to this object.

◆ GetGTime() [2/2]

const GPSTime& FrameCPP::Version_8::FrSummary::GetGTime ( ) const

Return the GPS time corresponding to this object.

Returns: The GPS time corresponding to this object.

◆ GetName() [1/2]

const std::string & FrSummary::GetName ( ) const

Return the name of summary statistic.

Returns: The name of summary statistic.

◆ GetName() [2/2]

const std::string& FrameCPP::Version_8::FrSummary::GetName ( ) const

Return the name of summary statistic.

Returns: The name of summary statistic.

◆ GetTest() [1/2]

const std::string & FrameCPP::Version_8::FrSummary::GetTest ( ) const

inline

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

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

◆ GetTest() [2/2]

const std::string& FrameCPP::Version_8::FrSummary::GetTest ( ) const

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] RHS The source of the information to append to this FrSummary structure.

Returns: A reference to this object

◆ Merge() [2/2]

FrSummary & 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

Todo:: Need to implement Merge routine

◆ ObjectStructName() [1/2]

const char * FrSummary::ObjectStructName ( ) const

virtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

virtual const char* FrameCPP::Version_8::FrSummary::ObjectStructName ( ) const

virtual

The name structure name of this object.

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

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrSummary::operator== ( const FrSummary & RHS ) const

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==() [2/4]

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

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

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

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrSummary::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

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.

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

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrSummary::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

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.

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

◆ pCreate() [1/2]

virtual FrSummary* FrameCPP::Version_8::FrSummary::pCreate ( Common::IStream & Stream ) const

protectedvirtual

Virtual constructor.

Parameters

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

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

◆ pCreate() [2/2]

FrSummary * FrSummary::pCreate ( Common::IStream & Stream ) const

protectedvirtual

Virtual constructor.

Parameters

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

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

◆ Promote() [1/2]

static promote_ret_type FrameCPP::Version_8::FrSummary::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		Common::IStream *	Stream
	)

static

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]

FrSummary::promote_ret_type FrameCPP::Version_8::FrSummary::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		Common::IStream *	Stream
	)

inlinestatic

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]

FrSummary::promote_ret_type FrSummary::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		Common::IStream *	Stream
	)		const

protectedvirtual

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]

virtual promote_ret_type FrameCPP::Version_8::FrSummary::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		Common::IStream *	Stream
	)		const

protectedvirtual

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]

void FrSummary::pWrite ( Common::OStream & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrSummary::pWrite ( Common::OStream & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ RefMoments() [1/4]

const FrSummary::moments_type & FrameCPP::Version_8::FrSummary::RefMoments ( ) const

inline

Identifier for vector containing statistical descriptors.

Returns: A constant reference to the statistical descriptors.

◆ RefMoments() [2/4]

const moments_type& FrameCPP::Version_8::FrSummary::RefMoments ( ) const

Identifier for vector containing statistical descriptors.

Returns: A constant reference to the statistical descriptors.

◆ RefMoments() [3/4]

moments_type& FrameCPP::Version_8::FrSummary::RefMoments ( )

Identifier for vector containing statistical descriptors.

Returns: A reference to the statistical descriptors.

◆ RefMoments() [4/4]

FrSummary::moments_type & FrameCPP::Version_8::FrSummary::RefMoments ( )

inline

Identifier for vector containing statistical descriptors.

Returns: A reference to the statistical descriptors.

◆ RefTable() [1/4]

const table_type& FrameCPP::Version_8::FrSummary::RefTable ( ) const

Identifier for table containing additional summary information.

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

◆ RefTable() [2/4]

const FrSummary::table_type & FrameCPP::Version_8::FrSummary::RefTable ( ) const

inline

Identifier for table containing additional summary information.

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

◆ RefTable() [3/4]

table_type& FrameCPP::Version_8::FrSummary::RefTable ( )

Identifier for table containing additional summary information.

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

◆ RefTable() [4/4]

FrSummary::table_type & FrameCPP::Version_8::FrSummary::RefTable ( )

inline

Identifier for table containing additional summary information.

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

◆ StructDescription() [1/2]

static const Common::Description* FrameCPP::Version_8::FrSummary::StructDescription ( )

static

The description of structure.

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

◆ StructDescription() [2/2]

const Description * FrSummary::StructDescription ( )

static

The description of structure.

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

◆ StructName() [1/2]

static const char* FrameCPP::Version_8::FrSummary::StructName ( )

static

The name structure name of this object.

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

◆ StructName() [2/2]

const char * FrameCPP::Version_8::FrSummary::StructName ( )

inlinestatic

The name structure name of this object.

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

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_8::FrSummary::vTOCQuery	(	int	InfoClass,
		va_list	vl
	)		const

protectedvirtual

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]

virtual void FrameCPP::Version_8::FrSummary::vTOCQuery	(	int	InfoClass,
		va_list	vl
	)		const

protectedvirtual

Answer requests for information as needed by TOC.

Parameters

[in]	InfoClass	Class of information being requested.
[in]	vl	Variable argument list of requested data.

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrSummary.hh
Version8/FrSummary.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

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

◆ Bytes() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ demote() [1/2]

◆ demote() [2/2]

◆ GetComment() [1/2]

◆ GetComment() [2/2]

◆ GetGTime() [1/2]

◆ GetGTime() [2/2]

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetTest() [1/2]

◆ GetTest() [2/2]

◆ 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/4]

◆ RefMoments() [2/4]

◆ RefMoments() [3/4]

◆ RefMoments() [4/4]

◆ RefTable() [1/4]

◆ RefTable() [2/4]

◆ RefTable() [3/4]

◆ RefTable() [4/4]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]

◆ StructName() [1/2]

◆ StructName() [2/2]

◆ vTOCQuery() [1/2]

◆ vTOCQuery() [2/2]