Contains field information of a dictionary structure. More...

#include <FrSE.hh>

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

Public Member Functions
	FrSE ()
	Default constructor.

	FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
	constructor More...

virtual	~FrSE ()
	Desctructor.

virtual const char *	ObjectStructName () const
	Dictionary class name. More...

std::string	GetClass () const
	Return class of object.

std::string	GetComment () const
	Return comment of object.

std::string	GetName () const
	Return name of object.

virtual FrSE *	Clone () const
	Create a new instance of the object based on self.

bool	operator== (const FrSE &RHS) const
	comparison operator

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

	FrSE ()
	Default constructor.

	FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
	constructor More...

virtual	~FrSE ()
	Desctructor.

virtual const char *	ObjectStructName () const
	Dictionary class name. More...

std::string	GetClass () const
	Return class of object.

std::string	GetComment () const
	Return comment of object.

std::string	GetName () const
	Return name of object.

virtual FrSE *	Clone () const
	Create a new instance of the object based on self.

bool	operator== (const FrSE &RHS) const
	comparison operator

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

	FrSE ()
	Default constructor.

	FrSE (const std::string &Name, const std::string &ClassId, const std::string &Comment="")
	constructor More...

virtual	~FrSE ()
	Desctructor.

virtual const char *	ObjectStructName () const
	Dictionary class name. More...

std::string	GetClass () const
	Return class of object.

std::string	GetComment () const
	Return comment of object.

std::string	GetName () const
	Return name of object.

virtual FrSE *	Clone () const
	Create a new instance of the object based on self.

bool	operator== (const FrSE &RHS) const
	comparison operator

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

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.

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

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

Static Public Member Functions
static const char *	StructName ()
	Return the dictionary name of the structure.

static const char *	StructName ()
	Return the dictionary name of the structure.

static const char *	StructName ()
	Return the dictionary name of the structure.

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

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

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

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

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

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

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

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

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

virtual FrSE *	pCreate (Common::IStream &Stream) const
	Create a new instance of the object based on the input stream.

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

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

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

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

virtual FrSE *	pCreate (Common::IStream &Stream) const
	Create a new instance of the object based on the input stream.

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

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

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

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

virtual FrSE *	pCreate (Common::IStream &Stream) const
	Create a new instance of the object based on the input stream.

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

Detailed Description

Contains field information of a dictionary structure.

This class gives information describing a single field of the class structure being described. In a dicitionary structure, there may be multiple occurances of FrSE. The order of the FrSE corresponds to the order of the fields as written to the stream.

See also: FrSH

Constructor & Destructor Documentation

◆ FrSE() [1/3]

FrSE::FrSE	(	const std::string &	Name,
		const std::string &	ClassId,
		const std::string &	Comment = `""`
	)

constructor

Parameters

[in]	Name	Name of an element of the structure being described by this dictionary structure.
[in]	ClassId	The data type of the element being described by this dictionary structure.
[in]	Comment	Description of the element being described by this dictionary strucutre.

◆ FrSE() [2/3]

FrameCPP::Version_8::FrSE::FrSE	(	const std::string &	Name,
		const std::string &	ClassId,
		const std::string &	Comment = `""`
	)

constructor

Parameters

[in]	Name	Name of an element of the structure being described by this dictionary structure.
[in]	ClassId	The data type of the element being described by this dictionary structure.
[in]	Comment	Description of the element being described by this dictionary strucutre.

◆ FrSE() [3/3]

FrameCPP::Version_8::FrSE::FrSE	(	const std::string &	Name,
		const std::string &	ClassId,
		const std::string &	Comment = `""`
	)

constructor

Parameters

[in]	Name	Name of an element of the structure being described by this dictionary structure.
[in]	ClassId	The data type of the element being described by this dictionary structure.
[in]	Comment	Description of the element being described by this dictionary strucutre.

Member Function Documentation

◆ Bytes() [1/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ Bytes() [2/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ Bytes() [3/3]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ Create() [1/3]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ Create() [2/3]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ Create() [3/3]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ ObjectStructName() [1/3]

const char * FrSE::ObjectStructName ( ) const

virtual

Dictionary class name.

Returns: The dictionary class name for this structure.

◆ ObjectStructName() [2/3]

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

virtual

Dictionary class name.

Returns: The dictionary class name for this structure.

◆ ObjectStructName() [3/3]

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

virtual

Dictionary class name.

Returns: The dictionary class name for this structure.

◆ pBytes() [1/3]

virtual INT_8U FrameCPP::Version_8::FrSE::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

Returns: The number of bytes need to read or write this object.

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

◆ pBytes() [2/3]

INT_8U FrSE::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

Returns: The number of bytes need to read or write this object.

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

◆ pBytes() [3/3]

virtual INT_8U FrameCPP::Version_8::FrSE::pBytes ( const Common::StreamBase & Stream ) const

protectedvirtual

Number of bytes needed to write this structure.

Parameters

[in] Stream The stream from which to the object is being read or written.

Returns: The number of bytes need to read or write this object.

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

◆ pWrite() [1/3]

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

protectedvirtual

Write the structure to the stream.

Parameters

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

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

◆ pWrite() [2/3]

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

protectedvirtual

Write the structure to the stream.

Parameters

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

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

◆ pWrite() [3/3]

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

protectedvirtual

Write the structure to the stream.

Parameters

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

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

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

/build/ldas-tools-framecpp-2.7.0/debian/tmp/usr/include/framecpp/Version8/FrSE.hh
/build/ldas-tools-framecpp-2.7.0/src/Version8/FrSE.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FrSE() [1/3]

◆ FrSE() [2/3]

◆ FrSE() [3/3]

Member Function Documentation

◆ Bytes() [1/3]

◆ Bytes() [2/3]

◆ Bytes() [3/3]

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ ObjectStructName() [1/3]

◆ ObjectStructName() [2/3]

◆ ObjectStructName() [3/3]

◆ pBytes() [1/3]

◆ pBytes() [2/3]

◆ pBytes() [3/3]

◆ pWrite() [1/3]

◆ pWrite() [2/3]

◆ pWrite() [3/3]