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

History Structure Definition. More...

#include <FrHistory.hh>

Inheritance diagram for FrameCPP::Version_8::FrHistory:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrHistory:
Collaboration graph
[legend]

Classes

struct  fr_history_data_type
 

Public Types

typedef STRING name_type
 Type for name of history record. More...
 
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. More...
 
typedef STRING comment_type
 Type for comment field. More...
 
typedef INT_4U time_type
 Type for time field. More...
 
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeself_type
 
typedef ObjectWithChecksum< Common::FrameSpec::Object, checksum_typeself_type
 
typedef IStream istream_type
 
typedef IStream istream_type
 
typedef OStream ostream_type
 
typedef OStream ostream_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef FrameSpec::version_type frame_spec_version_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef std::unique_ptr< Objectunique_object_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_arg_type
 
typedef object_type demote_ret_type
 
typedef object_type demote_ret_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_arg_type
 
typedef object_type promote_ret_type
 
typedef object_type promote_ret_type
 

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...
 
virtual std::string ErrorInfo () const
 
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...
 
virtual std::string ErrorInfo () const
 
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 ObjectCreate () const
 constructor - virtual 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 =0
 Write object to the stream. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
class_type GetClass () const
 Retrieve the class identifier. More...
 
const DescriptionGetDescription () const
 Retrieve FrSH/FrSE description of the parent object. More...
 
const DescriptionGetDescription () 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...
 
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...
 
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...
 
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 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::DescriptionStructDescription ()
 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. 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 object_type DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
 Down grade an object. 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...
 
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 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...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 
virtual class_type getClass () const
 Retrieve the class identifier. More...
 

Private Types

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
 

Private Member Functions

 FrHistory (istream_type &Stream)
 Stream Constructor. More...
 
 FrHistory (istream_type &Stream)
 Stream Constructor. 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

fr_history_data_type m_data
 
checksum_type m_chkSum
 Structure checksum. More...
 
const class_type m_class
 Storage for the class identifier. More...
 
const Description *const m_desc
 Description for parent class. 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.

◆ demote_arg_type [1/2]

◆ demote_arg_type [2/2]

◆ demote_ret_type [1/2]

◆ demote_ret_type [2/2]

◆ frame_spec_version_type [1/2]

◆ frame_spec_version_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ name_type [1/2]

typedef STRING FrameCPP::Version_8::FrHistory::name_type

Type for name of history record.

◆ name_type [2/2]

typedef STRING FrameCPP::Version_8::FrHistory::name_type

Type for name of history record.

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrHistory::object_type
private

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrHistory::object_type
private

◆ ostream_type [1/2]

◆ ostream_type [2/2]

◆ promote_arg_type [1/2]

◆ promote_arg_type [2/2]

◆ promote_ret_type [1/2]

◆ promote_ret_type [2/2]

◆ self_type [1/2]

◆ self_type [2/2]

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

◆ unique_object_type [1/2]

◆ unique_object_type [2/2]

Constructor & Destructor Documentation

◆ FrHistory() [1/10]

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

Default constructor.

The constuction of the default FrHistory.

Returns
A new instance of this object.

◆ FrHistory() [2/10]

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

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

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

FrameCPP::Version_8::FrHistory::FrHistory ( istream_type Stream)
private

Stream Constructor.

Construct a new instance based upon reading a stream.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

◆ FrHistory() [6/10]

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

Default constructor.

Returns
A new instance of this object.

◆ FrHistory() [7/10]

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

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

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

◆ FrHistory() [10/10]

FrameCPP::Version_8::FrHistory::FrHistory ( istream_type Stream)
private

Stream Constructor.

Parameters
[in]StreamThe stream from which the object is being read.
Returns
A new instance of this object.

Member Function Documentation

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

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

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

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

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

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

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

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

Comment to be used in comment field of FrSE.

