ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
FrameCPP::Version_8::FrEndOfFrame Class Reference

End of Frame data structure. More...

#include <FrEndOfFrame.hh>

Inheritance diagram for FrameCPP::Version_8::FrEndOfFrame:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrEndOfFrame:
Collaboration graph
[legend]

Classes

struct  data_type
 

Public Types

typedef INT_4S run_type
 
typedef INT_4U frame_type
 
typedef INT_4U GTimeS_type
 
typedef INT_4U GTimeN_type
 
typedef INT_4S run_type
 
typedef INT_4U frame_type
 
typedef INT_4U GTimeS_type
 
typedef INT_4U GTimeN_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 

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_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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::DescriptionStructDescription ()
 The description of structure.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 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 FrEndOfFramepCreate (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 FrEndOfFramepCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream.
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

 FrEndOfFrame (istream_type &Stream)
 Constructor via stream.
 
 FrEndOfFrame (istream_type &Stream)
 Constructor via stream.
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

struct data_type m_data
 
ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

End of Frame data structure.

Member Typedef Documentation

◆ frame_type [1/2]

◆ frame_type [2/2]

◆ GTimeN_type [1/2]

typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeN_type

◆ GTimeN_type [2/2]

typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeN_type

◆ GTimeS_type [1/2]

typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeS_type

◆ GTimeS_type [2/2]

typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeS_type

◆ istream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ istream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type
inherited

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

◆ object_type [2/2]

◆ ostream_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type
inherited

◆ run_type [1/2]

◆ run_type [2/2]

◆ self_type [1/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

◆ self_type [2/2]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type
inherited

Constructor & Destructor Documentation

◆ FrEndOfFrame() [1/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( )

Default constructor.

◆ FrEndOfFrame() [2/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( INT_4S Run,
INT_4U Frame )

Constructor.

◆ ~FrEndOfFrame() [1/2]

FrameCPP::Version_8::FrEndOfFrame::~FrEndOfFrame ( )
virtual

Desctructor.

◆ FrEndOfFrame() [3/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( istream_type & Stream)
private

Constructor via stream.

Parameters
[in]StreamThe input stream from which the object is being read.

◆ FrEndOfFrame() [4/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( )

Default constructor.

◆ FrEndOfFrame() [5/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( INT_4S Run,
INT_4U Frame )

Constructor.

◆ ~FrEndOfFrame() [2/2]

virtual FrameCPP::Version_8::FrEndOfFrame::~FrEndOfFrame ( )
virtual

Desctructor.

◆ FrEndOfFrame() [6/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( istream_type & Stream)
private

Constructor via stream.

Parameters
[in]StreamThe input stream from which the object is being read.

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]

template<typename ObjectType , typename ChecksumType >
virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream) const
virtualinherited

Return the number of bytes for this object.

Parameters
[in]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >
static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [2/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType , typename ChecksumType >
virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream) const
virtualinherited

Virtual constructor.

Parameters
[in]StreamThe input stream from where the object is being read.
Returns
Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType , typename ChecksumType >
virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( std::istream & Buffer) const
inlineprivatevirtualinherited

constructor - virtual

◆ 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]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe 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]RHSThe 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]RHSThe 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]RHSThe 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]RHSThe 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]StreamThe 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, ChecksumType >.

◆ 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]StreamThe 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, ChecksumType >.

◆ pCreate() [1/2]

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

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

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

◆ pCreate() [2/2]

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

Virtual constructor.

Parameters
[in]StreamThe input stream from which to read the object.
Returns
A new instance of this object.

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

◆ 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]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe 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]TargetThe version of the promoted frame specification.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object promoted to the next generation.

◆ pWrite() [1/2]

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

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

◆ pWrite() [2/2]

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

Write the structure to the stream.

Parameters
[in]StreamThe output stream where the object is to be written.

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

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

◆ Write() [1/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType , typename ChecksumType >
virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream) const
virtualinherited

Write object to the stream.

Member Data Documentation

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >
ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum
privateinherited

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_data

struct data_type FrameCPP::Version_8::FrEndOfFrame::m_data
private

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