ldas-tools-framecpp 2.7.0
Loading...
Searching...
No Matches
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::FrSimData Class Reference

Simulated Data Structure Definition. More...

#include <FrSimData.hh>

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

Public Types

typedef FR_SIM_DATA_NAME_TYPE name_type
 
typedef FR_SIM_DATA_COMMENT_TYPE comment_type
 
typedef FR_SIM_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_SIM_DATA_TIMEOFFSET_TYPE timeOffset_type
 
typedef FR_SIM_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_SIM_DATA_PHASE_TYPE phase_type
 
typedef FR_SIM_DATA_NAME_TYPE name_type
 
typedef FR_SIM_DATA_COMMENT_TYPE comment_type
 
typedef FR_SIM_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef FR_SIM_DATA_TIMEOFFSET_TYPE timeOffset_type
 
typedef FR_SIM_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_SIM_DATA_PHASE_TYPE phase_type
 
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
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
enum  {
  DT_CHAR_PTR , DT_STRING_2 , DT_INT_2S , DT_INT_2U ,
  DT_INT_4S , DT_INT_4U , DT_INT_8S , DT_INT_8U ,
  DT_REAL_4 , DT_REAL_8
}
 
enum  {
  IC_EOQ , IC_AMPLITUDE , IC_CHANNEL_ID , IC_DATA_QUALITY ,
  IC_DATA_VALID , IC_DETECTOR , IC_DETECTOR_PREFIX , IC_DT ,
  IC_END , IC_FRAME , IC_GROUP_ID , IC_GTIME_N ,
  IC_GTIME_S , IC_ID , IC_LOCAL_TIME , IC_NAME ,
  IC_RUN , IC_START , IC_ULEAP_S , IC_VERSION
}
 
typedef STRING< INT_2U > string_2_type
 
typedef STRING< INT_2U > string_2_type
 

Public Member Functions

 FrSimData ()
 Default constructor.
 
 FrSimData (const FrSimData &Source)
 Copy Constructor.
 
 FrSimData (const std::string &Name, const std::string &Comment, const REAL_8 SampleRate, const REAL_8 FShift, const REAL_4 Phase, const REAL_8 TimeOffset=DEFAULT_TIME_OFFSET)
 Constructor.
 
 FrSimData (Previous::FrSimData &Source, Common::IStream *Stream)
 Promotion Constructor.
 
void SetComment (const comment_type &Comment)
 Establish the value of the comment field.
 
void SetSampleRate (sampleRate_type SampleRate)
 Establish the value of the sampleRate field.
 
void SetTimeOffset (timeOffset_type time)
 Establish the value of the timeOffset field.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & GetNameSlow () const
 Return the name associate with the FrSimData structure.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
FrSimDataMerge (const FrSimData &RHS)
 Merge with another FrSimData.
 
bool operator== (const FrSimData &RHS) const
 equality operator
 
virtual bool operator== (const Common::FrameSpec::Object &RHS) const
 equality operator for abstract data type
 
 FrSimData ()
 Default constructor.
 
 FrSimData (const FrSimData &Source)
 Copy Constructor.
 
 FrSimData (const std::string &Name, const std::string &Comment, const REAL_8 SampleRate, const REAL_8 FShift, const REAL_4 Phase, const REAL_8 TimeOffset=DEFAULT_TIME_OFFSET)
 Constructor.
 
 FrSimData (Previous::FrSimData &Source, Common::IStream *Stream)
 Promotion Constructor.
 
void SetComment (const comment_type &Comment)
 Establish the value of the comment field.
 
void SetSampleRate (sampleRate_type SampleRate)
 Establish the value of the sampleRate field.
 
void SetTimeOffset (timeOffset_type time)
 Establish the value of the timeOffset field.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
const std::string & GetNameSlow () const
 Return the name associate with the FrSimData structure.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
FrSimDataMerge (const FrSimData &RHS)
 Merge with another FrSimData.
 
