ldas-tools-framecpp  2.8.1
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | 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]

Public Types

typedef INT_4S run_type
 Run number. More...
 
typedef INT_4S run_type
 Run number. More...
 
typedef INT_4S run_type
 Run number. More...
 
typedef INT_4U frame_type
 Frame number. More...
 
typedef INT_4U frame_type
 Frame number. More...
 
typedef INT_4U frame_type
 Frame number. More...
 
typedef INT_4U GTimeS_type
 Frame start time in GPS seconds. More...
 
typedef INT_4U GTimeS_type
 Frame start time in GPS seconds. More...
 
typedef INT_4U GTimeS_type
 Frame start time in GPS seconds. More...
 
typedef INT_4U GTimeN_type
 Frame start time residual. More...
 
typedef INT_4U GTimeN_type
 Frame start time residual. More...
 
typedef INT_4U GTimeN_type
 Frame start time residual. More...
 
typedef GPSTime GTime_type
 Frmae start time in GPS units. More...
 
typedef GPSTime GTime_type
 Frmae start time in GPS units. More...
 
typedef GPSTime GTime_type
 Frmae start time in GPS units. 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< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > self_type
 
typedef ObjectWithChecksum< ObjectType, ChecksumType > 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
 

Public Member Functions

 FrEndOfFrame ()=default
 Default constructor. More...
 
 FrEndOfFrame (run_type Run, frame_type Frame)
 Constructor. More...
 
virtual ~FrEndOfFrame ()
 Desctructor. More...
 
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. More...
 
 FrEndOfFrame (run_type Run, frame_type Frame)
 Constructor. More...
 
virtual ~FrEndOfFrame ()
 Desctructor. More...
 
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. More...
 
 FrEndOfFrame (run_type Run, frame_type Frame)
 Constructor. More...
 
virtual ~FrEndOfFrame ()
 Desctructor. More...
 
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_typeGetGTime () const
 Get the GPS start time of this frame. More...
 
const GTime_typeGetGTime () const
 Get the GPS start time of this frame. More...
 
const GTime_typeGetGTime () 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_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typeCreate (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...
 

Static Public Member Functions

static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. More...
 
static const Common::DescriptionStructDescription ()
 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 Public Attributes

static constexpr run_type DEFAULT_RUN
 Default run number. More...
 
static constexpr frame_type DEFAULT_FRAME
 Default frame number. More...
 
static constexpr GTimeS_type DEFAULT_GTIME_S
 Default start time in GPS seconds. More...
 
static constexpr GTimeN_type DEFAULT_GTIME_N
 Default start time residual. More...
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

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_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (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. More...
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 
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
 
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeobject_base_type
 

Private Member Functions

virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual More...
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum. More...
 

Detailed Description

End of Frame data structure.

Member Typedef Documentation

◆ frame_type [1/3]

Frame number.

◆ frame_type [2/3]

Frame number.

◆ frame_type [3/3]

Frame number.

◆ GTime_type [1/3]

Frmae start time in GPS units.

◆ GTime_type [2/3]

Frmae start time in GPS units.

◆ GTime_type [3/3]

Frmae start time in GPS units.

◆ GTimeN_type [1/3]

Frame start time residual.

◆ GTimeN_type [2/3]

Frame start time residual.

◆ GTimeN_type [3/3]

Frame start time residual.

◆ GTimeS_type [1/3]

Frame start time in GPS seconds.

◆ GTimeS_type [2/3]

Frame start time in GPS seconds.

◆ GTimeS_type [3/3]

Frame start time in GPS seconds.

◆ istream_type [1/3]

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

◆ istream_type [2/3]

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

◆ istream_type [3/3]

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

◆ object_base_type [1/3]

◆ object_base_type [2/3]

◆ object_base_type [3/3]

◆ object_type [1/3]

◆ object_type [2/3]

◆ object_type [3/3]

◆ ostream_type [1/3]

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

◆ ostream_type [2/3]

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

◆ ostream_type [3/3]

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

◆ run_type [1/3]

Run number.

◆ run_type [2/3]

Run number.

◆ run_type [3/3]

Run number.

◆ self_type [1/3]

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

◆ self_type [2/3]

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

◆ self_type [3/3]

template<typename ObjectType , typename ChecksumType >
typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::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]

◆ struct_id_type [2/3]

◆ struct_id_type [3/3]

◆ 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

Constructor & Destructor Documentation

◆ FrEndOfFrame() [1/6]

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

Default constructor.

◆ FrEndOfFrame() [2/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( run_type  Run,
frame_type  Frame 
)

Constructor.

◆ ~FrEndOfFrame() [1/3]

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

Desctructor.

◆ FrEndOfFrame() [3/6]

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

Default constructor.

◆ FrEndOfFrame() [4/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( run_type  Run,
frame_type  Frame 
)

Constructor.

◆ ~FrEndOfFrame() [2/3]

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

Desctructor.

◆ FrEndOfFrame() [5/6]

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

Default constructor.

◆ FrEndOfFrame() [6/6]

FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame ( run_type  Run,
frame_type  Frame 
)

Constructor.

◆ ~FrEndOfFrame() [3/3]

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

Desctructor.

Member Function Documentation

◆ Bytes() [1/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

◆ Bytes() [2/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

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

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/3]

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

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

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/3]

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

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

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

◆ Create() [2/9]

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

◆ Create() [3/9]

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

◆ Create() [4/9]

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

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

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

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

constructor - virtual

◆ Create() [8/9]

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

constructor - virtual

◆ Create() [9/9]

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

constructor - virtual

◆ demote() [1/3]

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

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

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

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

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

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.

◆ 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

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

virtual const char* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::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]

virtual const char* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::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]

virtual const char* FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::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]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

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

virtual void FrameCPP::Version_8::FrEndOfFrameImpl::ClassicIO< FrEndOfFrame >::pWrite ( ostream_type Stream) const
inlineprotectedvirtualinherited

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

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

The description of structure.

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

◆ StructDescription() [2/3]

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

The description of structure.

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

◆ StructDescription() [3/3]

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

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

◆ Write() [1/3]

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

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

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

◆ DEFAULT_FRAME

static constexpr frame_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::DEFAULT_FRAME
staticconstexprinherited
Initial value:
{
0
}

Default frame number.

◆ DEFAULT_GTIME_N

static constexpr GTimeN_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::DEFAULT_GTIME_N
staticconstexprinherited
Initial value:
{
0
}

Default start time residual.

◆ DEFAULT_GTIME_S

static constexpr GTimeS_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::DEFAULT_GTIME_S
staticconstexprinherited
Initial value:
{
0
}

Default start time in GPS seconds.

◆ DEFAULT_RUN

static constexpr run_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::DEFAULT_RUN
staticconstexprinherited
Initial value:
{
0
}

Default run number.

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

◆ GTime

GTime_type FrameCPP::Version_8::FrEndOfFrameImpl::Data::GTime
protectedinherited

Frame start time in GPS seconds.

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

◆ run

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

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

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