ldas-tools-framecpp
2.7.0
|
History Structure Definition. More...
#include <FrHistory.hh>
Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >.
Public Types | |
typedef STRING | name_type |
Type for name of history record. | |
typedef STRING | comment_type |
Type for comment field. More... | |
typedef INT_4U | time_type |
Type for time field. More... | |
typedef STRING | name_type |
Type for name of history record. | |
typedef STRING | comment_type |
Type for comment field. More... | |
typedef INT_4U | time_type |
Type for time field. More... | |
Public Member Functions | |
FrHistory () | |
Default constructor. More... | |
FrHistory (const FrHistory &Source) | |
Copy Constructor. More... | |
FrHistory (const std::string &Name, time_type Time, const std::string &Comment) | |
Constructor. More... | |
FrHistory (Previous::FrHistory &Source, istream_type *Stream) | |
Promotion Constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const std::string & | GetName () const |
Return the name associate with the FrHistory structure. More... | |
time_type | GetTime () const |
Return the time of the post-processing. More... | |
const std::string & | GetComment () const |
Return the description of the post-porcessing. More... | |
FrHistory & | Merge (const FrHistory &RHS) |
Merge with another FrHistory object. More... | |
bool | operator== (const FrHistory &RHS) const |
equality operator More... | |
virtual bool | operator== (const Common::FrameSpec::Object &RHS) const |
equality operator for abstract data type More... | |
FrHistory () | |
Default constructor. More... | |
FrHistory (const FrHistory &Source) | |
Copy Constructor. More... | |
FrHistory (const std::string &Name, time_type Time, const std::string &Comment) | |
Constructor. More... | |
FrHistory (Previous::FrHistory &Source, istream_type *Stream) | |
Promotion Constructor. More... | |
virtual const char * | ObjectStructName () const |
The name structure name of this object. More... | |
const std::string & | GetName () const |
Return the name associate with the FrHistory structure. More... | |
time_type | GetTime () const |
Return the time of the post-processing. More... | |
const std::string & | GetComment () const |
Return the description of the post-porcessing. More... | |
FrHistory & | Merge (const FrHistory &RHS) |
Merge with another FrHistory object. More... | |
bool | operator== (const FrHistory &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 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 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. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
static const char * | StructName () |
The name structure name of this object. More... | |
static const Common::Description * | StructDescription () |
The description of structure. More... | |
static promote_ret_type | Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) |
Promote previous version of object to this version. More... | |
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. More... | |
virtual promote_ret_type | promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrHistory * | pCreate (istream_type &Stream) const |
Virtual constructor. More... | |
virtual void | pWrite (ostream_type &Stream) const |
Write the structure to the stream. 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 Source, promote_arg_type Obj, istream_type *Stream) const |
Promotes object to another version of the frame spec. More... | |
cmn_streamsize_type | pBytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
virtual FrHistory * | 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=0 |
Write the structure to the stream. More... | |
History Structure Definition.
typedef STRING FrameCPP::Version_8::FrHistory::comment_type |
Type for comment field.
Program name and relevant comments needed to define post-processing.
typedef STRING FrameCPP::Version_8::FrHistory::comment_type |
Type for comment field.
Program name and relevant comments needed to define post-processing.
typedef INT_4U FrameCPP::Version_8::FrHistory::time_type |
Type for time field.
Time of post-processing, GPS time in integer seconds since GPS standard epoch.
typedef INT_4U FrameCPP::Version_8::FrHistory::time_type |
Type for time field.
Time of post-processing, GPS time in integer seconds since GPS standard epoch.
FrameCPP::Version_8::FrHistory::FrHistory | ( | ) |
Default constructor.
The constuction of the default FrHistory.
FrameCPP::Version_8::FrHistory::FrHistory | ( | const FrHistory & | Source | ) |
FrameCPP::Version_8::FrHistory::FrHistory | ( | const std::string & | Name, |
time_type | Time, | ||
const std::string & | Comment | ||
) |
Constructor.
Construct a new instance with values for all important.
[in] | Name | Name of the history record |
[in] | Time | Time of post-processing (GPS seconds since GPS standard epoch) |
[in] | Comment | Program name and relevant comments needed to define post-processing |
FrameCPP::Version_8::FrHistory::FrHistory | ( | Previous::FrHistory & | Source, |
istream_type * | Stream | ||
) |
Promotion Constructor.
[in] | Source | An FrHistory structure from a previous frame specification. |
[in] | Stream | The stream from which the earliest version of the FrAdcData structure was read. |
Construct a new instance based upon reading a stream which implements an earlier version of the fame specification.
FrameCPP::Version_8::FrHistory::FrHistory | ( | ) |
Default constructor.
FrameCPP::Version_8::FrHistory::FrHistory | ( | const FrHistory & | Source | ) |
Copy Constructor.
[in] | Source | The object from which to copy the information. |
FrameCPP::Version_8::FrHistory::FrHistory | ( | const std::string & | Name, |
time_type | Time, | ||
const std::string & | Comment | ||
) |
Constructor.
[in] | Name | Name of the history record |
[in] | Time | Time of post-processing (GPS seconds since GPS standard epoch) |
[in] | Comment | Program name and relevant comments needed to define post-processing |
FrameCPP::Version_8::FrHistory::FrHistory | ( | Previous::FrHistory & | Source, |
istream_type * | Stream | ||
) |
|
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. |
|
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. |
|
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. |
|
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 |
Return the description of the post-porcessing.
|
inline |
Return the description of the post-porcessing.
const std::string & FrameCPP::Version_8::FrHistory::GetName | ( | ) | const |
const std::string& FrameCPP::Version_8::FrHistory::GetName | ( | ) | const |
|
inline |
Return the time of the post-processing.
|
inline |
Return the time of the post-processing.
|
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. |
|
inline |
equality operator
[in] | RHS | The FrHistory object to be compared. |
bool FrameCPP::Version_8::FrHistory::operator== | ( | const FrHistory & | RHS | ) | const |
equality operator
[in] | RHS | The FrHistory 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, checksum_type >.
|
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, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
protectedvirtual |
Virtual constructor.
[in] | Stream | The input stream from where the object is being read. |
Implements FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >.
|
static |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
static |
Promote previous version of object to this version.
[in] | Source | The frame specification version of the object. |
[in] | Obj | The previous version of the object. |
[in] | Stream | Stream from which the origional object was created. |
|
protectedvirtual |
Promotes object to another version of the frame spec.
[in] | Source | 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] | Source | 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. |
|
protectedvirtual |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
|
protectedpure virtualinherited |
Write the structure to the stream.
[in] | Stream | The output stream where the object is to be written. |
Implemented in FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrRawData, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTable, FrameCPP::Version_8::FrSummary, FrameCPP::Version_8::FrSimEvent, FrameCPP::Version_8::FrSimData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSerData, FrameCPP::Version_8::FrSE, and FrameCPP::Version_8::FrRawData.
|
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.