ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_8::FrProcDataImpl::Data Class Reference

#include <FrProcDataData.hh>

Inheritance diagram for FrameCPP::Version_8::FrProcDataImpl::Data:
Collaboration diagram for FrameCPP::Version_8::FrProcDataImpl::Data:

Classes

struct  auxParamInfo
 

Public Types

enum  e_type_type {
  UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 ,
  TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 , UNKNOWN_TYPE = 0 ,
  TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 , TIME_FREQUENCY = 4 ,
  WAVELETS = 5 , MULTI_DIMENSIONAL = 6
}
 
enum  e_subType_type {
  UNKNOWN_SUB_TYPE = 0 , DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 ,
  CROSS_SPECTRAL_DENSITY = 4 , COHERENCE = 5 , TRANSFER_FUNCTION = 6 , UNKNOWN_SUB_TYPE = 0 ,
  DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 , CROSS_SPECTRAL_DENSITY = 4 ,
  COHERENCE = 5 , TRANSFER_FUNCTION = 6
}
 
enum  e_type_type {
  UNKNOWN_TYPE = 0 , TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 ,
  TIME_FREQUENCY = 4 , WAVELETS = 5 , MULTI_DIMENSIONAL = 6 , UNKNOWN_TYPE = 0 ,
  TIME_SERIES = 1 , FREQUENCY_SERIES = 2 , OTHER_1D_SERIES_DATA = 3 , TIME_FREQUENCY = 4 ,
  WAVELETS = 5 , MULTI_DIMENSIONAL = 6
}
 
enum  e_subType_type {
  UNKNOWN_SUB_TYPE = 0 , DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 ,
  CROSS_SPECTRAL_DENSITY = 4 , COHERENCE = 5 , TRANSFER_FUNCTION = 6 , UNKNOWN_SUB_TYPE = 0 ,
  DFT = 1 , AMPLITUDE_SPECTRAL_DENSITY = 2 , POWER_SPECTRAL_DENSITY = 3 , CROSS_SPECTRAL_DENSITY = 4 ,
  COHERENCE = 5 , TRANSFER_FUNCTION = 6
}
 
typedef struct FrameCPP::Version_8::FrProcDataImpl::Data::auxParamInfo auxParamInfo_type
 
typedef FR_PROC_DATA_NAME_TYPE name_type
 
typedef FR_PROC_DATA_COMMENT_TYPE comment_type
 
typedef FR_PROC_DATA_TYPE_TYPE type_type
 
typedef FR_PROC_DATA_SUB_TYPE_TYPE subType_type
 
typedef FR_PROC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_PROC_DATA_T_RANGE_TYPE tRange_type
 
typedef FR_PROC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_PROC_DATA_PHASE_TYPE phase_type
 
typedef FR_PROC_DATA_F_RANGE_TYPE fRange_type
 
typedef FR_PROC_DATA_BW_TYPE BW_type
 
typedef std::vector< auxParamInfo_typeauxParam_type
 
typedef Common::Container< FrVectdata_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< FrVectaux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 
typedef Common::Container< FrTabletable_type
 
typedef FrTable table_value_type
 
typedef table_type::const_iterator const_table_iterator
 
typedef table_type::iterator table_iterator
 
typedef Common::Container< FrHistoryhistory_type
 
typedef history_type::const_iterator const_history_iterator
 
typedef history_type::iterator history_iterator
 
typedef auxParam_type AuxParamList_type
 
typedef auxParam_type::value_type AuxParam_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 

Public Member Functions

 Data ()
 
void AppendComment (const std::string &Comment)
 
void AppendAuxParam (const auxParam_type::value_type &Param)
 
const name_typeGetName () const
 Return the name associate with the FrProcData structure.
 
const name_typeGetNameSlow () const
 
const comment_typeGetComment () const
 A brief description of the FrProcData structure.
 
type_type GetType () const
 
subType_type GetSubType () const
 
