ldas-tools-framecpp 2.9.2
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
FrameCPP::Version_8::FrAdcDataImpl::Data Class Reference

#include <FrAdcDataData.hh>

Inheritance diagram for FrameCPP::Version_8::FrAdcDataImpl::Data:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_8::FrAdcDataImpl::Data:
Collaboration graph
[legend]

Public Types

typedef FR_ADC_DATA_NAME_TYPE name_type
 
typedef FR_ADC_DATA_COMMENT_TYPE comment_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef FR_ADC_DATA_UNITS_TYPE units_type
 
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_DATA_VALID_TYPE dataValid_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 FR_ADC_DATA_NAME_TYPE name_type
 
typedef FR_ADC_DATA_COMMENT_TYPE comment_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef FR_ADC_DATA_UNITS_TYPE units_type
 
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_DATA_VALID_TYPE dataValid_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 FR_ADC_DATA_NAME_TYPE name_type
 
typedef FR_ADC_DATA_COMMENT_TYPE comment_type
 
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
 
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef FR_ADC_DATA_UNITS_TYPE units_type
 
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE sampleRate_type
 
typedef FR_ADC_DATA_TIME_OFFSET_TYPE timeOffset_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_PHASE_TYPE phase_type
 
typedef FR_ADC_DATA_DATA_VALID_TYPE dataValid_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 const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_name_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef const char *const struct_desc_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 
typedef INT_2U const struct_id_type
 

Public Member Functions

const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure. More...
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData. More...
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData. More...
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output. More...
 
bias_type GetBias () const
 DC bias on channel. More...
 
slope_type GetSlope () const
 ADC calibration units per count. More...
 
const units_typeGetUnits () const
 The units used in the ADC calibration. More...
 
sampleRate_type GetSampleRate () const
 The data acquisition rate. More...
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time. More...
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz. More...
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset. More...
 
dataValid_type GetDataValid () const
 Retrieve the overRange value. More...
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const data_typeRefData () const
 Identifier for vector of sampled data. More...
 
data_typeRefData ()
 Identifier for vector of sampled data. More...
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure. More...
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field. More...
 
void SetBias (bias_type bias)
 Establish the value of the bias field. More...
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field. More...
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field. More...
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure. More...
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output. More...
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field. More...
 
void SetSlope (slope_type slope)
 Establish the value of the slope field. More...
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field. More...
 
bool operator== (Data const &RHS) const
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure. More...
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData. More...
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData. More...
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output. More...
 
bias_type GetBias () const
 DC bias on channel. More...
 
slope_type GetSlope () const
 ADC calibration units per count. More...
 
const units_typeGetUnits () const
 The units used in the ADC calibration. More...
 
sampleRate_type GetSampleRate () const
 The data acquisition rate. More...
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time. More...
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz. More...
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset. More...
 
dataValid_type GetDataValid () const
 Retrieve the overRange value. More...
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const data_typeRefData () const
 Identifier for vector of sampled data. More...
 
data_typeRefData ()
 Identifier for vector of sampled data. More...
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure. More...
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field. More...
 
void SetBias (bias_type bias)
 Establish the value of the bias field. More...
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field. More...
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field. More...
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure. More...
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output. More...
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field. More...
 
void SetSlope (slope_type slope)
 Establish the value of the slope field. More...
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field. More...
 
bool operator== (Data const &RHS) const
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure. More...
 
channelGroup_type GetChannelGroup () const
 The channel group for the FrAdcData. More...
 
channelNumber_type GetChannelNumber () const
 The channel number for the FrAdcData. More...
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output. More...
 
bias_type GetBias () const
 DC bias on channel. More...
 
slope_type GetSlope () const
 ADC calibration units per count. More...
 
const units_typeGetUnits () const
 The units used in the ADC calibration. More...
 
sampleRate_type GetSampleRate () const
 The data acquisition rate. More...
 
timeOffset_type GetTimeOffset () const
 The offset of the first sample relative to the frame start time. More...
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz. More...
 
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset. More...
 
dataValid_type GetDataValid () const
 Retrieve the overRange value. More...
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information. More...
 
aux_typeRefAux ()
 Identifier for vector for user-provided information. More...
 
const data_typeRefData () const
 Identifier for vector of sampled data. More...
 
data_typeRefData ()
 Identifier for vector of sampled data. More...
 
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure. More...
 
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field. More...
 
void SetBias (bias_type bias)
 Establish the value of the bias field. More...
 
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field. More...
 
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field. More...
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure. More...
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output. More...
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field. More...
 
void SetSlope (slope_type slope)
 Establish the value of the slope field. More...
 
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field. More...
 
