FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T > Class Template Reference

#include <StreamRef.hh>

Inheritance diagram for FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >:

Collaboration diagram for FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >:

Public Types
typedef StreamRefInterface::length_type	length_type
typedef StreamRefInterface::class_type	class_type
typedef StreamRefInterface::instance_type	instance_type
typedef StreamRefInterface::length_type	length_type
typedef StreamRefInterface::class_type	class_type
typedef StreamRefInterface::instance_type	instance_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef boost::shared_ptr< Object >	object_type
typedef boost::shared_ptr< Object >	object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef object_type	demote_arg_type
typedef object_type	demote_arg_type
typedef object_type	demote_ret_type
typedef object_type	demote_ret_type
typedef stream_base_type	demote_stream_type
typedef stream_base_type	demote_stream_type
typedef object_type	promote_arg_type
typedef object_type	promote_arg_type
typedef object_type	promote_ret_type
typedef object_type	promote_ret_type
typedef stream_base_type	promote_stream_type
typedef stream_base_type	promote_stream_type

Public Member Functions
	StreamRef ()
	Constructor.
virtual	~StreamRef ()
	Destructor.
virtual FrameSpec::size_type	SizeOf () const
FrameSpec::size_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual class_type	GetClass () const
virtual instance_type	GetInstance () const
virtual length_type	GetLength () const
virtual void	SetClass (class_type Class)
virtual void	SetInstance (instance_type Instance)
virtual void	SetLength (length_type Length)
virtual StreamRef< LT, CT, IT, SPEC_VERSION_T > *	Create (IStream &Stream) const
	constructor - virtual
virtual StreamRef< LT, CT, IT, SPEC_VERSION_T > *	Clone () const
	constructor - virtual copy constructor
virtual const char *	ObjectStructName () const
	Retrieve the class name of the object.
virtual void	Write (OStream &Stream) const
	Write object to the stream.
virtual bool	operator== (const StreamRef< LT, CT, IT, SPEC_VERSION_T > &RHS) const
	comparison operator
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator
	StreamRef ()
	Constructor.
virtual	~StreamRef ()
	Destructor.
virtual FrameSpec::size_type	SizeOf () const
FrameSpec::size_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.
virtual class_type	GetClass () const
virtual instance_type	GetInstance () const
virtual length_type	GetLength () const
virtual void	SetClass (class_type Class)
virtual void	SetInstance (instance_type Instance)
virtual void	SetLength (length_type Length)
virtual StreamRef< LT, CT, IT, SPEC_VERSION_T > *	Create (IStream &Stream) const
	constructor - virtual
virtual StreamRef< LT, CT, IT, SPEC_VERSION_T > *	Clone () const
	constructor - virtual copy constructor
virtual const char *	ObjectStructName () const
	Retrieve the class name of the object.
virtual void	Write (OStream &Stream) const
	Write object to the stream.
virtual bool	operator== (const StreamRef< LT, CT, IT, SPEC_VERSION_T > &RHS) const
	comparison operator
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator
virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.
virtual const Description *	GetDescription (ostream_type &Stream) const
virtual const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object.
virtual const Description *	GetDescription (ostream_type &Stream) const
frame_spec_version_type	FrameSpecVersion () const
frame_spec_version_type	FrameSpecVersion () const
ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream.
ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream.
virtual Object *	Create () const
	constructor - virtual
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual
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.

Static Public Member Functions
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.

Protected Member Functions
virtual void	assign (IStringStream &Stream)
virtual FrameSpec::ObjectInterface::demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Down grade an object.
virtual FrameSpec::ObjectInterface::promote_ret_type	promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
virtual void	assign (IStringStream &Stream)
virtual FrameSpec::ObjectInterface::demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, demote_stream_type *Stream) const
	Down grade an object.
virtual FrameSpec::ObjectInterface::promote_ret_type	promote (INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type *Stream) const
	Upgrade an object.
virtual class_type	getClass () const
	Retrieve the class identifier.
virtual class_type	getClass () const
	Retrieve the class identifier.

Private Types
typedef LT	internal_length_type
typedef CT	internal_class_type
typedef IT	internal_instance_type
typedef LT	internal_length_type
typedef CT	internal_class_type
typedef IT	internal_instance_type