timeOffset_type GetTimeOffset () const
 
fShift_type GetFShift () const
 
phase_type GetPhase () const
 
BW_type GetBW () const
 
const auxParam_typeGetAuxParam () const
 
auxParam_typeGetAuxParam ()
 
fRange_type GetFRange () const
 Retrieve the frequency range.
 
tRange_type GetTRange () const
 Retrieve the time range.
 
void SetAuxParam (const auxParam_type &AuxParams)
 
void SetComment (const comment_type &Comment)
 
void SetFRange (fRange_type FRange)
 
void SetFShift (fShift_type FShift)
 
void SetTimeOffset (timeOffset_type TimeOffset)
 
void SetTRange (tRange_type TRange)
 
const aux_typeRefAux () const
 Identifier for vector for auxilliary data.
 
aux_typeRefAux ()
 Identifier for vector for auxilliary data.
 
const data_typeRefData () const
 Identifier for vector for data vector.
 
data_typeRefData ()
 Identifier for vector for data vector.
 
const table_typeRefTable () const
 Identifier for parameter table.
 
table_typeRefTable ()
 Identifier for parameter table.
 
const history_typeRefHistory () const
 Identifier for channel history.
 
history_typeRefHistory ()
 Identifier for channel history.
 
bool operator== (const Data &RHS) const
 equality operator
 
 Data ()
 
void AppendComment (const std::string &Comment)
 
void AppendAuxParam (const auxParam_type::value_type &Param)
 
const name_typeGetName () const
 Return the name associate with the FrProcData structure.
 
const name_typeGetNameSlow () const
 
const comment_typeGetComment () const
 A brief description of the FrProcData structure.
 
type_type GetType () const
 
subType_type GetSubType () const
 
timeOffset_type GetTimeOffset () const
 
fShift_type GetFShift () const
 
phase_type GetPhase () const
 
BW_type GetBW () const
 
const auxParam_typeGetAuxParam () const
 
auxParam_typeGetAuxParam ()
 
fRange_type GetFRange () const
 Retrieve the frequency range.
 
tRange_type GetTRange () const
 Retrieve the time range.
 
void SetAuxParam (const auxParam_type &AuxParams)
 
void SetComment (const comment_type &Comment)
 
void SetFRange (fRange_type FRange)
 
void SetFShift (fShift_type FShift)
 
void SetTimeOffset (timeOffset_type TimeOffset)
 
void SetTRange (tRange_type TRange)
 
const aux_typeRefAux () const
 Identifier for vector for auxilliary data.
 
aux_typeRefAux ()
 Identifier for vector for auxilliary data.
 
const data_typeRefData () const
 Identifier for vector for data vector.
 
data_typeRefData ()
 Identifier for vector for data vector.
 
const table_typeRefTable () const
 Identifier for parameter table.
 
table_typeRefTable ()
 Identifier for parameter table.
 
const history_typeRefHistory () const
 Identifier for channel history.
 
history_typeRefHistory ()
 Identifier for channel history.
 
bool operator== (const Data &RHS) const
 equality operator
 

Static Public Member Functions

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 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 struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
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 Public Attributes

static constexpr phase_type PHASE_UNKNOWN { 0 }
 
static constexpr fRange_type FRANGE_UNKNOWN { 0 }
 
static constexpr BW_type BW_UNKNOWN { 0 }
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Member Functions

void copy_core (const Data &Source)
 Copy core data.
 
void sync () const
 
void sync_with_vector ()
 
void copy_core (const Data &Source)
 Copy core data.
 
void sync () const
 
void sync_with_vector ()
 

Protected Attributes

name_type name
 Channel name – must be unique with the frame.
 
comment_type comment
 Comment.
 
type_type type
 Type of data object.
 
subType_type subType
 Subtype for f-Series (TBD for other types)
 
timeOffset_type timeOffset
 
tRange_type tRange
 Duration of sampled data (tStop-tStart)
 
