End of Frame data structure. More...

#include <FrEndOfFrame.hh>

Inherits FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >, FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >, and FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >.

Public Types
typedef INT_4S	run_type
	Run number.

typedef INT_4S	run_type
	Run number.

typedef INT_4S	run_type
	Run number.

typedef INT_4U	frame_type
	Frame number.

typedef INT_4U	frame_type
	Frame number.

typedef INT_4U	frame_type
	Frame number.

typedef INT_4U	GTimeS_type
	Frame start time in GPS seconds.

typedef INT_4U	GTimeS_type
	Frame start time in GPS seconds.

typedef INT_4U	GTimeS_type
	Frame start time in GPS seconds.

typedef INT_4U	GTimeN_type
	Frame start time residual.

typedef INT_4U	GTimeN_type
	Frame start time residual.

typedef INT_4U	GTimeN_type
	Frame start time residual.

typedef GPSTime	GTime_type
	Frmae start time in GPS units.

typedef GPSTime	GTime_type
	Frmae start time in GPS units.

typedef GPSTime	GTime_type
	Frmae start time in GPS units.

Public Member Functions
	FrEndOfFrame ()=default
	Default constructor.

	FrEndOfFrame (run_type Run, frame_type Frame)
	Constructor.

virtual	~FrEndOfFrame ()
	Desctructor.

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

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

	FrEndOfFrame ()=default
	Default constructor.

	FrEndOfFrame (run_type Run, frame_type Frame)
	Constructor.

virtual	~FrEndOfFrame ()
	Desctructor.

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

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

	FrEndOfFrame ()=default
	Default constructor.

	FrEndOfFrame (run_type Run, frame_type Frame)
	Constructor.

virtual	~FrEndOfFrame ()
	Desctructor.

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

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

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

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

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

run_type	GetRun () const
	Run number of the frame. More...

run_type	GetRun () const
	Run number of the frame. More...

run_type	GetRun () const
	Run number of the frame. More...

frame_type	GetFrame () const
	frame number More...

frame_type	GetFrame () const
	frame number More...

frame_type	GetFrame () const
	frame number More...

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

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

const GTime_type &	GetGTime () const
	Get the GPS start time of this frame. 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.

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 Common::Description *	StructDescription ()
	The description of structure. More...

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

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

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

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

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

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

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

static struct_id_type	FrameSpecId ()
	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.

Static Public Attributes
static run_type constexpr	DEFAULT_RUN
	Default run number.

static frame_type constexpr	DEFAULT_FRAME
	Default frame number.

static GTimeS_type constexpr	DEFAULT_GTIME_S
	Default start time in GPS seconds.

static GTimeN_type constexpr	DEFAULT_GTIME_N
	Default start time residual.

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

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

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

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

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

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

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

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

virtual 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 self_type *	pCreate (istream_type &Stream) const
	Virtual constructor. 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	pWrite (ostream_type &Stream) const
	Write the structure to the stream. More...

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

Protected Attributes
run_type	run

frame_type	frame

GTime_type	GTime
	Frame start time in GPS seconds.

Detailed Description

End of Frame data structure.

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.

◆ demote() [1/3]

template<typename T>

virtual demote_ret_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtualinherited

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

template<typename T>

virtual demote_ret_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtualinherited

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

template<typename T>

virtual demote_ret_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::demote	(	INT_2U	Target,
		demote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtualinherited

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

frame_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetFrame ( ) const

inlineinherited

frame number

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

◆ GetFrame() [2/3]

frame_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetFrame ( ) const

inlineinherited

frame number

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

◆ GetFrame() [3/3]

frame_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetFrame ( ) const

inlineinherited

frame number

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

◆ GetGTime() [1/3]

const GTime_type& FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetGTime ( ) const

inlineinherited

Get the GPS start time of this frame.

Returns: The start time of the frame.

◆ GetGTime() [2/3]

const GTime_type& FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetGTime ( ) const

inlineinherited

Get the GPS start time of this frame.

Returns: The start time of the frame.

◆ GetGTime() [3/3]

const GTime_type& FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetGTime ( ) const

inlineinherited

Get the GPS start time of this frame.

Returns: The start time of the frame.

◆ GetRun() [1/3]

run_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetRun ( ) const

inlineinherited

Run number of the frame.

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

◆ GetRun() [2/3]

run_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetRun ( ) const

inlineinherited

Run number of the frame.

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

◆ GetRun() [3/3]

run_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GetRun ( ) const

inlineinherited

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

template<typename T>

virtual const char* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::ObjectStructName ( ) const

inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/3]

