Generalized common elements of frame structure. More...

#include <StreamRef.hh>

Inherits FrameCPP::Common::StreamRefInterface, and FrameCPP::Common::StreamRefInterface.

Public Member Functions
	StreamRef2 ()
	Constructor.

virtual	~StreamRef2 ()
	Destructor.

FrameSpec::size_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object. More...

virtual self_type *	Create (IStream &Stream) const
	constructor - virtual

virtual self_type *	Clone () const
	constructor - virtual copy constructor

virtual const char *	ObjectStructName () const
	Retrieve the class name of the object. More...

virtual bool	operator== (const StreamRef2< LT, CKT, CT, IT > &RHS) const
	comparison operator

virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator

	StreamRef2 ()
	Constructor.

virtual	~StreamRef2 ()
	Destructor.

FrameSpec::size_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object. More...

virtual self_type *	Create (IStream &Stream) const
	constructor - virtual

virtual self_type *	Clone () const
	constructor - virtual copy constructor

virtual const char *	ObjectStructName () const
	Retrieve the class name of the object. More...

virtual bool	operator== (const StreamRef2< LT, CKT, CT, IT > &RHS) const
	comparison operator

virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator

const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object. More...

const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object. More...

ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream. More...

ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream. More...

virtual Object *	Create () const
	constructor - virtual

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

virtual void	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object. More...

virtual void	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object. More...

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

Static Public Member Functions
static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
	Down grade an object. More...

static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
	Down grade an object. More...

static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

template<typename PreviousType , typename CurrentType >
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

template<typename PreviousType , typename CurrentType >
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

Protected Member Functions
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const
	Down grade an object.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, IStream *Stream) const
	Upgrade an object.

virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, IStream *Stream) const
	Down grade an object.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, IStream *Stream) const
	Upgrade an object.

virtual class_type	getClass () const
	Retrieve the class identifier.

virtual class_type	getClass () const
	Retrieve the class identifier.

Detailed Description

template<class LT, class CKT, class CT, class IT>
class FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >

Generalized common elements of frame structure.

This templated implementation simplifies the actual implementation of the common elements of all frame structures by having each of the storage elements have a separate template parameter.

This implementation supports versions of the frame specification which require the chkType field.

Template Parameters

LT	Data type for the length field.
CKT	Data type for the chkType field.
CT	Data type for the class field.
IT	Data type for the instance field.

Member Function Documentation

◆ Bytes() [1/2]

template<typename LT , typename CKT , typename CT , typename IT >

cmn_streamsize_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( const StreamBase & Stream ) const

virtual

Return the number of bytes for this object.

Parameters

[in] Stream The stream on which the object will be written or read.

Returns: The number of bytes required by this object for the specified stream.

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

◆ Bytes() [2/2]

template<class LT , class CKT , class CT , class IT >

FrameSpec::size_type FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::Bytes ( const StreamBase & Stream ) const

virtual

Return the number of bytes for this object.

Parameters

[in] Stream The stream on which the object will be written or read.

Returns: The number of bytes required by this object for the specified stream.

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,
		istream_type *	Stream
	)

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream 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,
		istream_type *	Stream
	)

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns: A pointer to the objected derived by demoting Obj.

◆ GetDescription() [1/2]

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

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.

◆ ObjectStructName() [1/2]

template<class LT , class CKT , class CT , class IT >

virtual const char* FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::ObjectStructName ( ) const

virtual

Retrieve the class name of the object.

Returns: The name of the class associated with the object.

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

◆ ObjectStructName() [2/2]

template<typename LT , typename CKT , typename CT , typename IT >

const char * FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >::ObjectStructName ( ) const

inlinevirtual

Retrieve the class name of the object.

Returns: The name of the class associated with the object.

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

◆ PromoteObject() [1/4]

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

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/4]

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

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/4]

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,
		istream_type *	Stream
	)

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/4]

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,
		istream_type *	Stream
	)

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ VerifyObject() [1/2]

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

virtualinherited

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, and FrameCPP::Version_8::FrHeader.

◆ VerifyObject() [2/2]

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

virtualinherited

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, and FrameCPP::Version_8::FrHeader.

◆ Write()

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type & Stream ) const

pure virtualinherited

Write object to the stream.

Parameters

[in,out] Stream The stream being written with the contents of object.

Implemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrTable, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_6::FrTable, and FrameCPP::Version_6::FrTable.

◆ 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] Stream The 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] Stream The output stream to receive the next pointer.

Returns: The output stream.

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Common/StreamRef.hh

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

template<class LT, class CKT, class CT, class IT> class FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >

Member Function Documentation

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ DemoteObject() [1/2]

◆ DemoteObject() [2/2]

◆ GetDescription() [1/2]

◆ GetDescription() [2/2]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ PromoteObject() [1/4]

◆ PromoteObject() [2/4]

◆ PromoteObject() [3/4]

◆ PromoteObject() [4/4]

◆ VerifyObject() [1/2]

◆ VerifyObject() [2/2]

◆ Write()

◆ WriteNext() [1/2]

◆ WriteNext() [2/2]

template<class LT, class CKT, class CT, class IT>
class FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >