#include <FrAdcData.hh>

Public Member Functions | |
| const name_type & | GetName () const |
| Return the name associate with the FrAdcData structure. | |
| const comment_type & | GetComment () const |
| A brief description of the FrAdcData structure. | |
| channelGroup_type | GetChannelGroup () const |
| The channel group for the FrAdcData. | |
| channelNumber_type | GetChannelNumber () 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_type & | GetUnits () const |
| The units used in the ADC calibration. | |
| sampleRate_type | GetSampleRate () const |
| The data acquisition rate. | |
| timeOffset_type | GetTimeOffset () 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. | |
| phase_type | GetPhase () const |
| Phase of hetrodyning signal at start of dataset. | |
| dataValid_type | GetDataValid () const |
| Retrieve the overRange value. | |
| const aux_type & | RefAux () const |
| Identifier for vector for user-provided information. | |
| aux_type & | RefAux () |
| Identifier for vector for user-provided information. | |
| const data_type & | RefData () const |
| Identifier for vector of sampled data. | |
| data_type & | RefData () |
| Identifier for vector of sampled data. | |
| void | AppendComment (const std::string &Comment) |
| Extend the comment associated with the FrAdcData structure. | |
| void | SetDataValid (dataValid_type Value) |
| Establish the value of the dataValid field. | |
| void | SetBias (bias_type Value) |
| Establish the value of the bias field. | |
| void | SetChannelGroup (channelGroup_type Value) |
| Establish the value of the channelGroup field. | |
| void | SetChannelNumber (channelNumber_type Value) |
| Establish the value of the channelNumber 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 | SetTimeOffset (timeOffset_type Value) |
| Establish the value of the timeOffset field. | |
| bool | operator== (FrAdcData const &RHS) const |
| const name_type & | GetName () const |
| Return the name associate with the FrAdcData structure. | |
| const comment_type & | GetComment () const |
| A brief description of the FrAdcData structure. | |
| channelGroup_type | GetChannelGroup () const |
| The channel group for the FrAdcData. | |
| channelNumber_type | GetChannelNumber () 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_type & | GetUnits () const |
| The units used in the ADC calibration. | |
| sampleRate_type | GetSampleRate () const |
| The data acquisition rate. | |
| timeOffset_type | GetTimeOffset () 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. | |
| phase_type | GetPhase () const |
| Phase of hetrodyning signal at start of dataset. | |
| dataValid_type | GetDataValid () const |
| Retrieve the overRange value. | |
| const aux_type & | RefAux () const |
| Identifier for vector for user-provided information. | |
| aux_type & | RefAux () |
| Identifier for vector for user-provided information. | |
| const data_type & | RefData () const |
| Identifier for vector of sampled data. | |
| data_type & | RefData () |
| Identifier for vector of sampled data. | |
| void | AppendComment (const std::string &Comment) |
| Extend the comment associated with the FrAdcData structure. | |
| void | SetDataValid (dataValid_type Value) |
| Establish the value of the dataValid field. | |
| void | SetBias (bias_type Value) |
| Establish the value of the bias field. | |
| void | SetChannelGroup (channelGroup_type Value) |
| Establish the value of the channelGroup field. | |
| void | SetChannelNumber (channelNumber_type Value) |
| Establish the value of the channelNumber 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 | SetTimeOffset (timeOffset_type Value) |
| Establish the value of the timeOffset field. | |
| bool | operator== (FrAdcData const &RHS) const |
Static Public Member Functions | |
| static const units_type & | DEFAULT_UNITS () |
| static const units_type & | DEFAULT_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 timeOffset_type | DEFAULT_TIME_OFFSET { 0 } |
| static constexpr dataValid_type | DEFAULT_DATA_VALID { 0 } |
| static constexpr phase_type | DEFAULT_PHASE { 0 } |
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) |
Protected Attributes | |
| name_type | name |
| Channel name – must be unique with the frame. | |
| comment_type | comment |
| Comment. | |
| channelGroup_type | channelGroup |
| Channel grouping number containing ADC. | |
| channelNumber_type | channelNumber |
| 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. | |
| timeOffset_type | timeOffset |
| Offset of 1st sample relative to the frame start time. | |
| fShift_type | fShift |
| phase_type | phase |
| dataValid_type | dataValid |
| 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 } |
| typedef aux_type::iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_iterator |
| typedef aux_type::iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_iterator |
| typedef Common::Container< AUX_TYPE_T > FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_type |
| typedef Common::Container< AUX_TYPE_T > FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::aux_type |
| typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::bias_type |
| typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::bias_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channel_v3_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channel_v3_type |
| typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channelGroup_type |
| typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channelGroup_type |
| typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channelNumber_type |
| typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::channelNumber_type |
| typedef FR_ADC_DATA_COMMENT_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::comment_type |
| typedef FR_ADC_DATA_COMMENT_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::comment_type |
| typedef aux_type::const_iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_aux_iterator |
| typedef aux_type::const_iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_aux_iterator |
| typedef data_type::const_iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_iterator |
| typedef data_type::const_iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::const_iterator |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::crate_v3_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::crate_v3_type |
| typedef Common::Container< DATA_TYPE_T > FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::data_type |
| typedef Common::Container< DATA_TYPE_T > FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::data_type |
| typedef FR_ADC_DATA_DATA_VALID_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::dataValid_type |
| typedef FR_ADC_DATA_DATA_VALID_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::dataValid_type |
| typedef FR_ADC_DATA_F_SHIFT_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::fShift_type |
| typedef FR_ADC_DATA_F_SHIFT_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::fShift_type |
| typedef data_type::iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::iterator |
| typedef data_type::iterator FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::iterator |
| typedef FR_ADC_DATA_NAME_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::name_type |
| typedef FR_ADC_DATA_NAME_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::name_type |
| typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::nBits_type |
| typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::nBits_type |
| typedef INT_2U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::overRange_v3_type |
| typedef INT_2U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::overRange_v3_type |
| typedef FR_ADC_DATA_PHASE_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::phase_type |
| typedef FR_ADC_DATA_PHASE_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::phase_type |
| typedef FR_ADC_DATA_SAMPLE_RATE_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::sampleRate_type |
| typedef FR_ADC_DATA_SAMPLE_RATE_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::sampleRate_type |
| typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::slope_type |
| typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::slope_type |
| typedef FR_ADC_DATA_TIME_OFFSET_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffset_type |
| typedef FR_ADC_DATA_TIME_OFFSET_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffset_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetN_v3_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetN_v3_type |
| typedef INT_4S FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS_v3_type |
| typedef INT_4S FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS_v3_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS_v4_type |
| typedef INT_4U FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::timeOffsetS_v4_type |
| typedef FR_ADC_DATA_UNITS_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::units_type |
| typedef FR_ADC_DATA_UNITS_TYPE FrameCPP::v5::FrAdcData< DATA_TYPE_T, AUX_TYPE_T >::units_type |
|
inline |
Extend the comment associated with the FrAdcData structure.
|
inline |
Extend the comment associated with the FrAdcData structure.
|
inlinestatic |
|
inlinestatic |
|
inline |
DC bias on channel.
|
inline |
DC bias on channel.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Retrieve the overRange value.
|
inline |
Retrieve the overRange value.
|
inline |
The frequency in the original data corresponding to 0 Hz.
|
inline |
The frequency in the original data corresponding to 0 Hz.
|
inline |
|
inline |
|
inline |
Tne number of bits in the A/D output.
|
inline |
Tne number of bits in the A/D output.
|
inline |
Phase of hetrodyning signal at start of dataset.
|
inline |
Phase of hetrodyning signal at start of dataset.
|
inline |
The data acquisition rate.
|
inline |
The data acquisition rate.
|
inline |
ADC calibration units per count.
|
inline |
ADC calibration units per count.
|
inline |
The offset of the first sample relative to the frame start time.
|
inline |
The offset of the first sample relative to the frame start time.
|
inline |
The units used in the ADC calibration.
|
inline |
The units used in the ADC calibration.
|
inlineprotected |
|
inlineprotected |
|
inline |
|
inline |
|
inline |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector of sampled data.
|
inline |
Identifier for vector of sampled data.
|
inline |
Identifier for vector of sampled data.
|
inline |
Identifier for vector of sampled data.
|
inline |
Establish the value of the bias field.
| [in] | Value | The desired value of the bias field. |
|
inline |
Establish the value of the bias field.
| [in] | Value | The desired value of the bias field. |
|
inline |
Establish the value of the channelGroup field.
| [in] | Value | The desired value of the channelGroup field. |
|
inline |
Establish the value of the channelGroup field.
| [in] | Value | The desired value of the channelGroup field. |
|
inline |
Establish the value of the channelNumber field.
| [in] | Value | The desired value of the channelNumber field. |
|
inline |
Establish the value of the channelNumber field.
| [in] | Value | The desired value of the channelNumber field. |
|
inline |
Set the comment associated with the FrAdcData structure.
| [in] | Value | The desired value for the comment field. |
|
inline |
Set the comment associated with the FrAdcData structure.
| [in] | Value | The desired value for the comment field. |
|
inline |
Establish the value of the dataValid field.
| [in] | Value | The desired value of the overRange field. |
|
inline |
Establish the value of the dataValid field.
| [in] | Value | The desired value of the overRange field. |
|
inlineprotected |
|
inlineprotected |
|
inline |
Tne number of bits in the A/D output.
|
inline |
Tne number of bits in the A/D output.
|
inline |
Establish the value of the sampleRate field.
| [in] | Value | The desired value of the sampleRate field. |
|
inline |
Establish the value of the sampleRate field.
| [in] | Value | The desired value of the sampleRate field. |
|
inline |
Establish the value of the slope field.
| [in] | Value | The desired value of the slope field. |
|
inline |
Establish the value of the slope field.
| [in] | Value | The desired value of the slope field. |
|
inline |
Establish the value of the timeOffset field.
| [in] | Value | The value for the timeOffset field. |
|
inline |
Establish the value of the timeOffset field.
| [in] | Value | The value for the timeOffset field. |
|
protected |
Identifier for vector for user-provided information; use is generic
|
protected |
DC bias on channel (Units @ ADC counts = 0)
|
protected |
Channel grouping number containing ADC.
|
protected |
Channel nubmer.
|
protected |
Comment.
|
protected |
Identifier for vector of sampled data.
|
protected |
Data valid flag.
|
staticconstexpr |
|
staticconstexpr |
|
staticconstexpr |
|
staticconstexpr |
|
staticconstexpr |
|
staticconstexpr |
|
protected |
fShift is the frequency (in Hz) in the original data that corresponds to 0 Hz in the heterodyned series.
|
staticconstexprprotected |
|
protected |
Channel name – must be unique with the frame.
|
protected |
Number of bits in A/D output.
|
protected |
Phase (in radian) of hetrodyning signal at start of dataset
|
protected |
Data acquisition rate, samples/s.
|
protected |
ADC calibration: input units/ct.
|
protected |
Offset of 1st sample relative to the frame start time.
|
protected |
ADC calibration: input units for slope.