ldas-tools-framecpp  2.7.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
FrameCPP::Version_8::FrHistory Class Referenceabstract

History Structure Definition. More...

#include <FrHistory.hh>

Inherits FrameCPP::Version_8::ObjectWithChecksum< ObjectType >, and 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...
 
FrHistoryMerge (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...
 
FrHistoryMerge (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_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.
 
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 FrHistorypCreate (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 FrHistorypCreate (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...
 

Detailed Description

History Structure Definition.

Member Typedef Documentation

◆ comment_type [1/2]

typedef STRING FrameCPP::Version_8::FrHistory::comment_type

Type for comment field.

Program name and relevant comments needed to define post-processing.

◆ comment_type [2/2]

typedef STRING FrameCPP::Version_8::FrHistory::comment_type

Type for comment field.

Program name and relevant comments needed to define post-processing.

◆ time_type [1/2]

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.

◆ time_type [2/2]

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.

Constructor & Destructor Documentation

◆ FrHistory() [1/8]

FrameCPP::Version_8::FrHistory::FrHistory ( )

Default constructor.

The constuction of the default FrHistory.

Returns
A new instance of this object.

◆ FrHistory() [2/8]

FrameCPP::Version_8::FrHistory::FrHistory ( const FrHistory Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

Constructs a new FrHistory based on a previously initialized FrHistory instance.

◆ FrHistory() [3/8]

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.

Parameters
[in]NameName of the history record
[in]TimeTime of post-processing (GPS seconds since GPS standard epoch)
[in]CommentProgram name and relevant comments needed to define post-processing
Returns
A new instance of this object.

◆ FrHistory() [4/8]

FrameCPP::Version_8::FrHistory::FrHistory ( Previous::FrHistory &  Source,
istream_type *  Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrHistory structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of an FrHistory object

Construct a new instance based upon reading a stream which implements an earlier version of the fame specification.

◆ FrHistory() [5/8]

FrameCPP::Version_8::FrHistory::FrHistory ( )

Default constructor.

Returns
A new instance of this object.

◆ FrHistory() [6/8]

FrameCPP::Version_8::FrHistory::FrHistory ( const FrHistory Source)

Copy Constructor.

Parameters
[in]SourceThe object from which to copy the information.
Returns
A new instance of this object.

◆ FrHistory() [7/8]

FrameCPP::Version_8::FrHistory::FrHistory ( const std::string &  Name,
time_type  Time,
const std::string &  Comment 
)

Constructor.

Parameters
[in]NameName of the history record
[in]TimeTime of post-processing (GPS seconds since GPS standard epoch)
[in]CommentProgram name and relevant comments needed to define post-processing
Returns
A new instance of this object.

◆ FrHistory() [8/8]

FrameCPP::Version_8::FrHistory::FrHistory ( Previous::FrHistory &  Source,
istream_type *  Stream 
)

Promotion Constructor.

Parameters
[in]SourceAn FrHistory structure from a previous frame specification.
[in]StreamThe stream from which the earliest version of the FrAdcData structure was read.
Returns
A new instance of an FrHistory object

Member Function Documentation

◆ Bytes() [1/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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/2]

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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

◆ Create() [1/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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() [2/2]

virtual self_type* FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::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.

◆ demote() [1/2]

FrHistory::demote_ret_type FrameCPP::Version_8::FrHistory::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::FrHistory::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.

◆ GetComment() [1/2]

const std::string& FrameCPP::Version_8::FrHistory::GetComment ( ) const
inline

Return the description of the post-porcessing.

Returns
The description of the post-processing

◆ GetComment() [2/2]

const std::string& FrameCPP::Version_8::FrHistory::GetComment ( ) const
inline

Return the description of the post-porcessing.

Returns
The description of the post-processing

◆ GetName() [1/2]

const std::string& FrameCPP::Version_8::FrHistory::GetName ( ) const

Return the name associate with the FrHistory structure.

Returns
The name associated with the FrHistory structure

◆ GetName() [2/2]

const std::string & FrameCPP::Version_8::FrHistory::GetName ( ) const

Return the name associate with the FrHistory structure.

Returns
The name associated with the FrHistory structure

◆ GetTime() [1/2]

time_type FrameCPP::Version_8::FrHistory::GetTime ( ) const
inline

Return the time of the post-processing.

Returns
The time of the post-processing.

◆ GetTime() [2/2]

time_type FrameCPP::Version_8::FrHistory::GetTime ( ) const
inline

Return the time of the post-processing.

Returns
The time of the post-processing.

◆ Merge() [1/2]

FrHistory & FrameCPP::Version_8::FrHistory::Merge ( const FrHistory RHS)

Merge with another FrHistory object.

Parameters
[in]RHSThe source of the information to append to this FrHistory structure.
Returns
A reference to this object
Todo:
Need to implement Merge routine

◆ Merge() [2/2]

FrHistory& FrameCPP::Version_8::FrHistory::Merge ( const FrHistory RHS)

Merge with another FrHistory object.

Parameters
[in]RHSThe source of the information to append to this FrHistory structure.
Returns
A reference to this object

◆ ObjectStructName() [1/2]

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

const char * FrameCPP::Version_8::FrHistory::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::FrHistory::operator== ( const FrHistory RHS) const
inline

equality operator

Parameters
[in]RHSThe FrHistory object to be compared.
Returns
The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ operator==() [2/4]

bool FrameCPP::Version_8::FrHistory::operator== ( const FrHistory RHS) const

equality operator

Parameters
[in]RHSThe FrHistory 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::FrHistory::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/4]

virtual bool FrameCPP::Version_8::FrHistory::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.

◆ pBytes() [1/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_8::FrHistory::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, checksum_type >.

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrHistory::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, checksum_type >.

◆ pCreate() [1/2]

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

Virtual constructor.

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

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

◆ pCreate() [2/2]

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

Virtual constructor.

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

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

◆ Promote() [1/2]

FrHistory::promote_ret_type FrameCPP::Version_8::FrHistory::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ Promote() [2/2]

static promote_ret_type FrameCPP::Version_8::FrHistory::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
static

Promote previous version of object to this version.

Parameters
[in]SourceThe frame specification version of the object.
[in]ObjThe previous version of the object.
[in]StreamStream from which the origional object was created.
Returns
A new instance of FrameH based on Obj

◆ promote() [1/2]

FrHistory::promote_ret_type FrameCPP::Version_8::FrHistory::promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]SourceThe 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::FrHistory::promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
) const
protectedvirtual

Promotes object to another version of the frame spec.

Parameters
[in]SourceThe 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]

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

Write the structure to the stream.

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

◆ pWrite() [2/3]

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

Write the structure to the stream.

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

◆ pWrite() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, checksum_type >::pWrite ( ostream_type &  Stream) const
protectedpure virtualinherited

◆ StructDescription() [1/2]

const Description * FrameCPP::Version_8::FrHistory::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::FrHistory::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::FrHistory::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::FrHistory::StructName ( )
static

The name structure name of this object.

Returns
The name of the structure as specified by the frame specification.

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