Table Data Structure Definition. More...

#include <FrTable.hh>

Public Member Functions
	FrTable ()
	Default constructor.

	FrTable (const FrTable &Source)
	Copy Constructor.

	FrTable (const name_type &name, nRow_type nrows)
	Constructor.

	FrTable (Previous::FrTable &Source, stream_base_type *Stream)
	Promotion Constructor.

virtual	~FrTable ()
	Destructor.

const name_type &	GetNameSlow () const
	Retrieve the name of the table.

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

FrTable &	operator+= (const FrTable &RHS)
	Concatinate with another FrTable.

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

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

	FrTable ()
	Default constructor.

	FrTable (const FrTable &Source)
	Copy Constructor.

	FrTable (const name_type &name, nRow_type nrows)
	Constructor.

	FrTable (Previous::FrTable &Source, stream_base_type *Stream)
	Promotion Constructor.

virtual	~FrTable ()
	Destructor.

const name_type &	GetNameSlow () const
	Retrieve the name of the table.

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

FrTable &	operator+= (const FrTable &RHS)
	Concatinate with another FrTable.

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

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

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 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, promote_stream_type *Stream)
	Promote previous version of object to this version.

static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, promote_stream_type *Stream)
	Promote previous version of object to this version.

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

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

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

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

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

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

Protected Member Functions
virtual 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 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 cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

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

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

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

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.

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.

Detailed Description

Table Data Structure Definition.

Constructor & Destructor Documentation

◆ FrTable() [1/8]

FrameCPP::Version_9::FrTable::FrTable ( )

Default constructor.

Returns: A new instance of this object.

◆ FrTable() [2/8]

FrTable::FrTable ( const FrTable & Source )

Copy Constructor.

Parameters

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

Returns: A new instance of this object.

◆ FrTable() [3/8]

FrTable::FrTable	(	const name_type &	name,
		nRow_type	nrows )

Constructor.

Parameters

[in]	name	The of this table.
[in]	nrows	Number of rows in table.

Returns: A new instance of the object.

◆ FrTable() [4/8]

FrTable::FrTable	(	Previous::FrTable &	Source,
		stream_base_type *	Stream )

Promotion Constructor.

Parameters

[in]	Source	An FrTable structure from a previous frame specification.
[in]	Stream	The stream from which the earliest version of the FrTable structure was read.

Returns: A new instance of the object.

◆ FrTable() [5/8]

FrameCPP::Version_9::FrTable::FrTable ( )

Default constructor.

Returns: A new instance of this object.

◆ FrTable() [6/8]

FrameCPP::Version_9::FrTable::FrTable ( const FrTable & Source )

Copy Constructor.

Parameters

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

Returns: A new instance of this object.

◆ FrTable() [7/8]

FrameCPP::Version_9::FrTable::FrTable	(	const name_type &	name,
		nRow_type	nrows )

Constructor.

Parameters

[in]	name	The of this table.
[in]	nrows	Number of rows in table.

Returns: A new instance of the object.

◆ FrTable() [8/8]

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

Promotion Constructor.

Parameters

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

template<typename T >

virtual demote_ret_type FrameCPP::Version_9::FrTableImpl::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::FrTableImpl::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.

◆ GetDescription() [1/2]

template<typename T >

virtual const Common::Description * FrameCPP::Version_9::FrTableImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

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::FrTableImpl::ClassicIO< T >::GetDescription ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

The data structure description.

Returns: The description of the data structure used to represent this object when written to a GWF stream

◆ GetNameSlow() [1/2]

const std::string & FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns: The name of the table.

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_9::FrTable::GetNameSlow ( ) const

Retrieve the name of the table.

Returns: The name of the table.

◆ Merge() [1/2]

FrTable & FrTable::Merge ( const FrTable & RHS )

Merge with another FrTable.

Parameters

[in] RHS The source of the information to append to this FrTable structure.

Returns: A reference to this object

◆ Merge() [2/2]

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

Merge with another FrTable.

Parameters

[in] RHS The source of the information to append to this FrTable structure.

Returns: A reference to this object

◆ ObjectStructName() [1/2]

template<typename T >

virtual const char * FrameCPP::Version_9::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const

inlineprotectedvirtualinherited

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::FrTableImpl::ClassicIO< T >::ObjectStructName ( ) const

inlineprotectedvirtualinherited

The name structure name of this object.

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

◆ operator+=() [1/2]

FrTable & FrTable::operator+= ( const FrTable & RHS )

Concatinate with another FrTable.

Parameters

[in] RHS The source of the information to append to this FrTable structure.

Returns: A reference to this object

◆ operator+=() [2/2]

FrTable & FrameCPP::Version_9::FrTable::operator+= ( const FrTable & RHS )

Concatinate with another FrTable.

Parameters

[in] RHS The source of the information to append to this FrTable structure.

Returns: A reference to this object

◆ operator==() [1/4]

bool FrTable::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::FrTable::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::FrTable::operator== ( const FrTable & RHS ) const

inline

equality operator

Tests the equality of two tables.

Parameters

[in] RHS The FrTable object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

Parameters

[in] RHS Right hand side of equality expression.

Returns: True if the two tables are equivelant, false otherwise.

◆ operator==() [4/4]

bool FrameCPP::Version_9::FrTable::operator== ( const FrTable & RHS ) const

equality operator

Parameters

[in] RHS The FrTable 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 >

virtual cmn_streamsize_type FrameCPP::Version_9::FrTableImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

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 >

virtual cmn_streamsize_type FrameCPP::Version_9::FrTableImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

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::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream & 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::FrTableImpl::ClassicIO< T >::pCreate ( Common::IStream & Stream ) const

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

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

◆ Promote() [1/2]

template<typename T >

ClassicIO< T >::promote_ret_type FrameCPP::Version_9::FrTableImpl::ClassicIO< T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

staticinherited

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::FrTableImpl::ClassicIO< T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		promote_stream_type *	Stream )

staticinherited

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::FrTableImpl::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::FrTableImpl::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::FrTableImpl::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::FrTableImpl::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.

◆ StructDescription() [1/2]

template<typename T >

static const Common::Description * FrameCPP::Version_9::FrTableImpl::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::FrTableImpl::ClassicIO< T >::StructDescription ( )

inlinestaticinherited

The description of structure.

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

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrTable() [1/8]

◆ FrTable() [2/8]

◆ FrTable() [3/8]

◆ FrTable() [4/8]

◆ FrTable() [5/8]

◆ FrTable() [6/8]

◆ FrTable() [7/8]

◆ FrTable() [8/8]

Member Function Documentation

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ Create() [1/2]

◆ Create() [2/2]

◆ demote() [1/2]

◆ demote() [2/2]

◆ GetDescription() [1/2]

◆ GetDescription() [2/2]

◆ GetNameSlow() [1/2]

◆ GetNameSlow() [2/2]

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [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]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]