◆ Clone() [1/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.

◆ Clone() [2/2]

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

constructor - virtual copy constructor

Reimplemented in FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrameH, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, and FrameCPP::Common::PTR_STRUCT< DC, DI >.

◆ Create() [1/7]

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

◆ Create() [2/7]

virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [3/7]

virtual Object* FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type >::Create ( ) const
inlineprivatevirtualinherited

◆ Create() [4/7]

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.

◆ Create() [5/7]

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.

◆ Create() [6/7]

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

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Create() [7/7]

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

constructor - virtual

Reimplemented from FrameCPP::Common::FrameSpec::ObjectInterface.

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

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

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

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

◆ DemoteObject() [1/2]

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.

◆ DemoteObject() [2/2]

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

◆ ErrorInfo() [1/2]

std::string FrameCPP::Version_8::FrHistory::ErrorInfo ( ) const
virtual

◆ ErrorInfo() [2/2]

virtual std::string FrameCPP::Version_8::FrHistory::ErrorInfo ( ) const
virtual

◆ GetClass() [1/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [1/2]

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

Retrieve the class identifier.

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

◆ GetClass() [2/2]

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

Retrieve the class identifier.

Returns
The class identifier.

◆ getClass() [2/2]

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

Retrieve the class identifier.

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

◆ 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

◆ GetDescription() [1/2]

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.

◆ GetDescription() [2/2]

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

Retrieve FrSH/FrSE description of the parent object.

Returns
The description of the parent class.

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

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

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.

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

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

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

◆ operator==() [1/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.

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

◆ operator==() [2/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.

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

◆ operator==() [3/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==() [4/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.

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

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

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

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

◆ PromoteObject() [1/5]

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

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

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

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

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() [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< Common::FrameSpec::Object , 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.

◆ VerifyObject() [1/2]

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

◆ VerifyObject() [2/2]

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

◆ Write() [1/3]

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

Write object to the stream.

◆ Write() [2/3]

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

Write object to the stream.

◆ Write() [3/3]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::Write ( ostream_type Stream) const
pure virtualinherited

Write object to the stream.

Parameters
[in,out]StreamThe stream being written with the contents of object.

Implemented in FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrAdcData, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_7::FrSimEvent, FrameCPP::Version_7::FrSimData, FrameCPP::Version_7::FrSerData, FrameCPP::Version_7::FrRawData, FrameCPP::Version_7::FrEvent, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTable, FrameCPP::Version_6::FrSummary, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrSimEvent, FrameCPP::Version_6::FrSimData, FrameCPP::Version_6::FrSerData, FrameCPP::Version_6::FrRawData, FrameCPP::Version_6::FrProcData, FrameCPP::Version_6::FrMsg, FrameCPP::Version_6::FrEvent, FrameCPP::Version_6::FrEndOfFrame, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrDetector, FrameCPP::Version_6::FrAdcData, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrTrigData, FrameCPP::Version_4::FrTOC, FrameCPP::Version_4::FrTable, FrameCPP::Version_4::FrSummary, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrSimEvent, FrameCPP::Version_4::FrSimData, FrameCPP::Version_4::FrSerData, FrameCPP::Version_4::FrRawData, FrameCPP::Version_4::FrProcData, FrameCPP::Version_4::FrEndOfFrame, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrDetector, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrAdcData, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrTrigData, FrameCPP::Version_3::FrSummary, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrSimData, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSerData, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrRawData, FrameCPP::Version_3::FrProcData, FrameCPP::Version_3::FrMsg, FrameCPP::Version_3::FrHistory, FrameCPP::Version_3::FrEndOfFrame, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_3::FrDetector, FrameCPP::Version_3::FrameH, and FrameCPP::Version_3::FrAdcData.

◆ WriteNext() [1/2]

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.

◆ WriteNext() [2/2]

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.

Member Data Documentation

◆ m_chkSum

Structure checksum.

The checksum for the structure when the structure is contained in a stream.

◆ m_class

const class_type FrameCPP::Common::FrameSpec::Object::m_class
privateinherited

Storage for the class identifier.

The class identifier uniquely identifies the parent class within the frame specification. All instances of parent class will have the same class identifier.

◆ m_data

fr_history_data_type FrameCPP::Version_8::FrHistory::m_data
private

◆ m_desc

const Description *const FrameCPP::Common::FrameSpec::Object::m_desc
privateinherited

Description for parent class.

The description for the parent class composed of one FrSH and one or more FrSE elements.


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