template<typename T>

virtual const char* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::ObjectStructName ( ) const

inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [3/3]

template<typename T>

virtual const char* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::ObjectStructName ( ) const

inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/6]

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

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

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

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

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

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.

◆ pBytes() [1/3]

template<typename T>

virtual cmn_streamsize_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

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.

◆ pBytes() [2/3]

template<typename T>

virtual cmn_streamsize_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

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.

◆ pBytes() [3/3]

template<typename T>

virtual cmn_streamsize_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::pBytes ( const Common::StreamBase & Stream ) const

inlineprotectedvirtualinherited

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.

◆ pCreate() [1/3]

template<typename T>

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

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

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

Returns: A new instance of this object.

◆ pCreate() [2/3]

template<typename T>

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

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

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

Returns: A new instance of this object.

◆ pCreate() [3/3]

template<typename T>

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

inlineprotectedvirtualinherited

Virtual constructor.

Parameters

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

Returns: A new instance of this object.

◆ promote() [1/3]

template<typename T>

virtual promote_ret_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtualinherited

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

template<typename T>

virtual promote_ret_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtualinherited

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

template<typename T>

virtual promote_ret_type FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::promote	(	INT_2U	Target,
		promote_arg_type	Obj,
		istream_type *	Stream
	)		const

inlineprotectedvirtualinherited

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]

template<typename T>

virtual void FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

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

◆ pWrite() [2/3]

template<typename T>

virtual void FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

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

◆ pWrite() [3/3]

template<typename T>

virtual void FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::pWrite ( ostream_type & Stream ) const

inlineprotectedvirtualinherited

Write the structure to the stream.

Parameters

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

◆ StructDescription() [1/3]

template<typename T>

static const Common::Description* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::StructDescription ( )

inlinestaticinherited

The description of structure.

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

◆ StructDescription() [2/3]

template<typename T>

static const Common::Description* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::StructDescription ( )

inlinestaticinherited

The description of structure.

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

◆ StructDescription() [3/3]

template<typename T>

static const Common::Description* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< T >::StructDescription ( )

inlinestaticinherited

The description of structure.

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

Member Data Documentation

◆ frame

frame_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::frame

protectedinherited

Frame number, monotonically increasing until end of run; This is the same as the FrameH::frame number datum.

◆ run

run_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::run

protectedinherited

Run number. This is the same as the FrameH::rum member

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

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ Bytes() [1/3]

◆ Bytes() [2/3]

◆ Bytes() [3/3]

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ demote() [1/3]

◆ demote() [2/3]

◆ demote() [3/3]

◆ GetFrame() [1/3]

◆ GetFrame() [2/3]

◆ GetFrame() [3/3]

◆ GetGTime() [1/3]

◆ GetGTime() [2/3]

◆ GetGTime() [3/3]

◆ GetRun() [1/3]

◆ GetRun() [2/3]

◆ GetRun() [3/3]

◆ ObjectStructName() [1/3]

◆ ObjectStructName() [2/3]

◆ ObjectStructName() [3/3]

◆ operator==() [1/6]

◆ operator==() [2/6]

◆ operator==() [3/6]

◆ operator==() [4/6]

◆ operator==() [5/6]

◆ operator==() [6/6]

◆ pBytes() [1/3]

◆ pBytes() [2/3]

◆ pBytes() [3/3]

◆ pCreate() [1/3]

◆ pCreate() [2/3]

◆ pCreate() [3/3]

◆ promote() [1/3]

◆ promote() [2/3]

◆ promote() [3/3]

◆ pWrite() [1/3]

◆ pWrite() [2/3]

◆ pWrite() [3/3]

◆ StructDescription() [1/3]

◆ StructDescription() [2/3]

◆ StructDescription() [3/3]

Member Data Documentation

◆ frame

◆ run