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::FrProcData Class Reference

Post-Processed Data Structure Definition. More...

#include <FrProcData.hh>

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

Public Types

typedef boost::shared_ptr< FrProcData > subset_ret_type
 
typedef boost::shared_ptr< FrProcData > subset_ret_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

 FrProcData ()
 Default constructor.
 
 FrProcData (const FrProcData &Source)
 Copy Constructor.
 
 FrProcData (const std::string &Name, const std::string &Comment, type_type Type, subType_type SubType, timeOffset_type TimeOffset, tRange_type TRange, fShift_type FShift, phase_type Phase, fRange_type FRange, BW_type BW)
 Constructor.
 
 FrProcData (Previous::FrProcData &Source, istream_type *Stream)
 Promotion Constructor.
 
 ~FrProcData ()
 Destructor.
 
bool operator== (const FrProcData &RHS) const
 equality operator
 
bool operator!= (const FrProcData &RHS) const
 inequality operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
fRange_type GetFRange () const
 Retrieve the frequency range.
 
tRange_type GetTRange () const
 Retrieve the time range.
 
const std::string & GetNameSlow () const
 Return the name associate with the FrProcData structure.
 
FrProcData & Merge (const FrProcData &RHS)
 Merge with another FrProcData.
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
 FrProcData ()
 Default constructor.
 
 FrProcData (const FrProcData &Source)
 Copy Constructor.
 
 FrProcData (const std::string &Name, const std::string &Comment, type_type Type, subType_type SubType, timeOffset_type TimeOffset, tRange_type TRange, fShift_type FShift, phase_type Phase, fRange_type FRange, BW_type BW)
 Constructor.
 
 FrProcData (Previous::FrProcData &Source, istream_type *Stream)
 Promotion Constructor.
 
 ~FrProcData ()
 Destructor.
 
bool operator== (const FrProcData &RHS) const
 equality operator
 
bool operator!= (const FrProcData &RHS) const
 inequality operator
 
virtual bool operator== (const Common::FrameSpec::Object &Obj) const
 equality operator for abstract data type
 
fRange_type GetFRange () const
 Retrieve the frequency range.
 
tRange_type GetTRange () const
 Retrieve the time range.
 
const std::string & GetNameSlow () const
 Return the name associate with the FrProcData structure.
 
FrProcData & Merge (const FrProcData &RHS)
 Merge with another FrProcData.
 
subset_ret_type Subset (REAL_8 Offset, REAL_8 Dt) const
 Request a subset of the data.
 
virtual const char * ObjectStructName () const
 The name structure name of this object.
 
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.
 
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, 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 const std::string & IDTypeToString (type_type Type)
 Convert numeric types to string representation.
 
static const std::string & IDSubTypeToString (type_type Type, subType_type SubType)
 Convert numeric sub-types to string representation.
 
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 const std::string & IDTypeToString (type_type Type)
 Convert numeric types to string representation.
 
static const std::string & IDSubTypeToString (type_type Type, subType_type SubType)
 Convert numeric sub-types to string representation.
 
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, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrProcData * pCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Virtual constructor.
 
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, istream_type *Stream) const
 Down grade an object.
 
virtual promote_ret_type promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
 Upgrade an object.
 
cmn_streamsize_type pBytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
 
virtual FrProcData * pCreate (istream_type &Stream) const
 Virtual constructor.
 
virtual void pWrite (ostream_type &Stream) const
 Virtual constructor.
 
virtual void vTOCQuery (int InfoClass, va_list vl) const
 Answer requests for information as needed by TOC.
 

Private Types

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

 FrProcData (istream_type &Stream)
 Stream Constructor.
 
void copy_core (const FrProcData &Source)
 Copy core data.
 
subset_ret_type sub_time_series (REAL_8 Offset, REAL_8 Dt) const
 Retrieve a time series subset.
 
void sync_with_vector ()
 Syncronize the FrProcData with the FrVect data.
 
 FrProcData (istream_type &Stream)
 Stream Constructor.
 
void copy_core (const FrProcData &Source)
 Copy core data.
 
subset_ret_type sub_time_series (REAL_8 Offset, REAL_8 Dt) const
 Retrieve a time series subset.
 
void sync_with_vector ()
 Syncronize the FrProcData with the FrVect data.
 
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

bool m_synced_with_vector
 
ChecksumType m_chkSum
 Structure checksum.
 

Detailed Description

Post-Processed Data Structure Definition.

Member Typedef Documentation

◆ 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

◆ 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::FrProcData::object_type
private

Object with checksum data.

◆ object_type [2/2]

typedef ObjectWithChecksum< Common::FrameSpec::Object > FrameCPP::Version_8::FrProcData::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

◆ 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

◆ subset_ret_type [1/2]

typedef boost::shared_ptr< FrProcData > FrameCPP::Version_8::FrProcData::subset_ret_type

◆ subset_ret_type [2/2]

typedef boost::shared_ptr< FrProcData > FrameCPP::Version_8::FrProcData::subset_ret_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

◆ FrProcData() [1/10]

