ldas-tools-framecpp 3.0.4
 
Loading...
Searching...
No Matches
FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T > Class Template Reference

#include <FrAdcData.hh>

Collaboration diagram for FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >:

Public Types

typedef FR_ADC_DATA_NAME_TYPE name_type
 
typedef FR_ADC_DATA_COMMENT_TYPE comment_type
 
typedef FR_ADC_DATA_CRATE_TYPE crate_type
 
typedef FR_ADC_DATA_CHANNEL_TYPE channel_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_S_TYPE timeOffsetS_type
 
typedef FR_ADC_DATA_TIME_OFFSET_N_TYPE timeOffsetN_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_OVER_RANGE_TYPE overRange_type
 
typedef Common::Container< DATA_TYPE_T > data_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< AUX_TYPE_T > aux_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_CRATE_TYPE crate_type
 
typedef FR_ADC_DATA_CHANNEL_TYPE channel_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_S_TYPE timeOffsetS_type
 
typedef FR_ADC_DATA_TIME_OFFSET_N_TYPE timeOffsetN_type
 
typedef FR_ADC_DATA_F_SHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_OVER_RANGE_TYPE overRange_type
 
typedef Common::Container< DATA_TYPE_T > data_type
 
typedef data_type::const_iterator const_iterator
 
typedef data_type::iterator iterator
 
typedef Common::Container< AUX_TYPE_T > aux_type
 
typedef aux_type::const_iterator const_aux_iterator
 
typedef aux_type::iterator aux_iterator
 

Public Member Functions

const name_typeGetName () const
 Return the name associate with the FrAdcData structure.
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure.
 
crate_type GetCrate () const
 The channel group for the FrAdcData.
 
channel_type GetChannel () const
 The channel number for the FrAdcData.
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output.
 
bias_type GetBias () const
 DC bias on channel.
 
slope_type GetSlope () const
 ADC calibration units per count.
 
const units_typeGetUnits () const
 The units used in the ADC calibration.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
timeOffsetS_type GetTimeOffsetS () const
 The offset of the first sample relative to the frame start time.
 
timeOffsetN_type GetTimeOffsetN () const
 The offset of the first sample relative to the frame start time.
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz.
 
overRange_type GetOverRange () const
 Retrieve the overRange value.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const data_typeRefData () const
 Identifier for vector of sampled data.
 
data_typeRefData ()
 Identifier for vector of sampled data.
 
void AppendComment (const std::string &Comment)
 Extend the comment associated with the FrAdcData structure.
 
void SetOverRange (overRange_type Value)
 Establish the value of the overRange field.
 
void SetBias (bias_type Value)
 Establish the value of the bias field.
 
void SetCrate (crate_type Value)
 Establish the value of the crate field.
 
void SetChannel (channel_type Value)
 Establish the value of the channel field.
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
 
void SetSlope (slope_type Value)
 Establish the value of the slope field.
 
void SetTimeOffsetS (timeOffsetS_type Value)
 Establish the value of the timeOffset field.
 
void SetTimeOffsetN (timeOffsetN_type Value)
 Establish the value of the timeOffset field.
 
bool operator== (FrAdcData const &RHS) const
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure.
 
const comment_typeGetComment () const
 A brief description of the FrAdcData structure.
 
crate_type GetCrate () const
 The channel group for the FrAdcData.
 
channel_type GetChannel () const
 The channel number for the FrAdcData.
 
nBits_type GetNBits () const
 Tne number of bits in the A/D output.
 
bias_type GetBias () const
 DC bias on channel.
 
slope_type GetSlope () const
 ADC calibration units per count.
 
const units_typeGetUnits () const
 The units used in the ADC calibration.
 
sampleRate_type GetSampleRate () const
 The data acquisition rate.
 
timeOffsetS_type GetTimeOffsetS () const
 The offset of the first sample relative to the frame start time.
 
timeOffsetN_type GetTimeOffsetN () const
 The offset of the first sample relative to the frame start time.
 
fShift_type GetFShift () const
 The frequency in the original data corresponding to 0 Hz.
 
overRange_type GetOverRange () const
 Retrieve the overRange value.
 
