#include <FrSHClassicIO.hh>

Inheritance diagram for FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >:

[legend]

Collaboration diagram for FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >:

[legend]

Public Types
typedef std::string	name_type

typedef std::string	name_type

typedef std::string	name_type

typedef std::string	comment_type
	Comment. More...

typedef std::string	comment_type
	Comment. More...

typedef std::string	comment_type
	Comment. More...

typedef INT_2U	class_type
	Class number of structure being described. More...

typedef INT_2U	class_type
	Class number of structure being described. More...

typedef INT_2U	class_type
	Class number of structure being described. More...

typedef const char *const	struct_name_type

typedef const char *const	struct_name_type

typedef const char *const	struct_name_type

typedef const char *const	struct_desc_type

typedef const char *const	struct_desc_type

typedef const char *const	struct_desc_type

typedef INT_2U const	struct_id_type

typedef INT_2U const	struct_id_type

typedef INT_2U const	struct_id_type

typedef ObjectWithChecksum< Common::FrSH, checksum_type >	self_type

typedef ObjectWithChecksum< Common::FrSH, checksum_type >	self_type

typedef ObjectWithChecksum< Common::FrSH, checksum_type >	self_type

typedef IStream	istream_type

typedef IStream	istream_type

typedef IStream	istream_type

typedef OStream	ostream_type

typedef OStream	ostream_type

typedef OStream	ostream_type

typedef INT_2U	cmn_classId_type

typedef INT_2U	cmn_classId_type

typedef INT_2U	cmn_classId_type

typedef IStringStream	assign_stream_type

typedef IStringStream	assign_stream_type

typedef IStringStream	assign_stream_type

typedef FrameSpec::version_type	frame_spec_version_type

typedef FrameSpec::version_type	frame_spec_version_type

typedef FrameSpec::version_type	frame_spec_version_type

typedef std::unique_ptr< Object >	unique_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_arg_type

typedef object_type	demote_ret_type

typedef object_type	demote_ret_type

typedef object_type	demote_ret_type

typedef object_type	promote_arg_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 object_type	promote_ret_type

Public Member Functions
	ClassicIO ()

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

Common::FrameSpec::Object *	Clone () const
	constructor - virtual copy constructor More...

	ClassicIO ()

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

Common::FrameSpec::Object *	Clone () const
	constructor - virtual copy constructor More...

	ClassicIO ()

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

Common::FrameSpec::Object *	Clone () const
	constructor - virtual copy constructor More...

class_type	GetClass () const
	Return class of object. More...

class_type	GetClass () const
	Return class of object. More...

class_type	GetClass () const
	Return class of object. More...

const comment_type &	GetComment () const
	Return comment of object. More...

const comment_type &	GetComment () const
	Return comment of object. More...

const comment_type &	GetComment () const
	Return comment of object. More...

const name_type &	GetName () const
	Return name of object. More...

const name_type &	GetName () const
	Return name of object. More...

const name_type &	GetName () const
	Return name of object. 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 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 self_type *	Create (istream_type &Stream) const
	Virtual constructor. More...

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

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

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

class_type	GetClass () const
	Retrieve the class identifier. More...

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

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

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

virtual bool	operator== (const Object &Obj) const =0
	comparison operator More...

virtual bool	operator== (const Object &Obj) const =0
	comparison operator More...

virtual bool	operator== (const Object &Obj) const =0
	comparison operator More...

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

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	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object. More...

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

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

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

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

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

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

static struct_name_type	FrameSpecName ()

static struct_name_type	FrameSpecName ()

static struct_name_type	FrameSpecName ()

static struct_name_type	StructName ()

static struct_name_type	StructName ()

static struct_name_type	StructName ()

static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure. More...

static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure. More...

static struct_desc_type	FrameSpecDescription ()
	Return the dictionary name of the structure. More...

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

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

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

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

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

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

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

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

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

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

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 Public Attributes
static struct_name_type	struct_name

static struct_desc_type	struct_desc

static struct_id_type	struct_id

Protected Types
typedef STRING	io_name_type

typedef STRING	io_comment_type