bool operator== (Data const &RHS) const
 
bool operator== (FrAdcData const &RHS) const
 

Static Public Member Functions

static const units_typeDEFAULT_UNITS ()
 
static const units_typeDEFAULT_UNITS ()
 
static const units_typeDEFAULT_UNITS ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type FrameSpecName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_name_type StructName ()
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_desc_type FrameSpecDescription ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 
static struct_id_type FrameSpecId ()
 Return the dictionary name of the structure. More...
 

Static Public Attributes

static constexpr slope_type DEFAULT_SLOPE { 1.0 }
 
static constexpr bias_type DEFAULT_BIAS { 0 }
 
static constexpr fShift_type DEFAULT_FSHIFT { 0 }
 
static constexpr timeOffset_type DEFAULT_TIME_OFFSET { 0 }
 
static constexpr dataValid_type DEFAULT_DATA_VALID { 0 }
 
static constexpr phase_type DEFAULT_PHASE { 0 }
 
static struct_name_type struct_name
 
static struct_desc_type struct_desc
 
static struct_id_type struct_id
 

Protected Member Functions

void incrementTimeOffset (timeOffset_type Value)
 
void setName (const name_type &Value)
 
void incrementTimeOffset (timeOffset_type Value)
 
void setName (const name_type &Value)
 
void incrementTimeOffset (timeOffset_type Value)
 
void setName (const name_type &Value)
 

Protected Attributes

name_type name
 Channel name – must be unique with the frame. More...
 
comment_type comment
 Comment. More...
 
channelGroup_type channelGroup
 Channel grouping number containing ADC. More...
 
channelNumber_type channelNumber
 Channel nubmer. More...
 
nBits_type nBits
 Number of bits in A/D output. More...
 
bias_type bias { DEFAULT_BIAS }
 DC bias on channel (Units @ ADC counts = 0) More...
 
slope_type slope { DEFAULT_SLOPE }
 ADC calibration: input units/ct. More...
 
units_type units { DEFAULT_UNITS( ) }
 ADC calibration: input units for slope. More...
 
sampleRate_type sampleRate
 Data acquisition rate, samples/s. More...
 
timeOffset_type timeOffset { DEFAULT_TIME_OFFSET }
 Offset of 1st sample relative to the frame start time. More...
 
fShift_type fShift { DEFAULT_FSHIFT }
 
phase_type phase { DEFAULT_PHASE }
 
dataValid_type dataValid { DEFAULT_DATA_VALID }
 Data valid flag. More...
 
data_type data
 Identifier for vector of sampled data. More...
 
aux_type aux
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 2 }
 

Member Typedef Documentation

◆ aux_iterator [1/3]

◆ aux_iterator [2/3]

◆ aux_iterator [3/3]

◆ aux_type [1/3]

◆ aux_type [2/3]

◆ aux_type [3/3]

◆ bias_type [1/3]

◆ bias_type [2/3]

◆ bias_type [3/3]

◆ channelGroup_type [1/3]

◆ channelGroup_type [2/3]

◆ channelGroup_type [3/3]

◆ channelNumber_type [1/3]

◆ channelNumber_type [2/3]

◆ channelNumber_type [3/3]

◆ comment_type [1/3]

◆ comment_type [2/3]

◆ comment_type [3/3]

◆ const_aux_iterator [1/3]

◆ const_aux_iterator [2/3]

◆ const_aux_iterator [3/3]

◆ const_iterator [1/3]

◆ const_iterator [2/3]

◆ const_iterator [3/3]

◆ data_type [1/3]

◆ data_type [2/3]

◆ data_type [3/3]

◆ dataValid_type [1/3]

◆ dataValid_type [2/3]

◆ dataValid_type [3/3]

◆ fShift_type [1/3]

◆ fShift_type [2/3]

◆ fShift_type [3/3]

◆ iterator [1/3]

◆ iterator [2/3]

◆ iterator [3/3]

◆ name_type [1/3]

◆ name_type [2/3]

◆ name_type [3/3]

◆ nBits_type [1/3]

◆ nBits_type [2/3]

◆ nBits_type [3/3]

◆ phase_type [1/3]

◆ phase_type [2/3]

◆ phase_type [3/3]

◆ sampleRate_type [1/3]

◆ sampleRate_type [2/3]

◆ sampleRate_type [3/3]

◆ slope_type [1/3]

◆ slope_type [2/3]

◆ slope_type [3/3]

◆ struct_desc_type [1/3]

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

◆ struct_desc_type [2/3]

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

◆ struct_desc_type [3/3]

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

◆ struct_id_type [1/3]

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

◆ struct_id_type [2/3]

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

◆ struct_id_type [3/3]

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