const aux_typeRefAux () const
 Identifier for vector for user-provided information.
 
aux_typeRefAux ()
 Identifier for vector for user-provided information.
 
const data_typeRefData () const
 Identifier for vector of sampled data.
 
data_typeRefData ()
 Identifier for vector of sampled data.
 
void AppendComment (const std::string &Comment)
 Extend the comment associated with the FrAdcData structure.
 
void SetOverRange (overRange_type Value)
 Establish the value of the overRange field.
 
void SetBias (bias_type Value)
 Establish the value of the bias field.
 
void SetCrate (crate_type Value)
 Establish the value of the crate field.
 
void SetChannel (channel_type Value)
 Establish the value of the channel field.
 
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
 
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
 
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
 
void SetSlope (slope_type Value)
 Establish the value of the slope field.
 
void SetTimeOffsetS (timeOffsetS_type Value)
 Establish the value of the timeOffset field.
 
void SetTimeOffsetN (timeOffsetN_type Value)
 Establish the value of the timeOffset field.
 
bool operator== (FrAdcData const &RHS) const
 

Static Public Member Functions

static const units_typeDEFAULT_UNITS ()
 
static const units_typeDEFAULT_UNITS ()
 

Static Public Attributes

static constexpr slope_type DEFAULT_SLOPE { 0 }
 
static constexpr bias_type DEFAULT_BIAS { 0 }
 
static constexpr fShift_type DEFAULT_FSHIFT { 0 }
 
static constexpr timeOffsetS_type DEFAULT_TIME_OFFSET_S { 0 }
 
static constexpr timeOffsetN_type DEFAULT_TIME_OFFSET_N { 0 }
 
static constexpr overRange_type DEFAULT_OVER_RANGE { 0 }
 

Protected Member Functions

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

Protected Attributes

name_type name
 Channel name – must be unique with the frame.
 
comment_type comment
 Comment.
 
crate_type crate
 Channel grouping number containing ADC.
 
channel_type channel
 Channel nubmer.
 
nBits_type nBits
 Number of bits in A/D output.
 
bias_type bias
 DC bias on channel (Units @ ADC counts = 0)
 
slope_type slope
 ADC calibration: input units/ct.
 
units_type units
 ADC calibration: input units for slope.
 
sampleRate_type sampleRate
 Data acquisition rate, samples/s.
 
timeOffsetS_type timeOffsetS
 Offset of 1st sample relative to the frame start time.
 
timeOffsetN_type timeOffsetN
 Offset of 1st sample relative to the frame start time.
 
fShift_type fShift
 
overRange_type overRange
 Data valid flag.
 
data_type data
 Identifier for vector of sampled data.
 
aux_type aux
 

Static Protected Attributes

static constexpr unsigned int MAX_REF { 2 }
 

Member Typedef Documentation