bool operator== (const FrSimData &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_typeCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual self_typeCreate (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.
 
void TOCQuery (int InfoClass,...) const
 
void TOCQuery (int InfoClass,...) const
 

Static Public Member Functions

static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of structure.
 
static promote_ret_type Promote (INT_2U Source, promote_arg_type Obj, Common::IStream *Stream)
 Promote previous version of object to this version.
 
static const char * StructName ()
 The name structure name of this object.
 
static const Common::DescriptionStructDescription ()
 The description of 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 * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
static const char * CheckSumDataComment ()
 Comment to be used in comment field of FrSE.
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 
template<class T >
static int DataType (const T *Data)
 
template<class T >
static int DataType (const T &Data)
 

Protected Member Functions

virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *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 FrSimDatapCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 
virtual demote_ret_type demote (INT_2U Target, demote_arg_type Obj, Common::IStream *Stream) const
 Demotes object to previous version of the frame spec.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, Common::IStream *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 FrSimDatapCreate (Common::IStream &Stream) const
 Virtual constructor.
 
virtual void pWrite (Common::OStream &Stream) const
 Write the structure to the stream.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 

Private Types

typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
typedef ObjectWithChecksum< Common::FrameSpec::Objectobject_type
 Object with checksum data.
 
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

 FrSimData (Common::IStream &Stream)
 Stream Constructor.
 
 FrSimData (Common::IStream &Stream)
 Stream Constructor.
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 
virtual ObjectCreate () const
 
virtual ObjectCreate (std::istream &Buffer) const
 constructor - virtual
 

Private Attributes

ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

Simulated Data Structure Definition.

Member Typedef Documentation

◆ comment_type [1/2]

typedef FR_SIM_DATA_COMMENT_TYPE FrameCPP::Version_8::FrSimData::comment_type

◆ comment_type [2/2]

typedef FR_SIM_DATA_COMMENT_TYPE FrameCPP::Version_8::FrSimData::comment_type

◆ fShift_type [1/2]

typedef FR_SIM_DATA_FSHIFT_TYPE FrameCPP::Version_8::FrSimData::fShift_type

◆ fShift_type [2/2]

typedef FR_SIM_DATA_FSHIFT_TYPE FrameCPP::Version_8::FrSimData::fShift_type

◆ 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 FR_SIM_DATA_NAME_TYPE FrameCPP::Version_8::FrSimData::name_type

◆ name_type [2/2]

typedef FR_SIM_DATA_NAME_TYPE FrameCPP::Version_8::FrSimData::name_type

◆ object_base_type [1/2]

◆ object_base_type [2/2]

◆ object_type [1/2]

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

Object with checksum data.

◆ object_type [2/2]

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

Object with checksum data.

◆ 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

◆ phase_type [1/2]

typedef FR_SIM_DATA_PHASE_TYPE FrameCPP::Version_8::FrSimData::phase_type

◆ phase_type [2/2]

typedef FR_SIM_DATA_PHASE_TYPE FrameCPP::Version_8::FrSimData::phase_type

◆ sampleRate_type [1/2]

typedef FR_SIM_DATA_SAMPLERATE_TYPE FrameCPP::Version_8::FrSimData::sampleRate_type

◆ sampleRate_type [2/2]

typedef FR_SIM_DATA_SAMPLERATE_TYPE FrameCPP::Version_8::FrSimData::sampleRate_type

◆ 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

◆ string_2_type [1/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ string_2_type [2/2]

typedef STRING< INT_2U > FrameCPP::Common::TOCInfo::string_2_type
inherited

◆ timeOffset_type [1/2]

typedef FR_SIM_DATA_TIMEOFFSET_TYPE FrameCPP::Version_8::FrSimData::timeOffset_type

◆ timeOffset_type [2/2]

typedef FR_SIM_DATA_TIMEOFFSET_TYPE FrameCPP::Version_8::FrSimData::timeOffset_type

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

◆ anonymous enum

anonymous enum
inherited
Enumerator
DT_CHAR_PTR 
DT_STRING_2 
DT_INT_2S 
DT_INT_2U 
DT_INT_4S 
DT_INT_4U 
DT_INT_8S 
DT_INT_8U 
DT_REAL_4 
DT_REAL_8 

◆ anonymous enum

anonymous enum
inherited
Enumerator
IC_EOQ 
IC_AMPLITUDE 
IC_CHANNEL_ID 
IC_DATA_QUALITY 
IC_DATA_VALID 
IC_DETECTOR 
IC_DETECTOR_PREFIX 
IC_DT 
IC_END 
IC_FRAME 
IC_GROUP_ID 
IC_GTIME_N 
IC_GTIME_S 
IC_ID 
IC_LOCAL_TIME 
IC_NAME 
IC_RUN 
IC_START 
IC_ULEAP_S 
IC_VERSION 

Constructor & Destructor Documentation

◆ FrSimData() [1/10]

FrSimData::FrSimData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrSimData() [2/10]

FrSimData::FrSimData ( const FrSimData & Source)

Copy Constructor.

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

◆ FrSimData() [3/10]

FrSimData::FrSimData ( const std::string & Name,
const std::string & Comment,
const REAL_8 SampleRate,
const REAL_8 FShift,
const REAL_4 Phase,
const REAL_8 TimeOffset = DEFAULT_TIME_OFFSET )

Constructor.

Parameters
[in]NameName of simulated data.
[in]CommentComment
[in]SampleRateSimulated data sample rate, samples per second.
[in]FShiftThe frequency in the original data that corresponds to 0 Hz in the heterodyned series.
[in]PhasePhase of heterodyning signal at start of dataset.
[in]TimeOffsetOffset of 1st sample relative to the frame start time.
Returns
A new instance of the object.

◆ FrSimData() [4/10]

FrSimData::FrSimData ( Previous::FrSimData & Source,
Common::IStream * Stream )

Promotion Constructor.

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

◆ FrSimData() [5/10]

FrSimData::FrSimData ( Common::IStream & Stream)
private

Stream Constructor.

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

◆ FrSimData() [6/10]

FrameCPP::Version_8::FrSimData::FrSimData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrSimData() [7/10]

FrameCPP::Version_8::FrSimData::FrSimData ( const FrSimData & Source)

Copy Constructor.

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

◆ FrSimData() [8/10]

FrameCPP::Version_8::FrSimData::FrSimData ( const std::string & Name,
const std::string & Comment,
const REAL_8 SampleRate,
const REAL_8 FShift,
const REAL_4 Phase,
const REAL_8 TimeOffset = DEFAULT_TIME_OFFSET )

Constructor.

Parameters
[in]NameName of simulated data.
[in]CommentComment
[in]SampleRateSimulated data sample rate, samples per second.
[in]FShiftThe frequency in the original data that corresponds to 0 Hz in the heterodyned series.
[in]PhasePhase of heterodyning signal at start of dataset.
[in]TimeOffsetOffset of 1st sample relative to the frame start time.
Returns
A new instance of the object.

◆ FrSimData() [9/10]

FrameCPP::Version_8::FrSimData::FrSimData ( Previous::FrSimData & Source,
Common::IStream * Stream )

Promotion Constructor.

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

◆ FrSimData() [10/10]

FrameCPP::Version_8::FrSimData::FrSimData ( Common::IStream & 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]

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]StreamStream characteristics used to determine the number of bytes needed to format the object for the Stream.
Returns
The number of bytes for this object

◆ Bytes() [2/2]

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

◆ 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

◆ Create() [2/6]

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

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

◆ DataType() [1/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [2/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T & Data)
staticinherited

◆ DataType() [3/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ DataType() [4/4]

template<class T >
static int FrameCPP::Common::TOCInfo::DataType ( const T * Data)
staticinherited

◆ demote() [1/2]

FrSimData::demote_ret_type FrSimData::demote ( INT_2U Target,
demote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

Demotes object to previous version of the frame spec.

Parameters
[in]TargetThe version of the frame specification to demote too.
[in]ObjThe version of the object to demote.
[in]StreamThe input stream from which the original object was read.
Returns
An object of the previous generation.

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrSimData::demote ( INT_2U Target,
demote_arg_type Obj,
Common::IStream * 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.

◆ GetNameSlow() [1/2]

const std::string & FrSimData::GetNameSlow ( ) const

Return the name associate with the FrSimData structure.

Returns
The name associated with the FrSimData structure

◆ GetNameSlow() [2/2]

const std::string & FrameCPP::Version_8::FrSimData::GetNameSlow ( ) const

Return the name associate with the FrSimData structure.

Returns
The name associated with the FrSimData structure

◆ GetSampleRate() [1/2]

FrSimData::sampleRate_type FrameCPP::Version_8::FrSimData::GetSampleRate ( ) const
inline

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/2]

sampleRate_type FrameCPP::Version_8::FrSimData::GetSampleRate ( ) const

The data acquisition rate.

Returns
The data acquisition rate.

◆ Merge() [1/2]

FrSimData & FrSimData::Merge ( const FrSimData & RHS)

Merge with another FrSimData.

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

◆ Merge() [2/2]

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

Merge with another FrSimData.

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

◆ ObjectStructName() [1/2]

const char * FrSimData::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::FrSimData::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 FrSimData::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/4]

virtual bool FrameCPP::Version_8::FrSimData::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/4]

bool FrameCPP::Version_8::FrSimData::operator== ( const FrSimData & RHS) const
inline

equality operator

Parameters
[in]RHSThe FrSimData 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::FrSimData::operator== ( const FrSimData & RHS) const

equality operator

Parameters
[in]RHSThe FrSimData 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 FrSimData::pBytes ( const Common::StreamBase & Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

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

◆ pBytes() [2/2]

cmn_streamsize_type FrameCPP::Version_8::FrSimData::pBytes ( const Common::StreamBase & Stream) const
protectedvirtual

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.

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

◆ pCreate() [1/2]

FrSimData * FrSimData::pCreate ( Common::IStream & Stream) const
protectedvirtual

Virtual constructor.

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

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

◆ pCreate() [2/2]

virtual FrSimData * FrameCPP::Version_8::FrSimData::pCreate ( Common::IStream & Stream) const
protectedvirtual

Virtual constructor.

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

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

◆ Promote() [1/2]

FrSimData::promote_ret_type FrameCPP::Version_8::FrSimData::Promote ( INT_2U Source,
promote_arg_type Obj,
Common::IStream * Stream )
inlinestatic

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::FrSimData::Promote ( INT_2U Source,
promote_arg_type Obj,
Common::IStream * 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]

FrSimData::promote_ret_type FrSimData::promote ( INT_2U Target,
promote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

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

virtual promote_ret_type FrameCPP::Version_8::FrSimData::promote ( INT_2U Target,
promote_arg_type Obj,
Common::IStream * Stream ) const
protectedvirtual

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

void FrSimData::pWrite ( Common::OStream & Stream) const
protectedvirtual

Write the structure to the stream.

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

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

◆ pWrite() [2/2]

virtual void FrameCPP::Version_8::FrSimData::pWrite ( Common::OStream & Stream) const
protectedvirtual

Write the structure to the stream.

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

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

◆ SetComment() [1/2]

void FrameCPP::Version_8::FrSimData::SetComment ( const comment_type & Comment)
inline

Establish the value of the comment field.

Parameters
[in]CommentThe desired value of the comment field.

◆ SetComment() [2/2]

void FrameCPP::Version_8::FrSimData::SetComment ( const comment_type & Comment)

Establish the value of the comment field.

Parameters
[in]CommentThe desired value of the comment field.

◆ SetSampleRate() [1/2]

void FrameCPP::Version_8::FrSimData::SetSampleRate ( sampleRate_type SampleRate)
inline

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSampleRate() [2/2]

void FrameCPP::Version_8::FrSimData::SetSampleRate ( sampleRate_type SampleRate)

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_8::FrSimData::SetTimeOffset ( timeOffset_type time)
inline

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_8::FrSimData::SetTimeOffset ( timeOffset_type time)

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ StructDescription() [1/2]

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

The name structure name of this object.

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

◆ TOCQuery() [1/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inlineinherited

◆ TOCQuery() [2/2]

void FrameCPP::Common::TOCInfo::TOCQuery ( int InfoClass,
... ) const
inherited

◆ vTOCQuery() [1/2]

virtual void FrameCPP::Version_8::FrSimData::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

◆ vTOCQuery() [2/2]

virtual void FrameCPP::Version_8::FrSimData::vTOCQuery ( int InfoClass,
va_list vl ) const
protectedvirtual

Answer requests for information as needed by TOC.

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

Implements FrameCPP::Common::TOCInfo.

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


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