◆ struct_name_type [1/3]

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

◆ struct_name_type [2/3]

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

◆ struct_name_type [3/3]

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

◆ timeOffset_type [1/3]

◆ timeOffset_type [2/3]

◆ timeOffset_type [3/3]

◆ units_type [1/3]

◆ units_type [2/3]

◆ units_type [3/3]

Member Function Documentation

◆ AppendComment() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment ( const std::string &  comment)
inline

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment ( const std::string &  comment)

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment ( const std::string &  comment)

Extend the comment associated with the FrAdcData structure.

◆ DEFAULT_UNITS() [1/3]

const Data::units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_UNITS ( )
inlinestatic

◆ DEFAULT_UNITS() [2/3]

static const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_UNITS ( )
static

◆ DEFAULT_UNITS() [3/3]

static const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_UNITS ( )
static

◆ FrameSpecDescription() [1/3]

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

Return the dictionary name of the structure.

◆ FrameSpecDescription() [2/3]

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

Return the dictionary name of the structure.

◆ FrameSpecDescription() [3/3]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [1/3]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [2/3]

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

Return the dictionary name of the structure.

◆ FrameSpecId() [3/3]

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

Return the dictionary name of the structure.

◆ FrameSpecName() [1/3]

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

◆ FrameSpecName() [2/3]

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

◆ FrameSpecName() [3/3]

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

◆ GetBias() [1/3]

Data::bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias ( ) const
inline

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/3]

bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias ( ) const

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [3/3]

bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias ( ) const

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup() [1/3]

Data::channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup ( ) const
inline

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelGroup() [2/3]

channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup ( ) const

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelGroup() [3/3]

channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup ( ) const

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber() [1/3]

Data::channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber ( ) const
inline

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannelNumber() [2/3]

channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber ( ) const

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannelNumber() [3/3]

channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber ( ) const

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment() [1/3]

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

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/3]

const comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment ( ) const

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [3/3]

const comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment ( ) const

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid() [1/3]

Data::dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid ( ) const
inline

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDataValid() [2/3]

dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid ( ) const

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDataValid() [3/3]

dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid ( ) const

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetFShift() [1/3]

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

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetFShift() [2/3]

fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetFShift ( ) const

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetFShift() [3/3]

fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetFShift ( ) const

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.

◆ GetName() [1/3]

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

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [2/3]

const name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName ( ) const

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [3/3]

const name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName ( ) const

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNBits() [1/3]

Data::nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits ( ) const
inline

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetNBits() [2/3]

nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits ( ) const

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetNBits() [3/3]

nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits ( ) const

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetPhase() [1/3]

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

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetPhase() [2/3]

phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetPhase ( ) const

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetPhase() [3/3]

phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetPhase ( ) const

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetSampleRate() [1/3]

Data::sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate ( ) const
inline

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/3]

sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate ( ) const

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [3/3]

sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate ( ) const

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/3]

Data::slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope ( ) const
inline

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/3]

slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope ( ) const

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [3/3]

slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope ( ) const

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffset() [1/3]

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

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffset() [2/3]

timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetTimeOffset ( ) const

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetTimeOffset() [3/3]

timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetTimeOffset ( ) const

The offset of the first sample relative to the frame start time.

Returns
The offset of the first sample relative to the frame start time.

◆ GetUnits() [1/3]

const Data::units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits ( ) const
inline

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/3]

const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits ( ) const

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [3/3]

const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits ( ) const

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ incrementTimeOffset() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::incrementTimeOffset ( timeOffset_type  Value)
inlineprotected

◆ incrementTimeOffset() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::incrementTimeOffset ( timeOffset_type  Value)
protected

◆ incrementTimeOffset() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::incrementTimeOffset ( timeOffset_type  Value)
protected

◆ operator==() [1/4]

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

◆ operator==() [2/4]

bool FrameCPP::Version_8::FrAdcDataImpl::Data::operator== ( Data const &  RHS) const

◆ operator==() [3/4]

bool FrameCPP::Version_8::FrAdcDataImpl::Data::operator== ( Data const &  RHS) const

◆ operator==() [4/4]

bool FrameCPP::v5::FrAdcData< FrVect , FrVect >::operator== ( FrAdcData< FrVect, FrVect > const &  RHS) const
inlineinherited

◆ RefAux() [1/6]

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

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [2/6]

aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( )

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [3/6]

aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( )

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [4/6]

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

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [5/6]

const aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( ) const

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [6/6]

const aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux ( ) const

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefData() [1/6]

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

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [2/6]

data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( )

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [3/6]

