ldas-tools-framecpp  2.6.2
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | 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:
FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > FrameCPP::Common::FrameSpec::Object FrameCPP::Common::FrameSpec::ObjectInterface

Public Types

typedef INT_4S run_type
 
typedef INT_4U frame_type
 
typedef INT_4U GTimeS_type
 
typedef INT_4U GTimeN_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeself_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 

Public Member Functions

 FrEndOfFrame ()
 Default constructor. More...
 
 FrEndOfFrame (INT_4S Run, INT_4U Frame)
 Constructor. More...
 
virtual ~FrEndOfFrame ()
 Desctructor. More...
 
INT_8U Bytes () const
 Number of bytes needed to write this structure. More...
 
INT_4S GetRun () const
 Run number of the frame. More...
 
INT_4U GetFrame () const
 frame number More...
 
const GPSTimeGetGTime () const
 Get the GPS start time of this frame. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. 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 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 void Write (ostream_type &Stream) const
 Write object to the stream. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const Description * GetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
ostream_typeWriteNext (ostream_type &Stream) const
 Write a next pointer to the parent to the stream. More...
 
virtual ObjectClone () const
 constructor - virtual copy constructor More...
 
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
 
virtual void VerifyObject (Verify &Verifier, IFrameStream &Stream) const
 Verify an object. More...
 

Static Public Member Functions

static const char * StructName ()
 The name structure name of this object. More...
 
static const Common::DescriptionStructDescription ()
 The description of structure. 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 object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. More...
 
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 
template<typename PreviousType , typename CurrentType >
static object_type PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
 Upgrade an object. More...
 

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 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 FrEndOfFramepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Detailed Description

End of Frame data structure.

Member Typedef Documentation

◆ demote_arg_type

◆ demote_ret_type

◆ frame_spec_version_type

◆ frame_type

◆ GTimeN_type

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

◆ GTimeS_type

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

◆ istream_type

◆ ostream_type

◆ promote_arg_type

◆ promote_ret_type

◆ run_type

◆ self_type

◆ unique_object_type

Constructor & Destructor Documentation

◆ FrEndOfFrame() [1/2]

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

Default constructor.

◆ FrEndOfFrame() [2/2]

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

Constructor.

◆ ~FrEndOfFrame()

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

Desctructor.

Member Function Documentation

◆ Bytes() [1/2]

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

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ CheckSumDataClass()

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::CheckSumDataClass ( )
staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment()

static const char* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::CheckSumDataComment ( )
staticinherited

Comment to be used in comment field of FrSE.

◆ Clone()

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const
virtualinherited

◆ Create()

Virtual constructor.

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

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ demote()

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ DemoteObject()

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject ( frame_spec_version_type  Target,
object_type  Obj,
istream_type Stream 
)
staticinherited

Down grade an object.

Parameters
[in]TargetThis is the version of the frame specification of the demoted object.
[in]ObjThe base object.
[in]StreamStream from which Obj was created.
Returns
A pointer to the objected derived by demoting Obj.

◆ GetClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const
inlineinherited

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass()

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const
protectedvirtualinherited

Retrieve the class identifier.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription()

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const
inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetFrame()

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

frame number

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

◆ GetGTime()

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

Get the GPS start time of this frame.

Returns
The start time of the frame.

◆ GetRun()

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

Run number of the frame.

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

◆ ObjectStructName()

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ operator==() [1/2]

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

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ pBytes()

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< Common::FrameSpec::Object, checksum_type >.

◆ pCreate()

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< Common::FrameSpec::Object, checksum_type >.

◆ promote()

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.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/3]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/3]

template<typename PreviousType , typename CurrentType >
static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( frame_spec_version_type  Target,
frame_spec_version_type  Source,
object_type  Obj,
istream_type Stream 
)
staticinherited

Upgrade an object.

Parameters
[in]TargetPromote Obj to this version of the frame specification.
[in]SourceObj conforms to this version of the frame specification.
[in]ObjObject to be converted
[in]StreamOriginating stream for Obj.
Returns
A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/3]

template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target,
FrameSpec::ObjectInterface::frame_spec_version_type  Source,
FrameSpec::ObjectInterface::promote_arg_type  Obj,
IStream Stream 
)
inherited

◆ pWrite()

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< Common::FrameSpec::Object, checksum_type >.

◆ StructDescription()

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.

◆ StructName()

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.

◆ VerifyObject()

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject ( Verify Verifier,
IFrameStream Stream 
) const
virtualinherited

◆ Write()

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::Write ( ostream_type Stream) const
virtualinherited

Write object to the stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext()

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type Stream) const
inherited

Write a next pointer to the parent to the stream.

Parameters
[in,out]StreamThe output stream to receive the next pointer.
Returns
The output stream.

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