fShift_type fShift
 
phase_type phase
 
fRange_type fRange
 Frequency range (=fMax-fMin, 0 if unknown)
 
BW_type BW
 Resolution bandwidth.
 
auxParam_type auxParam
 Auxiliary parameters.
 
data_type data
 
aux_type aux
 Auxiliary data; use is generic.
 
table_type table
 Parameter table.
 
history_type history
 Channel history.
 
bool synced_with_vector_
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 4 }
 

Member Typedef Documentation

◆ aux_iterator

◆ aux_type

◆ AuxParam_type

◆ auxParam_type

◆ auxParamInfo_type

◆ AuxParamList_type

◆ BW_type

◆ comment_type

◆ const_aux_iterator

◆ const_history_iterator

◆ const_iterator

◆ const_table_iterator

◆ data_type

◆ fRange_type

◆ fShift_type

◆ history_iterator

◆ history_type

◆ iterator

◆ name_type

◆ phase_type

◆ struct_desc_type

template<typename Object_T >
typedef const char *const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc_type
inherited

◆ struct_id_type

template<typename Object_T >
typedef INT_2U const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id_type
inherited

◆ struct_name_type

template<typename Object_T >
typedef const char *const FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name_type
inherited

◆ subType_type

◆ table_iterator

◆ table_type

◆ table_value_type

◆ timeOffset_type

◆ tRange_type

◆ type_type

Member Enumeration Documentation

◆ e_subType_type [1/2]

Enumerator
UNKNOWN_SUB_TYPE 
DFT 
AMPLITUDE_SPECTRAL_DENSITY 
POWER_SPECTRAL_DENSITY 
CROSS_SPECTRAL_DENSITY 
COHERENCE 
TRANSFER_FUNCTION 
UNKNOWN_SUB_TYPE 
DFT 
AMPLITUDE_SPECTRAL_DENSITY 
POWER_SPECTRAL_DENSITY 
CROSS_SPECTRAL_DENSITY 
COHERENCE 
TRANSFER_FUNCTION 

◆ e_subType_type [2/2]

Enumerator
UNKNOWN_SUB_TYPE 
DFT 
AMPLITUDE_SPECTRAL_DENSITY 
POWER_SPECTRAL_DENSITY 
CROSS_SPECTRAL_DENSITY 
COHERENCE 
TRANSFER_FUNCTION 
UNKNOWN_SUB_TYPE 
DFT 
AMPLITUDE_SPECTRAL_DENSITY 
POWER_SPECTRAL_DENSITY 
CROSS_SPECTRAL_DENSITY 
COHERENCE 
TRANSFER_FUNCTION 

◆ e_type_type [1/2]

Enumerator
UNKNOWN_TYPE 
TIME_SERIES 
FREQUENCY_SERIES 
OTHER_1D_SERIES_DATA 
TIME_FREQUENCY 
WAVELETS 
MULTI_DIMENSIONAL 
UNKNOWN_TYPE 
TIME_SERIES 
FREQUENCY_SERIES 
OTHER_1D_SERIES_DATA 
TIME_FREQUENCY 
WAVELETS 
MULTI_DIMENSIONAL 

◆ e_type_type [2/2]

Enumerator
UNKNOWN_TYPE 
TIME_SERIES 
FREQUENCY_SERIES 
OTHER_1D_SERIES_DATA 
TIME_FREQUENCY 
WAVELETS 
MULTI_DIMENSIONAL 
UNKNOWN_TYPE 
TIME_SERIES 
FREQUENCY_SERIES 
OTHER_1D_SERIES_DATA 
TIME_FREQUENCY 
WAVELETS 
MULTI_DIMENSIONAL 

Constructor & Destructor Documentation

◆ Data() [1/2]

FrameCPP::Version_8::FrProcDataImpl::Data::Data ( )
inline

◆ Data() [2/2]