typedef STRING	io_name_type

typedef STRING	io_comment_type

typedef STRING	io_name_type

typedef STRING	io_comment_type

Protected Member Functions
virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...

virtual const std::string &	name () const

virtual cmn_classId_type	classId () const

virtual demote_ret_type	demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const
	Demotes object to previous version of the frame spec. More...

virtual promote_ret_type	promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *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 self_type *	pCreate (istream_type &Stream) const
	Virtual constructor. More...

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream. More...

virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...

virtual const std::string &	name () const

virtual cmn_classId_type	classId () const

virtual demote_ret_type	demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const
	Demotes object to previous version of the frame spec. More...

virtual promote_ret_type	promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *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 self_type *	pCreate (istream_type &Stream) const
	Virtual constructor. More...

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream. More...

virtual void	assign (assign_stream_type &Stream)
	Assign the contents of the instance. More...

virtual const std::string &	name () const

virtual cmn_classId_type	classId () const

virtual demote_ret_type	demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const
	Demotes object to previous version of the frame spec. More...

virtual promote_ret_type	promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *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 self_type *	pCreate (istream_type &Stream) const
	Virtual constructor. More...

virtual void	pWrite (ostream_type &Stream) const
	Write the structure to the stream. More...

virtual class_type	getClass () const
	Retrieve the class identifier. More...

virtual class_type	getClass () const
	Retrieve the class identifier. More...

virtual class_type	getClass () const
	Retrieve the class identifier. More...

virtual demote_ret_type	demote (frame_spec_version_type Target, demote_arg_type Obj, istream_type *Stream) const =0
	Demotes object to previous version of the frame spec. More...

virtual promote_ret_type	promote (frame_spec_version_type Target, promote_arg_type Obj, istream_type *Stream) const =0
	Promotes object to another version of the frame spec. More...

Protected Attributes
name_type	name

comment_type	comment

class_type	klass

Private Types
typedef ObjectWithChecksum< Common::FrameSpec::Object >	object_type

typedef ObjectWithChecksum< Common::FrameSpec::Object >	object_type

typedef ObjectWithChecksum< Common::FrameSpec::Object >	object_type

Member Typedef Documentation

◆ assign_stream_type [1/3]

typedef IStringStream FrameCPP::Common::FrSH::assign_stream_type

inherited

◆ assign_stream_type [2/3]

typedef IStringStream FrameCPP::Common::FrSH::assign_stream_type

inherited

◆ assign_stream_type [3/3]

typedef IStringStream FrameCPP::Common::FrSH::assign_stream_type

inherited

◆ class_type [1/3]

typedef INT_2U FrameCPP::Version_8::FrSHImpl::Data::class_type

inherited

Class number of structure being described.

◆ class_type [2/3]

typedef INT_2U FrameCPP::Version_8::FrSHImpl::Data::class_type

inherited

Class number of structure being described.

◆ class_type [3/3]

typedef INT_2U FrameCPP::Version_8::FrSHImpl::Data::class_type

inherited

Class number of structure being described.

◆ cmn_classId_type [1/3]

typedef INT_2U FrameCPP::Common::FrSH::cmn_classId_type

inherited

◆ cmn_classId_type [2/3]

typedef INT_2U FrameCPP::Common::FrSH::cmn_classId_type

inherited

◆ cmn_classId_type [3/3]

typedef INT_2U FrameCPP::Common::FrSH::cmn_classId_type

inherited