FrameCPP::Version_8::FrProcData::FrProcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [2/10]

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

Copy Constructor.

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

◆ FrProcData() [3/10]

FrameCPP::Version_8::FrProcData::FrProcData ( const std::string & Name,
const std::string & Comment,
type_type Type,
subType_type SubType,
timeOffset_type TimeOffset,
tRange_type TRange,
fShift_type FShift,
phase_type Phase,
fRange_type FRange,
BW_type BW )

Constructor.

Parameters
[in]NameData or channel name
[in]CommentComment
[in]TypeType of data object.
[in]SubTypeSubtype of f-Series.
[in]TimeOffsetOfset of 1st sample relative to the frame start time.
[in]TRangeDuration of sampled data.
[in]FShiftThe frequency in the original data that corresponds to zero Hz in the heterodyned series.
[in]PhasePhase of heterodyning signal at start of dataset.
[in]FRangeFrequency range.
[in]BWResolution bandwidth.
Returns
A new instance of this object.

◆ FrProcData() [4/10]

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

Promotion Constructor.

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

◆ ~FrProcData() [1/2]

FrameCPP::Version_8::FrProcData::~FrProcData ( )

Destructor.

◆ FrProcData() [5/10]

FrameCPP::Version_8::FrProcData::FrProcData ( istream_type & Stream)
private

Stream Constructor.

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

◆ FrProcData() [6/10]

FrameCPP::Version_8::FrProcData::FrProcData ( )

Default constructor.

Returns
A new instance of this object.

◆ FrProcData() [7/10]

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

Copy Constructor.

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

◆ FrProcData() [8/10]

FrameCPP::Version_8::FrProcData::FrProcData ( const std::string & Name,
const std::string & Comment,
type_type Type,
subType_type SubType,
timeOffset_type TimeOffset,
tRange_type TRange,
fShift_type FShift,
phase_type Phase,
fRange_type FRange,
BW_type BW )

Constructor.

Parameters
[in]NameData or channel name
[in]CommentComment
[in]TypeType of data object.
[in]SubTypeSubtype of f-Series.
[in]TimeOffsetOfset of 1st sample relative to the frame start time.
[in]TRangeDuration of sampled data.
[in]FShiftThe frequency in the original data that corresponds to zero Hz in the heterodyned series.
[in]PhasePhase of heterodyning signal at start of dataset.
[in]FRangeFrequency range.
[in]BWResolution bandwidth.
Returns
A new instance of this object.

◆ FrProcData() [9/10]

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

Promotion Constructor.

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

◆ ~FrProcData() [2/2]

FrameCPP::Version_8::FrProcData::~FrProcData ( )

Destructor.

◆ FrProcData() [10/10]

FrameCPP::Version_8::FrProcData::FrProcData ( istream_type & Stream)
private

Stream Constructor.

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

Member Function Documentation

◆ Bytes() [1/2]

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.

◆ copy_core() [1/2]

void FrameCPP::Version_8::FrProcData::copy_core ( const FrProcData & Source)
private

Copy core data.

Parameters
[in]SourceThe source from which to copy the data

◆ copy_core() [2/2]

void FrameCPP::Version_8::FrProcData::copy_core ( const FrProcData & Source)
private

Copy core data.

Parameters
[in]SourceThe source from which to copy the data

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