Private Member Functions
	StreamRef (IStream &Stream)
	StreamRef (const StreamRef &Source)
	StreamRef (IStream &Stream)
	StreamRef (const StreamRef &Source)

Private Attributes
internal_length_type	m_length
internal_class_type	m_class
internal_instance_type	m_instance
const Description *const	m_desc
	Description for parent class.
const frame_spec_version_type	frame_spec_version
	Version of the frame specification.

Static Private Attributes
static const FrameSpec::Info::frame_object_types	s_object_id

Member Typedef Documentation

class_type [1/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef StreamRefInterface::class_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::class_type

class_type [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef StreamRefInterface::class_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::class_type

demote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_stream_type [1/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_stream_type

inherited

demote_stream_type [2/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_stream_type

inherited

frame_spec_version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

frame_spec_version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

instance_type [1/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef StreamRefInterface::instance_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::instance_type

instance_type [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef StreamRefInterface::instance_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::instance_type

internal_class_type [1/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef CT FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::internal_class_type

private

internal_class_type [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef CT FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::internal_class_type

private

internal_instance_type [1/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef IT FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::internal_instance_type

private

internal_instance_type [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef IT FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::internal_instance_type

private

internal_length_type [1/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef LT FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::internal_length_type

private

internal_length_type [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef LT FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::internal_length_type

private

length_type [1/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef StreamRefInterface::length_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::length_type

length_type [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

typedef StreamRefInterface::length_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::length_type

object_type [1/2]

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

inherited

object_type [2/2]

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

inherited

promote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_stream_type [1/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_stream_type

inherited

promote_stream_type [2/2]

typedef stream_base_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_stream_type

inherited

unique_object_type [1/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

unique_object_type [2/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

Constructor & Destructor Documentation

StreamRef() [1/6]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::StreamRef

(

)

Constructor.

~StreamRef() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::~StreamRef ( )

virtual

Destructor.

StreamRef() [2/6]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::StreamRef ( IStream & Stream )

private

StreamRef() [3/6]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::StreamRef ( const StreamRef< LT, CT, IT, SPEC_VERSION_T > & Source )

private

StreamRef() [4/6]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::StreamRef

(

)

Constructor.

~StreamRef() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::~StreamRef ( )

virtual

Destructor.

StreamRef() [5/6]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::StreamRef ( IStream & Stream )

private

StreamRef() [6/6]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::StreamRef ( const StreamRef< LT, CT, IT, SPEC_VERSION_T > & Source )

private

Member Function Documentation

assign() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::assign ( IStringStream & Stream )

inlineprotectedvirtual

Implements FrameCPP::Common::StreamRefInterface.

assign() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::assign ( IStringStream & Stream )

protectedvirtual

Implements FrameCPP::Common::StreamRefInterface.

Bytes() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

cmn_streamsize_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::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 CT, class IT, int SPEC_VERSION_T>

FrameSpec::size_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::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.

Clone() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

StreamRef< LT, CT, IT, SPEC_VERSION_T > * FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::Clone ( ) const

inlinevirtual

constructor - virtual copy constructor

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

Clone() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual StreamRef< LT, CT, IT, SPEC_VERSION_T > * FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::Clone ( ) const

virtual

constructor - virtual copy constructor

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

Create() [1/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrVect, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, and FrVect.

Create() [2/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream & Buffer ) const

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

Create() [3/4]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

StreamRef< LT, CT, IT, SPEC_VERSION_T > * FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::Create ( IStream & Stream ) const

inlinevirtual

constructor - virtual

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

Create() [4/4]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual StreamRef< LT, CT, IT, SPEC_VERSION_T > * FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::Create ( IStream & Stream ) const

virtual

constructor - virtual

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

demote() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

FrameSpec::ObjectInterface::demote_ret_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::demote ( INT_2U Target, demote_arg_type Obj, demote_stream_type * Stream ) const

protectedvirtual

Down grade an object.

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

demote() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual FrameSpec::ObjectInterface::demote_ret_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::demote ( INT_2U Target, demote_arg_type Obj, demote_stream_type * Stream ) const

protectedvirtual

Down grade an object.

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

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

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]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

StreamRef< LT, CT, IT, SPEC_VERSION_T >::class_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::GetClass ( ) const

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

GetClass() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual class_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::GetClass ( ) const

virtual

Implements FrameCPP::Common::StreamRefInterface.

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.

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::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, and FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >.

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::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< T >, FrameCPP::Version_9::FrameHImpl::ClassicIO< FrameH >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< T >, and FrameCPP::Version_9::FrEndOfFileImpl::ClassicIO< FrEndOfFile >.

GetInstance() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

StreamRef< LT, CT, IT, SPEC_VERSION_T >::instance_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::GetInstance ( ) const

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

GetInstance() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual instance_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::GetInstance ( ) const

virtual

Implements FrameCPP::Common::StreamRefInterface.

GetLength() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

StreamRef< LT, CT, IT, SPEC_VERSION_T >::length_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::GetLength ( ) const

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

GetLength() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual length_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::GetLength ( ) const

virtual

Implements FrameCPP::Common::StreamRefInterface.

ObjectStructName() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

const char * FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::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.

ObjectStructName() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual const char * FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::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.

operator==() [1/4]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

bool FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::operator== ( const Common::FrameSpec::Object & Obj ) const

inlinevirtual

comparison operator

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

operator==() [2/4]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual bool FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::operator== ( const Common::FrameSpec::Object & Obj ) const

virtual

comparison operator

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

operator==() [3/4]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

bool FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::operator== ( const StreamRef< LT, CT, IT, SPEC_VERSION_T > & RHS ) const

inlinevirtual

comparison operator

operator==() [4/4]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual bool FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::operator== ( const StreamRef< LT, CT, IT, SPEC_VERSION_T > & RHS ) const

virtual

comparison operator

promote() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::promote ( INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type * Stream ) const

protectedvirtual

Upgrade an object.

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

promote() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::promote ( INT_2U Target, FrameSpec::ObjectInterface::promote_arg_type Obj, promote_stream_type * Stream ) const

protectedvirtual

Upgrade an object.

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

PromoteObject() [1/5]

template<typename PreviousType, typename CurrentType>

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

template<typename PreviousType, typename CurrentType>

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

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

SetClass() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SetClass ( class_type Class )

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

SetClass() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SetClass ( class_type Class )

virtual

Implements FrameCPP::Common::StreamRefInterface.

SetInstance() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SetInstance ( instance_type Instance )

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

SetInstance() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SetInstance ( instance_type Instance )

virtual

Implements FrameCPP::Common::StreamRefInterface.

SetLength() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SetLength ( length_type Length )

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

SetLength() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SetLength ( length_type Length )

virtual

Implements FrameCPP::Common::StreamRefInterface.

SizeOf() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

cmn_streamsize_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SizeOf ( ) const

inlinevirtual

Implements FrameCPP::Common::StreamRefInterface.

SizeOf() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual FrameSpec::size_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::SizeOf ( ) const

virtual

Implements FrameCPP::Common::StreamRefInterface.

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_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_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

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_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_9::FrEndOfFile, FrameCPP::Version_9::FrEndOfFile, FrameCPP::Version_9::FrHeader, FrameCPP::Version_9::FrHeader, and FrVect.

Write() [1/2]

template<typename LT, typename CT, typename IT, int SPEC_VERSION_T>

void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::Write ( OStream & Stream ) const

inlinevirtual

Write object to the stream.

Parameters

[in,out]

Stream

The stream being written with the contents of object.

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

Write() [2/2]

template<class LT, class CT, class IT, int SPEC_VERSION_T>

virtual void FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::Write ( OStream & Stream ) const

virtual

Write object to the stream.

Parameters

[in,out]

Stream

The stream being written with the contents of object.

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]

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.

Member Data Documentation

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.

m_class

template<class LT, class CT, class IT, int SPEC_VERSION_T>

internal_class_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::m_class

private

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.

m_instance

template<class LT, class CT, class IT, int SPEC_VERSION_T>

internal_instance_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::m_instance

private

m_length

template<class LT, class CT, class IT, int SPEC_VERSION_T>

internal_length_type FrameCPP::Common::StreamRef< LT, CT, IT, SPEC_VERSION_T >::m_length

private

s_object_id

const FrameSpec::Info::frame_object_types FrameCPP::Common::StreamRefInterface::s_object_id

staticprivateinherited

Initial value:

                                                         =
FrameSpec::Info::FSI_COMMON_ELEMENTS

---

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/Common/StreamRef.hh
• /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Common/StreamRef.hh