◆ comment_type [1/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::comment_type

inherited

Comment.

◆ comment_type [2/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::comment_type

inherited

Comment.

◆ comment_type [3/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::comment_type

inherited

Comment.

◆ demote_arg_type [1/3]

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

inherited

◆ demote_arg_type [2/3]

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

inherited

◆ demote_arg_type [3/3]

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

inherited

◆ demote_ret_type [1/3]

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

inherited

◆ demote_ret_type [2/3]

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

inherited

◆ demote_ret_type [3/3]

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

inherited

◆ frame_spec_version_type [1/3]

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

inherited

◆ frame_spec_version_type [2/3]

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

inherited

◆ frame_spec_version_type [3/3]

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

inherited

◆ io_comment_type [1/3]

template<typename FR_SH_T>

typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_comment_type

protected

◆ io_comment_type [2/3]

template<typename FR_SH_T>

typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_comment_type

protected

◆ io_comment_type [3/3]

template<typename FR_SH_T>

typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_comment_type

protected

◆ io_name_type [1/3]

template<typename FR_SH_T>

typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_name_type

protected

◆ io_name_type [2/3]

template<typename FR_SH_T>

typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_name_type

protected

◆ io_name_type [3/3]

template<typename FR_SH_T>

typedef STRING FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::io_name_type

protected

◆ istream_type [1/3]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::istream_type

inherited

◆ istream_type [2/3]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::istream_type

inherited

◆ istream_type [3/3]

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::istream_type

inherited

◆ name_type [1/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::name_type

inherited

Name of structure being described by this dictionary structure

◆ name_type [2/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::name_type

inherited

Name of structure being described by this dictionary structure

◆ name_type [3/3]

typedef std::string FrameCPP::Version_8::FrSHImpl::Data::name_type

inherited

Name of structure being described by this dictionary structure

◆ object_type [1/3]

template<typename FR_SH_T>

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::object_type

private

◆ object_type [2/3]

template<typename FR_SH_T>

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::object_type

private

◆ object_type [3/3]

template<typename FR_SH_T>

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::object_type

private

◆ ostream_type [1/3]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::ostream_type

inherited

◆ ostream_type [2/3]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::ostream_type

inherited

◆ ostream_type [3/3]

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::ostream_type

inherited

◆ promote_arg_type [1/3]

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

inherited

◆ promote_arg_type [2/3]

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

inherited

◆ promote_arg_type [3/3]

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

inherited

◆ promote_ret_type [1/3]

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

inherited

◆ promote_ret_type [2/3]

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

inherited

◆ promote_ret_type [3/3]

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

inherited

◆ self_type [1/3]

typedef ObjectWithChecksum< Common::FrSH , checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::self_type

inherited

◆ self_type [2/3]

typedef ObjectWithChecksum< Common::FrSH , checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::self_type

inherited

◆ self_type [3/3]

typedef ObjectWithChecksum< Common::FrSH , checksum_type > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::self_type

inherited

◆ struct_desc_type [1/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type

inherited

◆ struct_desc_type [2/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type

inherited

◆ struct_desc_type [3/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc_type

inherited

◆ struct_id_type [1/3]

typedef INT_2U const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id_type

inherited

◆ struct_id_type [2/3]

typedef INT_2U const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id_type

inherited

◆ struct_id_type [3/3]

typedef INT_2U const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id_type

inherited

◆ struct_name_type [1/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type

inherited

◆ struct_name_type [2/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type

inherited

◆ struct_name_type [3/3]

typedef const char* const FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name_type

inherited

◆ unique_object_type [1/3]

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

inherited

◆ unique_object_type [2/3]

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

inherited

◆ unique_object_type [3/3]

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

inherited

Constructor & Destructor Documentation

◆ ClassicIO() [1/3]

template<typename FR_SH_T>

FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ClassicIO ( )

inline

◆ ClassicIO() [2/3]

template<typename FR_SH_T>

FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ClassicIO ( )

inline

◆ ClassicIO() [3/3]

template<typename FR_SH_T>

FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ClassicIO ( )

inline

Member Function Documentation

◆ assign() [1/3]

template<typename FR_SH_T>

virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type & Stream )

inlineprotectedvirtual

Assign the contents of the instance.

Parameters

[in] Stream An input stream from which to read information for the instance.

Implements FrameCPP::Common::FrSH.

◆ assign() [2/3]

template<typename FR_SH_T>

virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type & Stream )

inlineprotectedvirtual

Assign the contents of the instance.

Parameters

[in] Stream An input stream from which to read information for the instance.

Implements FrameCPP::Common::FrSH.

◆ assign() [3/3]

template<typename FR_SH_T>

virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::assign ( assign_stream_type & Stream )

inlineprotectedvirtual

Assign the contents of the instance.

Parameters

[in] Stream An input stream from which to read information for the instance.

Implements FrameCPP::Common::FrSH.

◆ Bytes() [1/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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

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

◆ Bytes() [2/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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

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

◆ Bytes() [3/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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

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

◆ CheckSumDataClass() [1/3]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/3]

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [3/3]

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/3]

template const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/3]

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [3/3]

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ classId() [1/3]

template<typename FR_SH_T>

virtual cmn_classId_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::classId ( ) const

inlineprotectedvirtual

Implements FrameCPP::Common::FrSH.

◆ classId() [2/3]

template<typename FR_SH_T>

virtual cmn_classId_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::classId ( ) const

inlineprotectedvirtual

Implements FrameCPP::Common::FrSH.

◆ classId() [3/3]

template<typename FR_SH_T>

virtual cmn_classId_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::classId ( ) const

inlineprotectedvirtual

Implements FrameCPP::Common::FrSH.

◆ Clone() [1/3]

template<typename FR_SH_T>

Common::FrameSpec::Object* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Clone ( ) const

inlinevirtual

constructor - virtual copy constructor

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

◆ Clone() [2/3]

template<typename FR_SH_T>

Common::FrameSpec::Object* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Clone ( ) const

inlinevirtual

constructor - virtual copy constructor

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

◆ Clone() [3/3]

template<typename FR_SH_T>

Common::FrameSpec::Object* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Clone ( ) const

inlinevirtual

constructor - virtual copy constructor

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

◆ Create() [1/3]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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.

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

◆ Create() [2/3]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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.

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

◆ Create() [3/3]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , 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.

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

◆ demote() [1/4]

template<typename FR_SH_T>

virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote	(	frame_spec_version_type	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtual

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

template<typename FR_SH_T>

virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote	(	frame_spec_version_type	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtual

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

template<typename FR_SH_T>

virtual demote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::demote	(	frame_spec_version_type	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtual

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

virtual demote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::demote	(	frame_spec_version_type	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

protectedpure virtualinherited

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.

◆ DemoteObject() [1/3]

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

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.

◆ DemoteObject() [3/3]

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.

◆ FrameSpecDescription() [1/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [3/3]

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecDescription ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [3/3]

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecId ( )

inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )

inlinestaticinherited

◆ FrameSpecName() [2/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )

inlinestaticinherited

◆ FrameSpecName() [3/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::FrameSpecName ( )

inlinestaticinherited

◆ GetClass() [1/4]

Data::class_type FrameCPP::Version_8::FrSHImpl::Data::GetClass ( ) const

inlineinherited

Return class of object.

Returns: Class number of structure being described

◆ GetClass() [2/4]

class_type FrameCPP::Version_8::FrSHImpl::Data::GetClass ( ) const

inherited

Return class of object.

Returns: Class number of structure being described

◆ GetClass() [3/4]

class_type FrameCPP::Version_8::FrSHImpl::Data::GetClass ( ) const

inherited

Return class of object.

Returns: Class number of structure being described

◆ GetClass() [4/4]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inlineinherited

Retrieve the class identifier.

Returns: The class identifier.

◆ getClass() [1/3]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

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

◆ getClass() [2/3]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

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

◆ getClass() [3/3]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

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

◆ GetComment() [1/3]

const comment_type& FrameCPP::Version_8::FrSHImpl::Data::GetComment ( ) const

inherited

Return comment of object.

Returns: Comment

◆ GetComment() [2/3]

const Data::comment_type & FrameCPP::Version_8::FrSHImpl::Data::GetComment ( ) const

inlineinherited

Return comment of object.

Returns: Comment

◆ GetComment() [3/3]

const comment_type& FrameCPP::Version_8::FrSHImpl::Data::GetComment ( ) const

inherited

Return comment of object.

Returns: Comment

◆ GetDescription() [1/3]

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

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

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.

◆ GetName() [1/3]

const Data::name_type & FrameCPP::Version_8::FrSHImpl::Data::GetName ( ) const

inlineinherited

Return name of object.

Returns: Name of structure being described by this dictionary structure

◆ GetName() [2/3]

const name_type& FrameCPP::Version_8::FrSHImpl::Data::GetName ( ) const

inherited

Return name of object.

Returns: Name of structure being described by this dictionary structure

◆ GetName() [3/3]

const name_type& FrameCPP::Version_8::FrSHImpl::Data::GetName ( ) const

inherited

Return name of object.

Returns: Name of structure being described by this dictionary structure

◆ name() [1/3]

template<typename FR_SH_T>

virtual const std::string& FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const

inlineprotectedvirtual

Todo:: See about storing name in this class and eliminate the need for this virtual method.

Implements FrameCPP::Common::FrSH.

◆ name() [2/3]

template<typename FR_SH_T>

virtual const std::string& FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const

inlineprotectedvirtual

Todo:: See about storing name in this class and eliminate the need for this virtual method.

Implements FrameCPP::Common::FrSH.

◆ name() [3/3]

template<typename FR_SH_T>

virtual const std::string& FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::name ( ) const

inlineprotectedvirtual

Todo:: See about storing name in this class and eliminate the need for this virtual method.

Implements FrameCPP::Common::FrSH.

◆ ObjectStructName() [1/3]

template<typename FR_SH_T>

virtual const char* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const

inlinevirtual

The name structure name of this object.

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

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

◆ ObjectStructName() [2/3]

template<typename FR_SH_T>

virtual const char* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const

inlinevirtual

The name structure name of this object.

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

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

◆ ObjectStructName() [3/3]

template<typename FR_SH_T>

virtual const char* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::ObjectStructName ( ) const

inlinevirtual

The name structure name of this object.

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

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

◆ operator==() [1/3]

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

pure virtualinherited

comparison operator

◆ operator==() [2/3]

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

pure virtualinherited

comparison operator

◆ operator==() [3/3]

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

pure virtualinherited

comparison operator

◆ pBytes() [1/3]

template<typename FR_SH_T>

cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtual

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< Common::FrSH, checksum_type >.

◆ pBytes() [2/3]

template<typename FR_SH_T>

cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtual

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< Common::FrSH, checksum_type >.

◆ pBytes() [3/3]

template<typename FR_SH_T>

cmn_streamsize_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtual

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< Common::FrSH, checksum_type >.

◆ pCreate() [1/3]

template<typename FR_SH_T>

virtual self_type* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

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

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

◆ pCreate() [2/3]

template<typename FR_SH_T>

virtual self_type* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

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

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

◆ pCreate() [3/3]

template<typename FR_SH_T>

virtual self_type* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pCreate ( istream_type & Stream ) const

inlineprotectedvirtual

Virtual constructor.

Parameters

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

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

◆ Promote() [1/3]

template<typename FR_SH_T>

static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		istream_type *	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() [2/3]

template<typename FR_SH_T>

static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		istream_type *	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() [3/3]

template<typename FR_SH_T>

static promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::Promote	(	INT_2U	Source,
		promote_arg_type	Obj,
		istream_type *	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/4]

template<typename FR_SH_T>

virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote	(	frame_spec_version_type	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtual

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

template<typename FR_SH_T>

virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote	(	frame_spec_version_type	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtual

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

template<typename FR_SH_T>

virtual promote_ret_type FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::promote	(	frame_spec_version_type	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtual

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

virtual promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::promote	(	frame_spec_version_type	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

protectedpure virtualinherited

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.

◆ PromoteObject() [1/7]

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

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

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

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

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

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

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

inherited

◆ pWrite() [1/3]

template<typename FR_SH_T>

virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtual

Write the structure to the stream.

Parameters

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

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

◆ pWrite() [2/3]

template<typename FR_SH_T>

virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtual

Write the structure to the stream.

Parameters

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

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

◆ pWrite() [3/3]

template<typename FR_SH_T>

virtual void FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtual

Write the structure to the stream.

Parameters

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

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

◆ StructDescription() [1/3]

template<typename FR_SH_T>

static const Common::Description* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )

inlinestatic

The description of structure.

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

◆ StructDescription() [2/3]

template<typename FR_SH_T>

static const Common::Description* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )

inlinestatic

The description of structure.

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

◆ StructDescription() [3/3]

template<typename FR_SH_T>

static const Common::Description* FrameCPP::Version_8::FrSHImpl::ClassicIO< FR_SH_T >::StructDescription ( )

inlinestatic

The description of structure.

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

◆ StructName() [1/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )

inlinestaticinherited

◆ StructName() [2/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )

inlinestaticinherited

◆ StructName() [3/3]

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::StructName ( )

inlinestaticinherited

◆ VerifyObject() [1/3]

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.

◆ VerifyObject() [2/3]

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.

◆ VerifyObject() [3/3]

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.

◆ Write() [1/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

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

◆ Write() [2/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

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

◆ Write() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH , checksum_type >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

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

◆ WriteNext() [1/3]

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

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

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

◆ comment

comment_type FrameCPP::Version_8::FrSHImpl::Data::comment

protectedinherited

Comment

◆ klass

class_type FrameCPP::Version_8::FrSHImpl::Data::klass

protectedinherited

Class number of structure being described

◆ name

name_type FrameCPP::Version_8::FrSHImpl::Data::name

protectedinherited

Name of structure being described by this dictionary structure

◆ struct_desc

static struct_desc_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_desc

staticinherited

◆ struct_id

static struct_id_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_id

staticinherited

◆ struct_name

static struct_name_type FrameCPP::Version_8::Impl::FrObjectMetaData< Data >::struct_name

staticinherited

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

/build/ldas-tools-framecpp-2.8.1/debian/tmp/usr/include/framecpp/Version8/impl/FrSHClassicIO.hh

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Member Typedef Documentation

◆ assign_stream_type [1/3]

◆ assign_stream_type [2/3]

◆ assign_stream_type [3/3]

◆ class_type [1/3]

◆ class_type [2/3]

◆ class_type [3/3]

◆ cmn_classId_type [1/3]

◆ cmn_classId_type [2/3]

◆ cmn_classId_type [3/3]

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ demote_arg_type [1/3]

◆ demote_arg_type [2/3]

◆ demote_arg_type [3/3]

◆ demote_ret_type [1/3]

◆ demote_ret_type [2/3]

◆ demote_ret_type [3/3]

◆ frame_spec_version_type [1/3]

◆ frame_spec_version_type [2/3]

◆ frame_spec_version_type [3/3]

◆ io_comment_type [1/3]

◆ io_comment_type [2/3]

◆ io_comment_type [3/3]

◆ io_name_type [1/3]

◆ io_name_type [2/3]

◆ io_name_type [3/3]

◆ istream_type [1/3]

◆ istream_type [2/3]

◆ istream_type [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ object_type [1/3]

◆ object_type [2/3]

◆ object_type [3/3]

◆ ostream_type [1/3]

◆ ostream_type [2/3]

◆ ostream_type [3/3]

◆ promote_arg_type [1/3]

◆ promote_arg_type [2/3]

◆ promote_arg_type [3/3]

◆ promote_ret_type [1/3]

◆ promote_ret_type [2/3]

◆ promote_ret_type [3/3]

◆ self_type [1/3]

◆ self_type [2/3]

◆ self_type [3/3]

◆ struct_desc_type [1/3]

◆ struct_desc_type [2/3]

◆ struct_desc_type [3/3]

◆ struct_id_type [1/3]

◆ struct_id_type [2/3]

◆ struct_id_type [3/3]

◆ struct_name_type [1/3]

◆ struct_name_type [2/3]

◆ struct_name_type [3/3]

◆ unique_object_type [1/3]

◆ unique_object_type [2/3]

◆ unique_object_type [3/3]

Constructor & Destructor Documentation

◆ ClassicIO() [1/3]

◆ ClassicIO() [2/3]

◆ ClassicIO() [3/3]

Member Function Documentation

◆ assign() [1/3]

◆ assign() [2/3]

◆ assign() [3/3]

◆ Bytes() [1/3]

◆ Bytes() [2/3]

◆ Bytes() [3/3]