History Structure Definition. More...

#include <FrHistory.hh>

Inheritance diagram for FrameCPP::Version_8::FrHistory:

Collaboration diagram for FrameCPP::Version_8::FrHistory:

Classes
struct	fr_history_data_type

Public Types
typedef STRING	name_type
	Type for name of history record.

typedef STRING	comment_type
	Type for comment field.

typedef INT_4U	time_type
	Type for time field.

typedef STRING	name_type
	Type for name of history record.

typedef STRING	comment_type
	Type for comment field.

typedef INT_4U	time_type
	Type for time field.

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
	FrHistory ()
	Default constructor.

	FrHistory (const FrHistory &Source)
	Copy Constructor.

	FrHistory (const std::string &Name, time_type Time, const std::string &Comment)
	Constructor.

	FrHistory (Previous::FrHistory &Source, istream_type *Stream)
	Promotion Constructor.

virtual const char *	ObjectStructName () const
	The name structure name of this object.

virtual std::string	ErrorInfo () const

const std::string &	GetName () const
	Return the name associate with the FrHistory structure.

time_type	GetTime () const
	Return the time of the post-processing.

const std::string &	GetComment () const
	Return the description of the post-porcessing.

FrHistory &	Merge (const FrHistory &RHS)
	Merge with another FrHistory object.

bool	operator== (const FrHistory &RHS) const
	equality operator

virtual bool	operator== (const Common::FrameSpec::Object &RHS) const
	equality operator for abstract data type

	FrHistory ()
	Default constructor.

	FrHistory (const FrHistory &Source)
	Copy Constructor.

	FrHistory (const std::string &Name, time_type Time, const std::string &Comment)
	Constructor.

	FrHistory (Previous::FrHistory &Source, istream_type *Stream)
	Promotion Constructor.

virtual const char *	ObjectStructName () const
	The name structure name of this object.

virtual std::string	ErrorInfo () const

const std::string &	GetName () const
	Return the name associate with the FrHistory structure.

time_type	GetTime () const
	Return the time of the post-processing.

const std::string &	GetComment () const
	Return the description of the post-porcessing.

FrHistory &	Merge (const FrHistory &RHS)
	Merge with another FrHistory object.

bool	operator== (const FrHistory &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 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 promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
	Promote previous version of object to this version.

static const char *	StructName ()
	The name structure name of this object.

static const Common::Description *	StructDescription ()
	The description of structure.

static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
	Promote previous version of object to this version.

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 Source, promote_arg_type Obj, istream_type *Stream) const
	Promotes object to another version of the frame spec.

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

virtual FrHistory *	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 Source, promote_arg_type Obj, istream_type *Stream) const
	Promotes object to another version of the frame spec.

cmn_streamsize_type	pBytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure.

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

	FrHistory (istream_type &Stream)
	Stream Constructor.

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
fr_history_data_type	m_data

ChecksumType	m_chkSum
	Structure checksum.

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.

◆ istream_type [1/2]

template<typename ObjectType , typename ChecksumType >

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type

inherited

◆ istream_type [2/2]

template<typename ObjectType , typename ChecksumType >

typedef IStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::istream_type

inherited

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

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

◆ object_base_type [2/2]

typedef Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object , checksum_type > FrameCPP::Version_8::ObjectWithChecksum< Common::FrameSpec::Object >::object_base_type

privateinherited

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

template<typename ObjectType , typename ChecksumType >

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type

inherited

◆ ostream_type [2/2]

template<typename ObjectType , typename ChecksumType >

typedef OStream FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::ostream_type

inherited

◆ self_type [1/2]

template<typename ObjectType , typename ChecksumType >

typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type

inherited

◆ self_type [2/2]

template<typename ObjectType , typename ChecksumType >

typedef ObjectWithChecksum< ObjectType, ChecksumType > FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::self_type

inherited

◆ 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/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] Source The 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]	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

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]	Source	An FrHistory structure from a previous frame specification.
[in]	Stream	The 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] Stream The 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] Source The 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]	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

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]	Source	An FrHistory structure from a previous frame specification.
[in]	Stream	The 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] Stream The stream from which the object is being read.

Returns: A new instance of this object.

Member Function Documentation

◆ Bytes() [1/2]

template<typename ObjectType , typename ChecksumType >

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream 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]

template<typename ObjectType , typename ChecksumType >

virtual streamsize_type FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Bytes ( const StreamBase & Stream ) const

virtualinherited

Return the number of bytes for this object.

Parameters

[in] Stream Stream characteristics used to determine the number of bytes needed to format the object for the Stream.

Returns: The number of bytes for this object