FrameCPP::Version_8::FrProcDataImpl::Data::Data ( )
inline

Member Function Documentation

◆ AppendAuxParam() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendAuxParam ( const auxParam_type::value_type & Param)
inline

◆ AppendAuxParam() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendAuxParam ( const auxParam_type::value_type & Param)
inline

◆ AppendComment() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendComment ( const std::string & Comment)
inline

◆ AppendComment() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::AppendComment ( const std::string & Comment)
inline

◆ copy_core() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::copy_core ( const Data & Source)
inlineprotected

Copy core data.

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

◆ copy_core() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::copy_core ( const Data & Source)
inlineprotected

Copy core data.

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

◆ FrameSpecDescription() [1/2]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/2]

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecDescription ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [1/2]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecId() [2/2]

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecId ( )
inlinestaticinherited

Return the dictionary name of the structure.

◆ FrameSpecName() [1/2]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ FrameSpecName() [2/2]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::FrameSpecName ( )
inlinestaticinherited

◆ GetAuxParam() [1/4]

auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( )
inline

◆ GetAuxParam() [2/4]

auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( )
inline

◆ GetAuxParam() [3/4]

const auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( ) const
inline

◆ GetAuxParam() [4/4]

const auxParam_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetAuxParam ( ) const
inline

◆ GetBW() [1/2]

BW_type FrameCPP::Version_8::FrProcDataImpl::Data::GetBW ( ) const
inline

◆ GetBW() [2/2]

BW_type FrameCPP::Version_8::FrProcDataImpl::Data::GetBW ( ) const
inline

◆ GetComment() [1/2]

const comment_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetComment ( ) const
inline

A brief description of the FrProcData structure.

Returns
A brief description of the FrProcData structure

◆ GetComment() [2/2]

const comment_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetComment ( ) const
inline

A brief description of the FrProcData structure.

Returns
A brief description of the FrProcData structure

◆ GetFRange() [1/2]

fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFRange ( ) const
inline

Retrieve the frequency range.

Returns
The frequency range.

◆ GetFRange() [2/2]

fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFRange ( ) const
inline

Retrieve the frequency range.

Returns
The frequency range.

◆ GetFShift() [1/2]

fShift_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFShift ( ) const
inline

◆ GetFShift() [2/2]

fShift_type FrameCPP::Version_8::FrProcDataImpl::Data::GetFShift ( ) const
inline

◆ GetName() [1/2]

const name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetName ( ) const
inline

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrProcData structure

◆ GetName() [2/2]

const name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetName ( ) const
inline

Return the name associate with the FrProcData structure.

Returns
The name associated with the FrProcData structure

◆ GetNameSlow() [1/2]

const Data::name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetNameSlow ( ) const

◆ GetNameSlow() [2/2]

const name_type & FrameCPP::Version_8::FrProcDataImpl::Data::GetNameSlow ( ) const

◆ GetPhase() [1/2]

phase_type FrameCPP::Version_8::FrProcDataImpl::Data::GetPhase ( ) const
inline

◆ GetPhase() [2/2]

phase_type FrameCPP::Version_8::FrProcDataImpl::Data::GetPhase ( ) const
inline

◆ GetSubType() [1/2]

subType_type FrameCPP::Version_8::FrProcDataImpl::Data::GetSubType ( ) const
inline

◆ GetSubType() [2/2]

subType_type FrameCPP::Version_8::FrProcDataImpl::Data::GetSubType ( ) const
inline

◆ GetTimeOffset() [1/2]

timeOffset_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTimeOffset ( ) const
inline

◆ GetTimeOffset() [2/2]

timeOffset_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTimeOffset ( ) const
inline

◆ GetTRange() [1/2]

tRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTRange ( ) const
inline

Retrieve the time range.

Returns
The time range.

◆ GetTRange() [2/2]

tRange_type FrameCPP::Version_8::FrProcDataImpl::Data::GetTRange ( ) const
inline

