ldas-tools-framecpp 2.8.1
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_8::FrStatData Class Reference

Static Data Structure Definition. More...

#include <FrStatData.hh>

Inherits FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >, FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >, and FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >.

Public Member Functions

 FrStatData ()=default
 Default constructor. More...
 
 FrStatData (const FrStatData &Source)
 Copy Constructor. More...
 
 FrStatData (const name_type &Name, const comment_type &Comment, const representation_type &Representation, timeStart_type TimeStart, timeEnd_type TimeEnd, version_type Version)
 Constructor. More...
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData. More...
 
bool operator== (const FrStatData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
 FrStatData ()=default
 Default constructor. More...
 
 FrStatData (const FrStatData &Source)
 Copy Constructor. More...
 
 FrStatData (const name_type &Name, const comment_type &Comment, const representation_type &Representation, timeStart_type TimeStart, timeEnd_type TimeEnd, version_type Version)
 Constructor. More...
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData. More...
 
bool operator== (const FrStatData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
 FrStatData ()=default
 Default constructor. More...
 
 FrStatData (const FrStatData &Source)
 Copy Constructor. More...
 
 FrStatData (const name_type &Name, const comment_type &Comment, const representation_type &Representation, timeStart_type TimeStart, timeEnd_type TimeEnd, version_type Version)
 Constructor. More...
 
 FrStatData (const Previous::FrStatData &Source, istream_type *Stream)
 Promotion Constructor. More...
 
FrStatDataMerge (const FrStatData &RHS)
 Merge with another FrAdcData. More...
 
bool operator== (const FrStatData &RHS) const
 equality operator More...
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type More...
 
virtual Common::FrStatData::fr_detector_type GetDetector () const
 Retrieve the detector associated with the object. More...
 
virtual Common::FrStatData::fr_detector_type GetDetector () const
 Retrieve the detector associated with the object. More...
 
virtual Common::FrStatData::fr_detector_type GetDetector () const
 Retrieve the detector associated with the object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
virtual const char * ObjectStructName () const
 The name structure name of this object. More...
 
const std::string & GetName () const
 Retrieve static data name. More...
 
const std::string & GetName () const
 Retrieve static data name. More...
 
const std::string & GetName () const
 Retrieve static data name. More...
 
const std::string & GetComment () const
 Retrieve the comment. More...
 
const std::string & GetComment () const
 Retrieve the comment. More...
 
const std::string & GetComment () const
 Retrieve the comment. More...
 
const std::string & GetRepresentation () const
 Retrieve the type of static data. More...
 
const std::string & GetRepresentation () const
 Retrieve the type of static data. More...
 
const std::string & GetRepresentation () const
 Retrieve the type of static data. More...
 
timeStart_type GetTimeStart () const
 Retrieve the start time. More...
 
timeStart_type GetTimeStart () const
 Retrieve the start time. More...
 
timeStart_type GetTimeStart () const
 Retrieve the start time. More...
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time. More...
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time. More...
 
timeEnd_type GetTimeEnd () const
 Retrieve the end time. More...
 
version_type GetVersion () const
 Retrieve the version number. More...
 
version_type GetVersion () const
 Retrieve the version number. More...
 
version_type GetVersion () const
 Retrieve the version number. 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 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 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.
 
virtual void Write (ostream_type &Stream) const
 Write object to the stream.
 

Static Public Member Functions

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 promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
 Promote previous version of object to this version. 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 Common::Description * StructDescription ()
 The description of structure. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static const Common::Description * StructDescription ()
 The description of structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * CheckSumDataClass ()
 Data class to be used in class field of FrSE.
 
static const char * 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.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 

Protected Member Functions

virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. More...
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC. 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 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 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 Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Promotes object to another version of the frame spec. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (istream_type &Stream) const
 Virtual constructor. More...
 
virtual self_typepCreate (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
 Write the structure to the stream. More...
 
virtual void pWrite (ostream_type &Stream) const
 Write the structure to the stream. More...
 

Protected Attributes

name_type name
 Static data name.
 
comment_type comment
 Comment for static data.
 
representation_type representation
 
timeStart_type timeStart
 
timeEnd_type timeEnd
 
version_type version
 

Detailed Description

Static Data Structure Definition.

Constructor & Destructor Documentation

◆ FrStatData() [1/12]

FrameCPP::Version_8::FrStatData::FrStatData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [2/12]

FrameCPP::Version_8::FrStatData::FrStatData ( const FrStatData Source)

Copy Constructor.

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

◆ FrStatData() [3/12]

FrameCPP::Version_8::FrStatData::FrStatData ( const name_type &  Name,
const comment_type &  Comment,
const representation_type &  Representation,
timeStart_type  TimeStart,
timeEnd_type  TimeEnd,
version_type  Version 
)

Constructor.

Parameters
[in]nameStatic data name
[in]commentComemnt
[in]representationType of static data being represented
[in]timeStartStart time of static data validity.
[in]timeEndEnd time of static data validity.
[in]versionVersion number of this static structure.
Returns
A new instance of the object.

◆ FrStatData() [4/12]

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

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData 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 the object.

◆ FrStatData() [5/12]

FrameCPP::Version_8::FrStatData::FrStatData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [6/12]

FrameCPP::Version_8::FrStatData::FrStatData ( const FrStatData Source)

Copy Constructor.

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

◆ FrStatData() [7/12]

FrameCPP::Version_8::FrStatData::FrStatData ( const name_type &  Name,
const comment_type &  Comment,
const representation_type &  Representation,
timeStart_type  TimeStart,
timeEnd_type  TimeEnd,
version_type  Version 
)

Constructor.

Parameters
[in]nameStatic data name
[in]commentComemnt
[in]representationType of static data being represented
[in]timeStartStart time of static data validity.
[in]timeEndEnd time of static data validity.
[in]versionVersion number of this static structure.
Returns
A new instance of the object.

◆ FrStatData() [8/12]

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

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData 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 the object.

◆ FrStatData() [9/12]

FrameCPP::Version_8::FrStatData::FrStatData ( )
default

Default constructor.

Returns
A new instance of this object.

◆ FrStatData() [10/12]

FrameCPP::Version_8::FrStatData::FrStatData ( const FrStatData Source)

Copy Constructor.

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

◆ FrStatData() [11/12]

FrameCPP::Version_8::FrStatData::FrStatData ( const name_type &  Name,
const comment_type &  Comment,
const representation_type &  Representation,
timeStart_type  TimeStart,
timeEnd_type  TimeEnd,
version_type  Version 
)

Constructor.

Parameters
[in]nameStatic data name
[in]commentComemnt
[in]representationType of static data being represented
[in]timeStartStart time of static data validity.
[in]timeEndEnd time of static data validity.
[in]versionVersion number of this static structure.
Returns
A new instance of the object.

◆ FrStatData() [12/12]

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

Promotion Constructor.

Parameters
[in]SourceAn FrAdcData 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 the object.

Member Function Documentation

◆ Bytes() [1/3]

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

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

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

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

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

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

template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
inlineprotectedvirtualinherited

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

template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
inlineprotectedvirtualinherited

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

template<typename T >
virtual demote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::demote ( INT_2U  Target,
demote_arg_type  Obj,
istream_type *  Stream 
) const
inlineprotectedvirtualinherited

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

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetComment() [2/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetComment() [3/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetComment ( ) const
inlineinherited

Retrieve the comment.

Returns
The comment

◆ GetDetector() [1/3]

template<typename T >
virtual Common::FrStatData::fr_detector_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::GetDetector ( ) const
inlinevirtualinherited

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetDetector() [2/3]

template<typename T >
virtual Common::FrStatData::fr_detector_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::GetDetector ( ) const
inlinevirtualinherited

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetDetector() [3/3]

template<typename T >
virtual Common::FrStatData::fr_detector_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::GetDetector ( ) const
inlinevirtualinherited

Retrieve the detector associated with the object.

Returns
The detector associated with the object.

◆ GetName() [1/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetName() [2/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetName() [3/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetName ( ) const
inlineinherited

Retrieve static data name.

Returns
The static data name

◆ GetRepresentation() [1/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetRepresentation() [2/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetRepresentation() [3/3]

const std::string & FrameCPP::Version_8::FrStatDataImpl::Data::GetRepresentation ( ) const
inlineinherited

Retrieve the type of static data.

Returns
The type of static data being represente

◆ GetTimeEnd() [1/3]

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeEnd() [2/3]

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeEnd() [3/3]

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeEnd ( ) const
inlineinherited

Retrieve the end time.

Returns
The end time of the static data validity.

◆ GetTimeStart() [1/3]

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetTimeStart() [2/3]

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetTimeStart() [3/3]

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::GetTimeStart ( ) const
inlineinherited

Retrieve the start time.

Returns
The start time of the static data validity.

◆ GetVersion() [1/3]

version_type FrameCPP::Version_8::FrStatDataImpl::Data::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ GetVersion() [2/3]

version_type FrameCPP::Version_8::FrStatDataImpl::Data::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ GetVersion() [3/3]

version_type FrameCPP::Version_8::FrStatDataImpl::Data::GetVersion ( ) const
inlineinherited

Retrieve the version number.

Returns
The version number for this static structure.

◆ Merge() [1/3]

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

Merge with another FrAdcData.

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

◆ Merge() [2/3]

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

Merge with another FrAdcData.

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

◆ Merge() [3/3]

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

Merge with another FrAdcData.

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

◆ ObjectStructName() [1/3]

template<typename T >
virtual const char * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [2/3]

template<typename T >
virtual const char * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ ObjectStructName() [3/3]

template<typename T >
virtual const char * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::ObjectStructName ( ) const
inlinevirtualinherited

The name structure name of this object.

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

◆ operator==() [1/6]

virtual bool FrameCPP::Version_8::FrStatData::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==() [2/6]

virtual bool FrameCPP::Version_8::FrStatData::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==() [3/6]

virtual bool FrameCPP::Version_8::FrStatData::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/6]

bool FrameCPP::Version_8::FrStatData::operator== ( const FrStatData RHS) const
inline

equality operator

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

◆ operator==() [5/6]

bool FrameCPP::Version_8::FrStatData::operator== ( const FrStatData RHS) const
inline

equality operator

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

◆ operator==() [6/6]

bool FrameCPP::Version_8::FrStatData::operator== ( const FrStatData RHS) const
inline

equality operator

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

◆ pBytes() [1/3]

template<typename T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase &  Stream) const
inlineprotectedvirtualinherited

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.

◆ pBytes() [2/3]

template<typename T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase &  Stream) const
inlineprotectedvirtualinherited

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.

◆ pBytes() [3/3]

template<typename T >
virtual cmn_streamsize_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pBytes ( const Common::StreamBase &  Stream) const
inlineprotectedvirtualinherited

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.

◆ pCreate() [1/3]

template<typename T >
virtual self_type * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pCreate ( istream_type &  Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ pCreate() [2/3]

template<typename T >
virtual self_type * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pCreate ( istream_type &  Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ pCreate() [3/3]

template<typename T >
virtual self_type * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pCreate ( istream_type &  Stream) const
inlineprotectedvirtualinherited

Virtual constructor.

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

◆ Promote() [1/3]

template<typename T >
static promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
inlinestaticinherited

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

template<typename T >
static promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
inlinestaticinherited

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

template<typename T >
static promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::Promote ( INT_2U  Source,
promote_arg_type  Obj,
istream_type *  Stream 
)
inlinestaticinherited

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

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe 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/3]

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

Parameters
[in]TargetThe 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() [3/3]

template<typename T >
virtual promote_ret_type FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::promote ( INT_2U  Target,
promote_arg_type  Obj,
istream_type *  Stream 
) const
inlineprotectedvirtualinherited

Promotes object to another version of the frame spec.

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

template<typename T >
virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pWrite ( ostream_type &  Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ pWrite() [2/3]

template<typename T >
virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pWrite ( ostream_type &  Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ pWrite() [3/3]

template<typename T >
virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::pWrite ( ostream_type &  Stream) const
inlineprotectedvirtualinherited

Write the structure to the stream.

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

◆ StructDescription() [1/3]

template<typename T >
static const Common::Description * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [2/3]

template<typename T >
static const Common::Description * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ StructDescription() [3/3]

template<typename T >
static const Common::Description * FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::StructDescription ( )
inlinestaticinherited

The description of structure.

Returns
A Description object which describes this structure as specified by the frame specification.

◆ vTOCQuery() [1/3]

template<typename T >
virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

◆ vTOCQuery() [2/3]

template<typename T >
virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

◆ vTOCQuery() [3/3]

template<typename T >
virtual void FrameCPP::Version_8::FrStatDataImpl::ClassicIO< T >::vTOCQuery ( int  InfoClass,
va_list  vl 
) const
inlineprotectedvirtualinherited

Answer requests for information as needed by TOC.

Parameters
[in]InfoClassClass of information being requested.
[in]vlVariable argument list of requested data.

Member Data Documentation

◆ representation

representation_type FrameCPP::Version_8::FrStatDataImpl::Data::representation
protectedinherited

Type of static data being represented. e,g., calibration, swept sine, pole-zero, FIR or IIR coefficients...

◆ timeEnd

timeEnd_type FrameCPP::Version_8::FrStatDataImpl::Data::timeEnd
protectedinherited

End time of static data validity. A value of zero represents the end time being unknown. GPS time in integer seconds since GPS standard epoch.

◆ timeStart

timeStart_type FrameCPP::Version_8::FrStatDataImpl::Data::timeStart
protectedinherited

Start time of static data validity. GPS time in integer seconds since GPS standard epoch.

◆ version

version_type FrameCPP::Version_8::FrStatDataImpl::Data::version
protectedinherited

Version number for this static structure. i.e., the counter begins at 0 and is incremented by 1 thereafter. Updated statics for the same time window (e.g., modified calibration data) will be identified by identified by unique version numbers.


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