◆ CheckSumDataClass() [1/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataClass() [2/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataClass ( )

staticinherited

Data class to be used in class field of FrSE.

◆ CheckSumDataComment() [1/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ CheckSumDataComment() [2/2]

template<typename ObjectType , typename ChecksumType >

static const char * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::CheckSumDataComment ( )

staticinherited

Comment to be used in comment field of FrSE.

◆ Create() [1/6]

template<typename ObjectType , typename ChecksumType >

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.

◆ Create() [2/6]

template<typename ObjectType , typename ChecksumType >

virtual Object * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( ) const

inlineprivatevirtualinherited

Reimplemented in FrameCPP::Version_8::FrTOC, and FrameCPP::Version_8::FrTOC.

◆ Create() [3/6]

template<typename ObjectType , typename ChecksumType >

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [4/6]

template<typename ObjectType , typename ChecksumType >

virtual self_type * FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Create ( istream_type & Stream ) const

virtualinherited

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

Returns: Return pointer to the newly allocated resource.

◆ Create() [5/6]

template<typename ObjectType , typename ChecksumType >

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

inlineprivatevirtualinherited

constructor - virtual

◆ Create() [6/6]

template<typename ObjectType , typename ChecksumType >

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

inlineprivatevirtualinherited

constructor - virtual

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

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

Returns: An object of the previous generation.

◆ 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

◆ 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] RHS The 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] RHS The 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.

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

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrHistory::operator== ( const Common::FrameSpec::Object & RHS ) const

virtual

equality operator for abstract data type

Parameters

[in] RHS The object to be compared.

Returns: The value true is returned if this object is equivelent to the RHS instance; false otherwise.

◆ 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] RHS The 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 FrHistory & RHS ) const

inline

equality operator

Parameters

[in] RHS The 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] RHS The 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] Stream The 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, ChecksumType >.

◆ 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] Stream The 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, ChecksumType >.

◆ pCreate() [1/2]

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

protectedvirtual

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

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

◆ pCreate() [2/2]

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

protectedvirtual

Virtual constructor.

Parameters

[in] Stream The input stream from where the object is being read.

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

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

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

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

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

Returns: An object promoted to the next generation.

◆ pWrite() [1/2]

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

protectedvirtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

◆ pWrite() [2/2]

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

protectedvirtual

Write the structure to the stream.

Parameters

[in] Stream The output stream where the object is to be written.

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

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

◆ Write() [1/2]

template<typename ObjectType , typename ChecksumType >

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

◆ Write() [2/2]

template<typename ObjectType , typename ChecksumType >

virtual void FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::Write ( ostream_type & Stream ) const

virtualinherited

Write object to the stream.

Member Data Documentation

◆ m_chkSum

template<typename ObjectType , typename ChecksumType >

ChecksumType FrameCPP::Common::FrameSpec::ObjectWithChecksum< ObjectType, ChecksumType >::m_chkSum

privateinherited

Structure checksum.

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

◆ m_data

fr_history_data_type FrameCPP::Version_8::FrHistory::m_data

private

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

/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-2.7.0/include/framecpp/Version8/FrHistory.hh
Version8/FrHistory.hh
Version8/FrHistory.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ comment_type [1/2]

◆ comment_type [2/2]

◆ istream_type [1/2]

◆ istream_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

◆ object_type [2/2]

◆ ostream_type [1/2]

◆ ostream_type [2/2]

◆ self_type [1/2]

◆ self_type [2/2]

◆ time_type [1/2]

◆ time_type [2/2]

Constructor & Destructor Documentation

◆ FrHistory() [1/10]

◆ FrHistory() [2/10]

◆ FrHistory() [3/10]

◆ FrHistory() [4/10]

◆ FrHistory() [5/10]

◆ FrHistory() [6/10]

◆ FrHistory() [7/10]

◆ FrHistory() [8/10]

◆ FrHistory() [9/10]

◆ FrHistory() [10/10]

Member Function Documentation

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ CheckSumDataClass() [1/2]

◆ CheckSumDataClass() [2/2]

◆ CheckSumDataComment() [1/2]

◆ CheckSumDataComment() [2/2]

◆ Create() [1/6]

◆ Create() [2/6]

◆ Create() [3/6]

◆ Create() [4/6]

◆ Create() [5/6]

◆ Create() [6/6]

◆ demote() [1/2]

◆ demote() [2/2]

◆ ErrorInfo() [1/2]

◆ ErrorInfo() [2/2]

◆ GetComment() [1/2]

◆ GetComment() [2/2]

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetTime() [1/2]

◆ GetTime() [2/2]

◆ Merge() [1/2]

◆ Merge() [2/2]

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ operator==() [1/4]

◆ operator==() [2/4]

◆ operator==() [3/4]

◆ operator==() [4/4]

◆ pBytes() [1/2]

◆ pBytes() [2/2]

◆ pCreate() [1/2]

◆ pCreate() [2/2]

◆ Promote() [1/2]

◆ Promote() [2/2]

◆ promote() [1/2]

◆ promote() [2/2]

◆ pWrite() [1/2]

◆ pWrite() [2/2]

◆ StructDescription() [1/2]

◆ StructDescription() [2/2]