FrProcData::demote_ret_type FrameCPP::Version_8::FrProcData::demote ( INT_2U Target,
demote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

Down grade an object.

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.
Todo
See if the actual sample rate can be computed

◆ demote() [2/2]

virtual demote_ret_type FrameCPP::Version_8::FrProcData::demote ( INT_2U Target,
demote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

Down grade an object.

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.

◆ GetFRange() [1/2]

REAL_8 FrameCPP::Version_8::FrProcData::GetFRange ( ) const
inline

Retrieve the frequency range.

Returns
The frequency range.

◆ GetFRange() [2/2]

fRange_type FrameCPP::Version_8::FrProcData::GetFRange ( ) const

Retrieve the frequency range.

Returns
The frequency range.

◆ GetNameSlow() [1/2]

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

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNameSlow() [2/2]

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

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetTRange() [1/2]

FrProcData::tRange_type FrameCPP::Version_8::FrProcData::GetTRange ( ) const
inline

Retrieve the time range.

Returns
The time range.

◆ GetTRange() [2/2]

tRange_type FrameCPP::Version_8::FrProcData::GetTRange ( ) const

Retrieve the time range.

Returns
The time range.

◆ IDSubTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcData::IDSubTypeToString ( type_type Type,
subType_type SubType )
static

Convert numeric sub-types to string representation.

Parameters
[in]TypeNumeric type.
[in]SubTypeNumeric sub-type.
Returns
The string representation of SubType of Type.

◆ IDSubTypeToString() [2/2]

static const std::string & FrameCPP::Version_8::FrProcData::IDSubTypeToString ( type_type Type,
subType_type SubType )
static

Convert numeric sub-types to string representation.

Parameters
[in]TypeNumeric type.
[in]SubTypeNumeric sub-type.
Returns
The string representation of SubType of Type.

◆ IDTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcData::IDTypeToString ( type_type Type)
static

Convert numeric types to string representation.

Parameters
[in]TypeNumeric type.
Returns
The string representation of Type.

◆ IDTypeToString() [2/2]

static const std::string & FrameCPP::Version_8::FrProcData::IDTypeToString ( type_type Type)
static

Convert numeric types to string representation.

Parameters
[in]TypeNumeric type.
Returns
The string representation of Type.

◆ Merge() [1/2]

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

Merge with another FrProcData.

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

◆ Merge() [2/2]

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

Merge with another FrProcData.

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

◆ ObjectStructName() [1/2]

const char * FrameCPP::Version_8::FrProcData::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::FrProcData::ObjectStructName ( ) const
virtual

The name structure name of this object.

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

◆ operator!=() [1/2]

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

inequality operator

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

◆ operator!=() [2/2]

bool FrameCPP::Version_8::FrProcData::operator!= ( const FrProcData & RHS) const

inequality operator

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

◆ operator==() [1/4]

bool FrameCPP::Version_8::FrProcData::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

equality operator for abstract data type

Parameters
[in]ObjThe 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::FrProcData::operator== ( const Common::FrameSpec::Object & Obj) const
virtual

equality operator for abstract data type

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

equality operator

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

equality operator

Parameters
[in]RHSThe FrProcData 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::FrProcData::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::FrProcData::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]

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

Virtual constructor.

Parameters
[in]StreamThe stream from which the earliest version of the FrProcData structure was read.
Returns
A new instance of this object.

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

◆ pCreate() [2/2]

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

Virtual constructor.

Parameters
[in]StreamThe stream from which the earliest version of the FrProcData structure was read.
Returns
A new instance of this object.

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

◆ Promote() [1/2]

FrProcData::promote_ret_type FrameCPP::Version_8::FrProcData::Promote ( INT_2U Source,
promote_arg_type Obj,
istream_type * 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::FrProcData::Promote ( INT_2U Source,
promote_arg_type Obj,
istream_type * Stream )
static

Promote previous version of object to this version.

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

◆ promote() [1/2]

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

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ promote() [2/2]

virtual promote_ret_type FrameCPP::Version_8::FrProcData::promote ( INT_2U Target,
promote_arg_type Obj,
istream_type * Stream ) const
protectedvirtual

Upgrade an object.

Parameters
[in]TargetThe version of the frame specification to promote too.
[in]ObjThe object to be promoted.
[in]StreamThe input stream from which the original object was read.
Returns
An object of this class.

◆ pWrite() [1/2]

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

Virtual constructor.

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

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

◆ pWrite() [2/2]

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

Virtual constructor.

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

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

◆ StructDescription() [1/2]

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

The name structure name of this object.

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

◆ sub_time_series() [1/2]

FrProcData::subset_ret_type FrameCPP::Version_8::FrProcData::sub_time_series ( REAL_8 Offset,
REAL_8 Dt ) const
private

Retrieve a time series subset.

Parameters
[in]OffsetThe number of seconds from the start of the FrAdcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrAdcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.
Todo
Ensure the dimension of the FrVect is 1
Todo
Ensure the requested range is valid
Todo
Get the slice of FrVect

◆ sub_time_series() [2/2]

subset_ret_type FrameCPP::Version_8::FrProcData::sub_time_series ( REAL_8 Offset,
REAL_8 Dt ) const
private

Retrieve a time series subset.

Parameters
[in]OffsetThe number of seconds from the start of the FrAdcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrAdcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.

◆ Subset() [1/2]

FrProcData::subset_ret_type FrameCPP::Version_8::FrProcData::Subset ( REAL_8 Offset,
REAL_8 Dt ) const

Request a subset of the data.

Parameters
[in]OffsetThe number of seconds from the start of the FrProcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrProcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.

◆ Subset() [2/2]

subset_ret_type FrameCPP::Version_8::FrProcData::Subset ( REAL_8 Offset,
REAL_8 Dt ) const

Request a subset of the data.

Parameters
[in]OffsetThe number of seconds from the start of the FrProcData object from which to start extracting data.
[in]DtThe number of seconds of data in the resulting FrProcData strucutre.
Returns
A FrProcData structure which contains Dt seconds of data starting at Offset of this FrProcData structure.

◆ sync_with_vector() [1/2]

void FrameCPP::Version_8::FrProcData::sync_with_vector ( )
private

Syncronize the FrProcData with the FrVect data.

◆ sync_with_vector() [2/2]

void FrameCPP::Version_8::FrProcData::sync_with_vector ( )
private

Syncronize the FrProcData with the FrVect data.

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

void FrameCPP::Version_8::FrProcData::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::FrProcData::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.

◆ m_synced_with_vector

bool FrameCPP::Version_8::FrProcData::m_synced_with_vector
private

True if FrProcData has been syncronized with its associated FrVect data structure.

The documentation for this class was generated from the following files:
Generated by doxygen 1.10.0