End of Frame data structure. More...

#include <FrEndOfFrame.hh>

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

Public Member Functions
	FrEndOfFrame ()
	Default constructor.

	FrEndOfFrame (INT_4S Run, INT_4U Frame)
	Constructor.

virtual	~FrEndOfFrame ()
	Desctructor.

INT_8U	Bytes () const
	Number of bytes needed to write this structure.

INT_4S	GetRun () const
	Run number of the frame.

INT_4U	GetFrame () const
	frame number

const GPSTime &	GetGTime () const
	Get the GPS start time of this frame.

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

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

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

	FrEndOfFrame ()
	Default constructor.

	FrEndOfFrame (INT_4S Run, INT_4U Frame)
	Constructor.

virtual	~FrEndOfFrame ()
	Desctructor.

INT_8U	Bytes () const
	Number of bytes needed to write this structure.

INT_4S	GetRun () const
	Run number of the frame.

INT_4U	GetFrame () const
	frame number

const GPSTime &	GetGTime () const
	Get the GPS start time of this frame.

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

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

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

virtual streamsize_type	Bytes (const StreamBase &Stream) const
	Return the number of bytes for this object.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

virtual self_type *	Create (istream_type &Stream) const
	Virtual constructor.

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

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

Static Public Member Functions
static const char *	StructName ()
	The name structure name of this object.

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

static const char *	StructName ()
	The name structure name of this object.

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

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

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

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

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

Protected Member Functions
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Demotes object to previous version of the frame spec.

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

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

virtual FrEndOfFrame *	pCreate (istream_type &Stream) const
	Virtual constructor.

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

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

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

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

virtual FrEndOfFrame *	pCreate (istream_type &Stream) const
	Virtual constructor.

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

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

Detailed Description

End of Frame data structure.

Member Function Documentation

◆ Bytes() [1/3]

INT_8U FrameCPP::Version_8::FrEndOfFrame::Bytes ( ) const

Number of bytes needed to write this structure.

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

◆ Bytes() [2/3]

INT_8U FrameCPP::Version_8::FrEndOfFrame::Bytes ( ) const

Number of bytes needed to write this structure.

Returns: The number of bytes need to read or write 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/2]

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

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ Create() [2/2]

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

virtualinherited

Virtual constructor.

Parameters

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

Returns: Return pointer to the newly allocated resource.

◆ demote() [1/2]

FrEndOfFrame::demote_ret_type FrameCPP::Version_8::FrEndOfFrame::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		istream_type *	Stream ) const

protectedvirtual

Demotes object to previous version of the frame spec.

Parameters

[in]	Target	The version of the frame specification to demote too.
[in]	Obj	The version of the object to demote.
[in]	Stream	The input stream from which the original object was read.

Returns: An object of the previous generation.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrEndOfFrame::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		istream_type *	Stream ) const

protectedvirtual

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.

◆ GetFrame() [1/2]

INT_4U FrameCPP::Version_8::FrEndOfFrame::GetFrame ( ) const

inline

frame number

Return frame number.

Returns: The frame number. It is the same as the value in the FrameH frame datum.

◆ GetFrame() [2/2]

INT_4U FrameCPP::Version_8::FrEndOfFrame::GetFrame ( ) const

frame number

Returns: The frame number. It is the same as the value in the FrameH frame datum.

◆ GetGTime() [1/2]

const GPSTime & FrameCPP::Version_8::FrEndOfFrame::GetGTime ( ) const

inline

Get the GPS start time of this frame.

Returns: The start time of the frame.

◆ GetGTime() [2/2]

const GPSTime & FrameCPP::Version_8::FrEndOfFrame::GetGTime ( ) const

Get the GPS start time of this frame.

Returns: The start time of the frame.

◆ GetRun() [1/2]

INT_4S FrameCPP::Version_8::FrEndOfFrame::GetRun ( ) const

inline

Run number of the frame.

Return run number of frame.

Returns: The run number of frame. It is the same as the value in the FrameH run datum.

◆ GetRun() [2/2]

INT_4S FrameCPP::Version_8::FrEndOfFrame::GetRun ( ) const

