ldas-tools-framecpp 3.0.4
|
#include <FrAdcDataData.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 flag) |
Establish the value of the dataValid field. | |
void | SetBias (bias_type bias) |
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 slope) |
Establish the value of the slope field. | |
void | SetTimeOffset (timeOffset_type Value) |
Establish the value of the timeOffset field. | |
bool | operator== (Data 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 flag) |
Establish the value of the dataValid field. | |
void | SetBias (bias_type bias) |
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 slope) |
Establish the value of the slope field. | |
void | SetTimeOffset (timeOffset_type Value) |
Establish the value of the timeOffset field. | |
bool | operator== (Data const &RHS) const |
bool | operator== (FrAdcData const &RHS) const |
Static Public Member Functions | |
static const units_type & | DEFAULT_UNITS () |
static const units_type & | DEFAULT_UNITS () |
static struct_name_type | FrameSpecName () |
static struct_name_type | FrameSpecName () |
static struct_name_type | StructName () |
static struct_name_type | StructName () |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_desc_type | FrameSpecDescription () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. | |
static struct_id_type | FrameSpecId () |
Return the dictionary name of the structure. | |
Static Public Attributes | |
static constexpr 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) |
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 { DEFAULT_BIAS } |
DC bias on channel (Units @ ADC counts = 0) | |
slope_type | slope { DEFAULT_SLOPE } |
ADC calibration: input units/ct. | |
units_type | units { DEFAULT_UNITS( ) } |
ADC calibration: input units for slope. | |
sampleRate_type | sampleRate |
Data acquisition rate, samples/s. | |
timeOffset_type | timeOffset { DEFAULT_TIME_OFFSET } |
Offset of 1st sample relative to the frame start time. | |
fShift_type | fShift { DEFAULT_FSHIFT } |
phase_type | phase { DEFAULT_PHASE } |
dataValid_type | dataValid { DEFAULT_DATA_VALID } |
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 } |
|
inherited |
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_8::FrAdcDataImpl::Data::channelNumber_type |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
|
inline |
Extend the comment associated with the FrAdcData structure.
void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment | ( | const std::string & | comment | ) |
Extend the comment associated with the FrAdcData structure.
|
inlinestatic |
|
static |
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
Return the dictionary name of the structure.
|
inlinestaticinherited |
|
inlinestaticinherited |
|
inline |
DC bias on channel.
bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias | ( | ) | const |
DC bias on channel.
|
inline |
channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup | ( | ) | const |
|
inline |
channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber | ( | ) | const |
|
inline |
const comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment | ( | ) | const |
|
inline |
Retrieve the overRange value.
dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid | ( | ) | const |
Retrieve the overRange value.
|
inline |
The frequency in the original data corresponding to 0 Hz.
fShift_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetFShift | ( | ) | const |
The frequency in the original data corresponding to 0 Hz.
|
inline |
const name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName | ( | ) | const |
|
inline |
Tne number of bits in the A/D output.
nBits_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetNBits | ( | ) | const |
Tne number of bits in the A/D output.
|
inline |
Phase of hetrodyning signal at start of dataset.
phase_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetPhase | ( | ) | const |
Phase of hetrodyning signal at start of dataset.
|
inline |
The data acquisition rate.
sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate | ( | ) | const |
The data acquisition rate.
|
inline |
ADC calibration units per count.
slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope | ( | ) | const |
ADC calibration units per count.
|
inline |
The offset of the first sample relative to the frame start time.
timeOffset_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetTimeOffset | ( | ) | const |
The offset of the first sample relative to the frame start time.
|
inline |
The units used in the ADC calibration.
const units_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetUnits | ( | ) | const |
The units used in the ADC calibration.
|
inlineprotected |
|
protected |
|
inlineinherited |
|
inline |
bool FrameCPP::Version_8::FrAdcDataImpl::Data::operator== | ( | Data const & | RHS | ) | const |
|
inline |
Identifier for vector for user-provided information.
aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux | ( | ) |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector for user-provided information.
const aux_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefAux | ( | ) | const |
Identifier for vector for user-provided information.
|
inline |
Identifier for vector of sampled data.
data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData | ( | ) |
Identifier for vector of sampled data.
|
inline |
Identifier for vector of sampled data.
const data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData | ( | ) | const |
Identifier for vector of sampled data.
|
inline |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias | ( | bias_type | bias | ) |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
|
inline |
Establish the value of the channelGroup field.
[in] | Value | The desired value of the channelGroup field. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup | ( | channelGroup_type | Value | ) |
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. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber | ( | channelNumber_type | Value | ) |
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. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetComment | ( | const comment_type & | Value | ) |
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] | flag | The desired value of the overRange field. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid | ( | dataValid_type | flag | ) |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
|
inlineprotected |
|
protected |
|
inline |
Tne number of bits in the A/D output.
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetNBits | ( | nBits_type | Value | ) |
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. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate | ( | sampleRate_type | Value | ) |
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] | slope | The desired value of the slope field. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope | ( | slope_type | slope | ) |
Establish the value of the slope field.
[in] | slope | The desired value of the slope field. |
|
inline |
Establish the value of the timeOffset field.
[in] | Value | The value for the timeOffset field. |
void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset | ( | timeOffset_type | Value | ) |
Establish the value of the timeOffset field.
[in] | Value | The value for the timeOffset field. |
|
inlinestaticinherited |
|
inlinestaticinherited |
|
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.
|
staticinherited |
|
staticinherited |
|
staticinherited |
|
protected |
Offset of 1st sample relative to the frame start time.
|
protected |
ADC calibration: input units for slope.