data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( )

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [4/6]

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

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ RefData() [5/6]

const data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( ) const

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ RefData() [6/6]

const data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData ( ) const

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ SetBias() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias ( bias_type  bias)
inline

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetBias() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias ( bias_type  bias)

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetBias() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias ( bias_type  bias)

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetChannelGroup() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type  Value)
inline

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelGroup() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type  Value)

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelGroup() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup ( channelGroup_type  Value)

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelNumber() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type  Value)
inline

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetChannelNumber() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type  Value)

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetChannelNumber() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber ( channelNumber_type  Value)

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetComment() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetComment ( const comment_type Value)
inline

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetComment() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetComment ( const comment_type Value)

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetComment() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetComment ( const comment_type Value)

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetDataValid() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid ( dataValid_type  flag)
inline

Establish the value of the dataValid field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetDataValid() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid ( dataValid_type  flag)

Establish the value of the dataValid field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetDataValid() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid ( dataValid_type  flag)

Establish the value of the dataValid field.

Parameters
[in]flagThe desired value of the overRange field.

◆ setName() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::setName ( const name_type Value)
inlineprotected

◆ setName() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::setName ( const name_type Value)
protected

◆ setName() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::setName ( const name_type Value)
protected

◆ SetNBits() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetNBits ( nBits_type  Value)
inline

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ SetNBits() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetNBits ( nBits_type  Value)

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ SetNBits() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetNBits ( nBits_type  Value)

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ SetSampleRate() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type  Value)
inline

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type  Value)

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate ( sampleRate_type  Value)

Establish the value of the sampleRate field.

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

◆ SetSlope() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope ( slope_type  slope)
inline

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetSlope() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope ( slope_type  slope)

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetSlope() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope ( slope_type  slope)

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetTimeOffset() [1/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type  Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffset() [2/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type  Value)

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffset() [3/3]

void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset ( timeOffset_type  Value)

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ StructName() [1/3]

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

◆ StructName() [2/3]

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

◆ StructName() [3/3]

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

Member Data Documentation

◆ aux

aux_type FrameCPP::Version_8::FrAdcDataImpl::Data::aux
protected

Identifier for vector for user-provided information; use is generic

◆ bias

bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::bias { DEFAULT_BIAS }
protected

DC bias on channel (Units @ ADC counts = 0)

◆ channelGroup

channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::channelGroup
protected

Channel grouping number containing ADC.

◆ channelNumber

channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::channelNumber
protected

Channel nubmer.

◆ comment

comment_type FrameCPP::Version_8::FrAdcDataImpl::Data::comment
protected

Comment.

◆ data

data_type FrameCPP::Version_8::FrAdcDataImpl::Data::data
protected

Identifier for vector of sampled data.

◆ dataValid

dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::dataValid { DEFAULT_DATA_VALID }
protected

Data valid flag.

◆ DEFAULT_BIAS

static constexpr bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_BIAS { 0 }
staticconstexpr

◆ DEFAULT_DATA_VALID

static constexpr dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_DATA_VALID { 0 }
staticconstexpr

◆ DEFAULT_FSHIFT

static constexpr fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_FSHIFT { 0 }
staticconstexpr

◆ DEFAULT_PHASE

static constexpr phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_PHASE { 0 }
staticconstexpr

◆ DEFAULT_SLOPE

static constexpr slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_SLOPE { 1.0 }
staticconstexpr

◆ DEFAULT_TIME_OFFSET

static constexpr timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::DEFAULT_TIME_OFFSET { 0 }
staticconstexpr

◆ fShift

fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::fShift { DEFAULT_FSHIFT }
protected

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

◆ MAX_REF

static constexpr unsigned int FrameCPP::Version_8::FrAdcDataImpl::Data::MAX_REF { 2 }
staticconstexprprotected

◆ name

name_type FrameCPP::Version_8::FrAdcDataImpl::Data::name
protected

Channel name – must be unique with the frame.

◆ nBits

nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::nBits
protected

Number of bits in A/D output.

◆ phase

phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::phase { DEFAULT_PHASE }
protected

Phase (in radian) of hetrodyning signal at start of dataset

◆ sampleRate

sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::sampleRate
protected

Data acquisition rate, samples/s.

◆ slope

slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::slope { DEFAULT_SLOPE }
protected

ADC calibration: input units/ct.

◆ 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

◆ timeOffset

timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::timeOffset { DEFAULT_TIME_OFFSET }
protected

Offset of 1st sample relative to the frame start time.

◆ units

units_type FrameCPP::Version_8::FrAdcDataImpl::Data::units { DEFAULT_UNITS( ) }
protected

ADC calibration: input units for slope.


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