◆ aux_iterator [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef aux_type::iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_iterator

◆ aux_iterator [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef aux_type::iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_iterator

◆ aux_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef Common::Container< AUX_TYPE_T > FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_type

◆ aux_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef Common::Container< AUX_TYPE_T > FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_type

◆ bias_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::bias_type

◆ bias_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::bias_type

◆ channel_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_CHANNEL_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channel_type

◆ channel_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_CHANNEL_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channel_type

◆ comment_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_COMMENT_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::comment_type

◆ comment_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_COMMENT_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::comment_type

◆ const_aux_iterator [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef aux_type::const_iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_aux_iterator

◆ const_aux_iterator [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef aux_type::const_iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_aux_iterator

◆ const_iterator [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef data_type::const_iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_iterator

◆ const_iterator [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef data_type::const_iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_iterator

◆ crate_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_CRATE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::crate_type

◆ crate_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_CRATE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::crate_type

◆ data_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef Common::Container< DATA_TYPE_T > FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::data_type

◆ data_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef Common::Container< DATA_TYPE_T > FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::data_type

◆ fShift_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_F_SHIFT_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::fShift_type

◆ fShift_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_F_SHIFT_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::fShift_type

◆ iterator [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef data_type::iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::iterator

◆ iterator [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef data_type::iterator FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::iterator

◆ name_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_NAME_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::name_type

◆ name_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_NAME_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::name_type

◆ nBits_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::nBits_type

◆ nBits_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::nBits_type

◆ overRange_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_OVER_RANGE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::overRange_type

◆ overRange_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_OVER_RANGE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::overRange_type

◆ sampleRate_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::sampleRate_type

◆ sampleRate_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_SAMPLE_RATE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::sampleRate_type

◆ slope_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::slope_type

◆ slope_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::slope_type

◆ timeOffsetN_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_TIME_OFFSET_N_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetN_type

◆ timeOffsetN_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_TIME_OFFSET_N_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetN_type

◆ timeOffsetS_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_TIME_OFFSET_S_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS_type

◆ timeOffsetS_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_TIME_OFFSET_S_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS_type

◆ units_type [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_UNITS_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::units_type

◆ units_type [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
typedef FR_ADC_DATA_UNITS_TYPE FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::units_type

Member Function Documentation

◆ AppendComment() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::AppendComment ( const std::string & Comment)
inline

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::AppendComment ( const std::string & Comment)
inline

Extend the comment associated with the FrAdcData structure.

◆ DEFAULT_UNITS() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static const units_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_UNITS ( )
inlinestatic

◆ DEFAULT_UNITS() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static const units_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_UNITS ( )
inlinestatic

◆ GetBias() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
bias_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetBias ( ) const
inline

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
bias_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetBias ( ) const
inline

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannel() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
channel_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetChannel ( ) const
inline

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannel() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
channel_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetChannel ( ) const
inline

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const comment_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetComment ( ) const
inline

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const comment_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetComment ( ) const
inline

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetCrate() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
crate_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetCrate ( ) const
inline

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetCrate() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
crate_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetCrate ( ) const
inline

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetFShift() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
fShift_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::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/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
fShift_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetFShift ( ) const
inline

The frequency in the original data corresponding to 0 Hz.

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

◆ GetName() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const name_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetName ( ) const
inline

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const name_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetName ( ) const
inline

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNBits() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
nBits_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetNBits ( ) const
inline

Tne number of bits in the A/D output.

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

◆ GetNBits() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
nBits_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetNBits ( ) const
inline

Tne number of bits in the A/D output.

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

◆ GetOverRange() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
overRange_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetOverRange ( ) const
inline

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetOverRange() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
overRange_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetOverRange ( ) const
inline

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetSampleRate() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
sampleRate_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetSampleRate ( ) const
inline

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
sampleRate_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetSampleRate ( ) const
inline

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
slope_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetSlope ( ) const
inline

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
slope_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetSlope ( ) const
inline

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffsetN() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
timeOffsetN_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetTimeOffsetN ( ) 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.

◆ GetTimeOffsetN() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
timeOffsetN_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetTimeOffsetN ( ) 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.

◆ GetTimeOffsetS() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
timeOffsetS_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetTimeOffsetS ( ) 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.

◆ GetTimeOffsetS() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
timeOffsetS_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetTimeOffsetS ( ) 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.

◆ GetUnits() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const units_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetUnits ( ) const
inline

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const units_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::GetUnits ( ) const
inline

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ operator==() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
bool FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::operator== ( FrAdcData< DATA_TYPE_T, AUX_TYPE_T > const & RHS) const
inline

◆ operator==() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
bool FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::operator== ( FrAdcData< DATA_TYPE_T, AUX_TYPE_T > const & RHS) const
inline

◆ RefAux() [1/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
aux_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefAux ( )
inline

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [2/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
aux_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefAux ( )
inline

Identifier for vector for user-provided information.

Returns
A reference to the user-provided information.

◆ RefAux() [3/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const aux_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefAux ( ) const
inline

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefAux() [4/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const aux_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefAux ( ) const
inline

Identifier for vector for user-provided information.

Returns
A constant reference to the user-provided information.

◆ RefData() [1/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
data_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefData ( )
inline

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [2/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
data_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefData ( )
inline

Identifier for vector of sampled data.

Returns
A reference to the sampled data.

◆ RefData() [3/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const data_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefData ( ) const
inline

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ RefData() [4/4]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
const data_type & FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::RefData ( ) const
inline

Identifier for vector of sampled data.

Returns
A constant reference to the sampled data.

◆ SetBias() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetBias ( bias_type Value)
inline

Establish the value of the bias field.

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

◆ SetBias() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetBias ( bias_type Value)
inline

Establish the value of the bias field.

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

◆ SetChannel() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetChannel ( channel_type Value)
inline

Establish the value of the channel field.

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

◆ SetChannel() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetChannel ( channel_type Value)
inline

Establish the value of the channel field.

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

◆ SetComment() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::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/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetComment ( const comment_type & Value)
inline

Set the comment associated with the FrAdcData structure.

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

◆ SetCrate() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetCrate ( crate_type Value)
inline

Establish the value of the crate field.

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

◆ SetCrate() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetCrate ( crate_type Value)
inline

Establish the value of the crate field.

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

◆ setName() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::setName ( const name_type & Value)
inlineprotected

◆ setName() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::setName ( const name_type & Value)
inlineprotected

◆ SetNBits() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::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/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetNBits ( nBits_type Value)
inline

Tne number of bits in the A/D output.

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

◆ SetOverRange() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetOverRange ( overRange_type Value)
inline

Establish the value of the overRange field.

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

◆ SetOverRange() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetOverRange ( overRange_type Value)
inline

Establish the value of the overRange field.

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

◆ SetSampleRate() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetSampleRate ( sampleRate_type Value)
inline

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetSampleRate ( sampleRate_type Value)
inline

Establish the value of the sampleRate field.

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

◆ SetSlope() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetSlope ( slope_type Value)
inline

Establish the value of the slope field.

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

◆ SetSlope() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetSlope ( slope_type Value)
inline

Establish the value of the slope field.

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

◆ SetTimeOffsetN() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetTimeOffsetN ( timeOffsetN_type Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffsetN() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetTimeOffsetN ( timeOffsetN_type Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffsetS() [1/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetTimeOffsetS ( timeOffsetS_type Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffsetS() [2/2]

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
void FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::SetTimeOffsetS ( timeOffsetS_type Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

Member Data Documentation

◆ aux

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
aux_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux
protected

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

◆ bias

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
bias_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::bias
protected

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

◆ channel

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
channel_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channel
protected

Channel nubmer.

◆ comment

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
comment_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::comment
protected

Comment.

◆ crate

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
crate_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::crate
protected

Channel grouping number containing ADC.

◆ data

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
data_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::data
protected

Identifier for vector of sampled data.

◆ DEFAULT_BIAS

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr bias_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_BIAS { 0 }
staticconstexpr

◆ DEFAULT_FSHIFT

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr fShift_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_FSHIFT { 0 }
staticconstexpr

◆ DEFAULT_OVER_RANGE

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr overRange_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_OVER_RANGE { 0 }
staticconstexpr

◆ DEFAULT_SLOPE

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr slope_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_SLOPE { 0 }
staticconstexpr

◆ DEFAULT_TIME_OFFSET_N

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr timeOffsetN_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_TIME_OFFSET_N { 0 }
staticconstexpr

◆ DEFAULT_TIME_OFFSET_S

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr timeOffsetS_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::DEFAULT_TIME_OFFSET_S { 0 }
staticconstexpr

◆ fShift

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
fShift_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::fShift
protected

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

◆ MAX_REF

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
static constexpr unsigned int FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::MAX_REF { 2 }
staticconstexprprotected

◆ name

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
name_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::name
protected

Channel name – must be unique with the frame.

◆ nBits

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
nBits_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::nBits
protected

Number of bits in A/D output.

◆ overRange

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
overRange_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::overRange
protected

Data valid flag.

◆ sampleRate

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
sampleRate_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::sampleRate
protected

Data acquisition rate, samples/s.

◆ slope

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
slope_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::slope
protected

ADC calibration: input units/ct.

◆ timeOffsetN

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
timeOffsetN_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetN
protected

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

◆ timeOffsetS

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
timeOffsetS_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS
protected

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

◆ units

template<typename DATA_TYPE_T, typename AUX_TYPE_T>
units_type FrameCPP::v3::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::units
protected

ADC calibration: input units for slope.


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