Retrieve the time range.

Returns
The time range.

◆ GetType() [1/2]

type_type FrameCPP::Version_8::FrProcDataImpl::Data::GetType ( ) const
inline

◆ GetType() [2/2]

type_type FrameCPP::Version_8::FrProcDataImpl::Data::GetType ( ) const
inline

◆ IDSubTypeToString() [1/2]

const std::string & FrameCPP::Version_8::FrProcDataImpl::Data::IDSubTypeToString ( Data::type_type Type,
Data::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::FrProcDataImpl::Data::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::FrProcDataImpl::Data::IDTypeToString ( Data::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::FrProcDataImpl::Data::IDTypeToString ( type_type Type)
static

Convert numeric types to string representation.

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

◆ operator==() [1/2]

bool FrameCPP::Version_8::FrProcDataImpl::Data::operator== ( const Data & 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==() [2/2]

bool FrameCPP::Version_8::FrProcDataImpl::Data::operator== ( const Data & 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.

◆ RefAux() [1/4]

aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( )
inline

Identifier for vector for auxilliary data.

Returns
A reference to the auxilliary data.

◆ RefAux() [2/4]

aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( )
inline

Identifier for vector for auxilliary data.

Returns
A reference to the auxilliary data.

◆ RefAux() [3/4]

const aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( ) const
inline

Identifier for vector for auxilliary data.

Returns
A constant reference to the auxilliary data.

◆ RefAux() [4/4]

const aux_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefAux ( ) const
inline

Identifier for vector for auxilliary data.

Returns
A constant reference to the auxilliary data.

◆ RefData() [1/4]

data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( )
inline

Identifier for vector for data vector.

Returns
A reference to the data vector.

◆ RefData() [2/4]

data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( )
inline

Identifier for vector for data vector.

Returns
A reference to the data vector.

◆ RefData() [3/4]

const data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( ) const
inline

Identifier for vector for data vector.

Returns
A constant reference to the data vector.

◆ RefData() [4/4]

const data_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefData ( ) const
inline

Identifier for vector for data vector.

Returns
A constant reference to the data vector.

◆ RefHistory() [1/4]

history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( )
inline

Identifier for channel history.

Returns
A reference to the channel history.

◆ RefHistory() [2/4]

history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( )
inline

Identifier for channel history.

Returns
A reference to the channel history.

◆ RefHistory() [3/4]

const history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( ) const
inline

Identifier for channel history.

Returns
A constant reference to the channel history.

◆ RefHistory() [4/4]

const history_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefHistory ( ) const
inline

Identifier for channel history.

Returns
A constant reference to the channel history.

◆ RefTable() [1/4]

table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( )
inline

Identifier for parameter table.

Returns
A reference to the parameter table.

◆ RefTable() [2/4]

table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( )
inline

Identifier for parameter table.

Returns
A reference to the parameter table.

◆ RefTable() [3/4]

const table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( ) const
inline

Identifier for parameter table.

Returns
A constant reference to the parameter table.

◆ RefTable() [4/4]

const table_type & FrameCPP::Version_8::FrProcDataImpl::Data::RefTable ( ) const
inline

Identifier for parameter table.

Returns
A constant reference to the parameter table.

◆ SetAuxParam() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetAuxParam ( const auxParam_type & AuxParams)
inline

◆ SetAuxParam() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetAuxParam ( const auxParam_type & AuxParams)
inline

◆ SetComment() [1/2]

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

◆ SetComment() [2/2]

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

◆ SetFRange() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFRange ( fRange_type FRange)
inline

◆ SetFRange() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFRange ( fRange_type FRange)
inline

◆ SetFShift() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFShift ( fShift_type FShift)
inline

◆ SetFShift() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetFShift ( fShift_type FShift)
inline

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset)
inline

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTimeOffset ( timeOffset_type TimeOffset)
inline

◆ SetTRange() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTRange ( tRange_type TRange)
inline

◆ SetTRange() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::SetTRange ( tRange_type TRange)
inline

◆ StructName() [1/2]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ StructName() [2/2]

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::StructName ( )
inlinestaticinherited

◆ sync() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync ( ) const
inlineprotected

◆ sync() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync ( ) const
inlineprotected

◆ sync_with_vector() [1/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync_with_vector ( )
inlineprotected

◆ sync_with_vector() [2/2]

void FrameCPP::Version_8::FrProcDataImpl::Data::sync_with_vector ( )
inlineprotected

Member Data Documentation

◆ aux

aux_type FrameCPP::Version_8::FrProcDataImpl::Data::aux
protected

Auxiliary data; use is generic.

◆ auxParam

auxParam_type FrameCPP::Version_8::FrProcDataImpl::Data::auxParam
protected

Auxiliary parameters.

◆ BW

BW_type FrameCPP::Version_8::FrProcDataImpl::Data::BW
protected

Resolution bandwidth.

◆ BW_UNKNOWN

static constexpr BW_type FrameCPP::Version_8::FrProcDataImpl::Data::BW_UNKNOWN { 0 }
staticconstexpr

◆ comment

comment_type FrameCPP::Version_8::FrProcDataImpl::Data::comment
protected

Comment.

◆ data

data_type FrameCPP::Version_8::FrProcDataImpl::Data::data
protected

Data vector. The data vector fro single dimensional types (t-Series and f-Series) must have a single dimension.

◆ fRange

fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::fRange
protected

Frequency range (=fMax-fMin, 0 if unknown)

◆ FRANGE_UNKNOWN

static constexpr fRange_type FrameCPP::Version_8::FrProcDataImpl::Data::FRANGE_UNKNOWN { 0 }
staticconstexpr

◆ fShift

fShift_type FrameCPP::Version_8::FrProcDataImpl::Data::fShift
protected

fShift is the frequency in the original data that corresponds to 0 Hz in the heterodyned series

◆ history

history_type FrameCPP::Version_8::FrProcDataImpl::Data::history
protected

Channel history.

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_8::FrProcDataImpl::Data::MAX_REF { 4 }
staticconstexprprotected

◆ name

name_type FrameCPP::Version_8::FrProcDataImpl::Data::name
protected

Channel name – must be unique with the frame.

◆ phase

phase_type FrameCPP::Version_8::FrProcDataImpl::Data::phase
protected

Phase of heterodyning signal at start of dataset (radians, 0 if unknown)

◆ PHASE_UNKNOWN

static constexpr phase_type FrameCPP::Version_8::FrProcDataImpl::Data::PHASE_UNKNOWN { 0 }
staticconstexpr

◆ struct_desc

template<typename Object_T >
static struct_desc_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_desc
staticinherited

◆ struct_id

template<typename Object_T >
static struct_id_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_id
staticinherited

◆ struct_name

template<typename Object_T >
static struct_name_type FrameCPP::v3::FrObjectMetaData< Object_T >::struct_name
staticinherited

◆ subType

subType_type FrameCPP::Version_8::FrProcDataImpl::Data::subType
protected

Subtype for f-Series (TBD for other types)

◆ synced_with_vector_

bool FrameCPP::Version_8::FrProcDataImpl::Data::synced_with_vector_
protected

◆ table

table_type FrameCPP::Version_8::FrProcDataImpl::Data::table
protected

Parameter table.

◆ timeOffset

timeOffset_type FrameCPP::Version_8::FrProcDataImpl::Data::timeOffset
protected

Offset of 1st sample relative to the frame start time (seconds)

◆ tRange

tRange_type FrameCPP::Version_8::FrProcDataImpl::Data::tRange
protected

Duration of sampled data (tStop-tStart)

◆ type

type_type FrameCPP::Version_8::FrProcDataImpl::Data::type
protected

Type of data object.


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