ldas-tools-framecpp 2.7.0
|
End of Frame data structure. More...
#include <FrEndOfFrame.hh>
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_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual self_type * | Create (istream_type &Stream) const |
Virtual constructor. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
virtual void | Write (ostream_type &Stream) const |
Write object to the stream. | |
Static Public Member Functions | |
static const char * | StructName () |
The name structure name of this object. | |
static const Common::Description * | StructDescription () |
The description of structure. | |
static const char * | StructName () |
The name structure name of this object. | |
static const Common::Description * | StructDescription () |
The description of structure. | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. | |
static const char * | CheckSumDataClass () |
Data class to be used in class field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
static const char * | CheckSumDataComment () |
Comment to be used in comment field of FrSE. | |
Protected Member Functions | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. | |
virtual cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual FrEndOfFrame * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. | |
virtual demote_ret_type | demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const |
Demotes object to previous version of the frame spec. | |
virtual promote_ret_type | promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. | |
virtual cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
virtual FrEndOfFrame * | pCreate (istream_type &Stream) const |
Virtual constructor. | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. | |
Private Types | |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef ObjectWithChecksum< Common::FrameSpec::Object > | object_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type > | object_base_type |
Private Member Functions | |
FrEndOfFrame (istream_type &Stream) | |
Constructor via stream. | |
FrEndOfFrame (istream_type &Stream) | |
Constructor via stream. | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
virtual Object * | Create () const |
virtual Object * | Create (std::istream &Buffer) const |
constructor - virtual | |
Private Attributes | |
struct data_type | m_data |
ChecksumType | m_chkSum |
Structure checksum. | |
End of Frame data structure.
typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::frame_type |
typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::frame_type |
typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeN_type |
typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeN_type |
typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeS_type |
typedef INT_4U FrameCPP::Version_8::FrEndOfFrame::GTimeS_type |
|
inherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
private |
|
private |
|
inherited |
|
inherited |
typedef INT_4S FrameCPP::Version_8::FrEndOfFrame::run_type |
typedef INT_4S FrameCPP::Version_8::FrEndOfFrame::run_type |
|
inherited |
|
inherited |
FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame | ( | ) |
Default constructor.
FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame | ( | INT_4S | Run, |
INT_4U | Frame | ||
) |
Constructor.
|
virtual |
Desctructor.
|
private |
Constructor via stream.
[in] | Stream | The input stream from which the object is being read. |
FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame | ( | ) |
Default constructor.
FrameCPP::Version_8::FrEndOfFrame::FrEndOfFrame | ( | INT_4S | Run, |
INT_4U | Frame | ||
) |
Constructor.
|
virtual |
Desctructor.
|
private |
Constructor via stream.
[in] | Stream | The input stream from which the object is being read. |
INT_8U FrameCPP::Version_8::FrEndOfFrame::Bytes | ( | ) | const |
Number of bytes needed to write this structure.
INT_8U FrameCPP::Version_8::FrEndOfFrame::Bytes | ( | ) | const |
Number of bytes needed to write this structure.
|
virtualinherited |
Return the number of bytes for this object.
[in] | Stream | Stream characteristics used to determine the number of bytes needed to format the object for the Stream. |
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Data class to be used in class field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
staticinherited |
Comment to be used in comment field of FrSE.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.
|
inlineprivatevirtualinherited |
Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
virtualinherited |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
|
inlineprivatevirtualinherited |
constructor - virtual
|
inlineprivatevirtualinherited |
constructor - virtual
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[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. |
|
protectedvirtual |
Demotes object to previous version of the frame spec.
[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. |
|
inline |
frame number
Return frame number.
INT_4U FrameCPP::Version_8::FrEndOfFrame::GetFrame | ( | ) | const |
frame number
|
inline |
Get the GPS start time of this frame.
const GPSTime & FrameCPP::Version_8::FrEndOfFrame::GetGTime | ( | ) | const |
Get the GPS start time of this frame.
|
inline |
Run number of the frame.
Return run number of frame.
INT_4S FrameCPP::Version_8::FrEndOfFrame::GetRun | ( | ) | const |
Run number of the frame.
|
virtual |
The name structure name of this object.
|
virtual |
The name structure name of this object.
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
|
virtual |
equality operator for abstract data type
[in] | RHS | The object to be compared. |
bool FrameCPP::Version_8::FrEndOfFrame::operator== | ( | const FrEndOfFrame & | RHS | ) | const |
equality operator
[in] | RHS | The FrEndOfFrame object to be compared. |
bool FrameCPP::Version_8::FrEndOfFrame::operator== | ( | const FrEndOfFrame & | RHS | ) | const |
equality operator
[in] | RHS | The FrEndOfFrame object to be compared. |
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from which to read the object. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Promotes object to another version of the frame spec.
[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. |
|
protectedvirtual |
Promotes object to another version of the frame spec.
[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. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >.
|
static |
The description of structure.
|
static |
The description of structure.
|
inlinestatic |
The name structure name of this object.
|
static |
The name structure name of this object.
|
virtualinherited |
Write object to the stream.
|
virtualinherited |
Write object to the stream.
|
privateinherited |
Structure checksum.
The checksum for the structure when the structure is contained in a stream.
|
private |