Run number of the frame.

Returns: The run number of frame. It is the same as the value in the FrameH run datum.

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrEndOfFrame::ObjectStructName ( ) const

virtual

The name structure name of this object.

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

◆ ObjectStructName() [2/2]

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

virtual

The name structure name of this object.

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

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrEndOfFrame::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

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

◆ operator==() [2/4]

virtual bool FrameCPP::Version_8::FrEndOfFrame::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

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

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrEndOfFrame::operator== ( const FrEndOfFrame & RHS ) const

equality operator

Parameters

[in] RHS The FrEndOfFrame object to be compared.

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

◆ operator==() [4/4]

bool FrameCPP::Version_8::FrEndOfFrame::operator== ( const FrEndOfFrame & RHS ) const

equality operator

Parameters

[in] RHS The FrEndOfFrame object to be compared.

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

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrEndOfFrame::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/2]

virtual cmn_streamsize_type FrameCPP::Version_8::FrEndOfFrame::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 >.

◆ pCreate() [1/2]

FrEndOfFrame * FrameCPP::Version_8::FrEndOfFrame::pCreate ( istream_type & Stream ) const

protectedvirtual

Virtual constructor.

Parameters

[in] Stream The input stream from which to read the object.

Returns: A new instance of this object.

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

◆ pCreate() [2/2]

virtual FrEndOfFrame * FrameCPP::Version_8::FrEndOfFrame::pCreate ( istream_type & Stream ) const

protectedvirtual

Virtual constructor.

Parameters

[in] Stream The input stream from which to read the object.

Returns: A new instance of this object.

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

◆ promote() [1/2]

FrEndOfFrame::promote_ret_type FrameCPP::Version_8::FrEndOfFrame::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		istream_type *	Stream ) const

protectedvirtual

Promotes object to another version of the frame spec.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object promoted to the next generation.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrEndOfFrame::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		istream_type *	Stream ) const

protectedvirtual

Promotes object to another version of the frame spec.

Parameters

[in]	Target	The version of the promoted frame specification.
[in]	Obj	The object to be promoted.
[in]	Stream	The input stream from which the original object was read.

Returns: An object promoted to the next generation.

◆ pWrite() [1/3]

void FrameCPP::Version_8::FrEndOfFrame::pWrite ( ostream_type & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

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

◆ pWrite() [2/3]

virtual void FrameCPP::Version_8::FrEndOfFrame::pWrite ( ostream_type & Stream ) const

protectedvirtual

Write the structure to the stream.

Parameters

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

◆ pWrite() [3/3]

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

protectedpure virtualinherited

Write the structure to the stream.

Parameters

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

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_8::FrEndOfFrame::StructDescription ( )

static

The description of structure.

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

◆ StructDescription() [2/2]

static const Common::Description * FrameCPP::Version_8::FrEndOfFrame::StructDescription ( )

static

The description of structure.

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

◆ StructName() [1/2]

const char * FrameCPP::Version_8::FrEndOfFrame::StructName ( )

inlinestatic

The name structure name of this object.

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

◆ StructName() [2/2]

static const char * FrameCPP::Version_8::FrEndOfFrame::StructName ( )

static

The name structure name of this object.

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

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrEndOfFrame.hh
Version8/FrEndOfFrame.hh
Version8/FrEndOfFrame.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ Bytes() [1/3]

◆ Bytes() [2/3]

◆ Bytes() [3/3]

◆ Create() [1/2]

◆ Create() [2/2]

◆ demote() [1/2]

◆ demote() [2/2]

◆ GetFrame() [1/2]

◆ GetFrame() [2/2]

◆ GetGTime() [1/2]

◆ GetGTime() [2/2]

◆ GetRun() [1/2]

◆ GetRun() [2/2]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ pBytes() [1/2]

◆ pBytes() [2/2]

◆ pCreate() [1/2]

◆ pCreate() [2/2]

◆ promote() [1/2]

◆ promote() [2/2]

◆ pWrite() [1/3]

◆ pWrite() [2/3]

◆ pWrite() [3/3]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]

◆ StructName() [1/2]

◆ StructName() [2/2]