Loading...
Searching...
No Matches
FrameCPP::Version_8::FrAdcDataImpl::Data Class Reference
#include <FrAdcDataData.hh>
Inheritance diagram for FrameCPP::Version_8::FrAdcDataImpl::Data:
Collaboration diagram for FrameCPP::Version_8::FrAdcDataImpl::Data:
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 } |
Member Typedef Documentation
◆ aux_iterator [1/2]
◆ aux_iterator [2/2]
◆ aux_type [1/2]
◆ aux_type [2/2]
◆ bias_type [1/2]
◆ bias_type [2/2]
◆ channel_v3_type
|
inherited |
◆ channelGroup_type [1/2]
◆ channelGroup_type [2/2]
◆ channelNumber_type [1/2]
| typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_8::FrAdcDataImpl::Data::channelNumber_type |
◆ channelNumber_type [2/2]
| typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_8::FrAdcDataImpl::Data::channelNumber_type |
◆ comment_type [1/2]
◆ comment_type [2/2]
◆ const_aux_iterator [1/2]
◆ const_aux_iterator [2/2]
◆ const_iterator [1/2]
◆ const_iterator [2/2]
◆ crate_v3_type
|
inherited |
◆ data_type [1/2]
◆ data_type [2/2]
◆ dataValid_type [1/2]
◆ dataValid_type [2/2]
◆ fShift_type [1/2]
◆ fShift_type [2/2]
◆ iterator [1/2]
◆ iterator [2/2]
◆ name_type [1/2]
◆ name_type [2/2]
◆ nBits_type [1/2]
◆ nBits_type [2/2]
◆ overRange_v3_type
|
inherited |
◆ phase_type [1/2]
◆ phase_type [2/2]
◆ sampleRate_type [1/2]
◆ sampleRate_type [2/2]
◆ slope_type [1/2]
◆ slope_type [2/2]
◆ struct_desc_type [1/2]
template<typename Object_T>
|
inherited |
◆ struct_desc_type [2/2]
template<typename Object_T>
|
inherited |
◆ struct_id_type [1/2]
template<typename Object_T>
|
inherited |
◆ struct_id_type [2/2]
template<typename Object_T>
|
inherited |
◆ struct_name_type [1/2]
template<typename Object_T>
|
inherited |
◆ struct_name_type [2/2]
template<typename Object_T>
|
inherited |
◆ timeOffset_type [1/2]
◆ timeOffset_type [2/2]
◆ timeOffsetN_v3_type
|
inherited |
◆ timeOffsetS_v3_type
|
inherited |
◆ timeOffsetS_v4_type
|
inherited |
◆ units_type [1/2]
◆ units_type [2/2]
Member Function Documentation
◆ AppendComment() [1/2]
|
inline |
Extend the comment associated with the FrAdcData structure.
◆ AppendComment() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::AppendComment | ( | const std::string & | comment | ) |
Extend the comment associated with the FrAdcData structure.
◆ DEFAULT_UNITS() [1/2]
|
inlinestatic |
◆ DEFAULT_UNITS() [2/2]
|
static |
◆ FrameSpecDescription() [1/2]
template<typename Object_T>
|
inlinestaticinherited |
Return the dictionary name of the structure.
◆ FrameSpecDescription() [2/2]
template<typename Object_T>
|
inlinestaticinherited |
Return the dictionary name of the structure.
◆ FrameSpecId() [1/2]
template<typename Object_T>
|
inlinestaticinherited |
Return the dictionary name of the structure.
◆ FrameSpecId() [2/2]
template<typename Object_T>
|
inlinestaticinherited |
Return the dictionary name of the structure.
◆ FrameSpecName() [1/2]
template<typename Object_T>
|
inlinestaticinherited |
◆ FrameSpecName() [2/2]
template<typename Object_T>
|
inlinestaticinherited |
◆ GetBias() [1/2]
|
inline |
DC bias on channel.
- Returns
- DC bias on channel.
◆ GetBias() [2/2]
| bias_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetBias | ( | ) | const |
DC bias on channel.
- Returns
- DC bias on channel.
◆ GetChannelGroup() [1/2]
|
inline |
◆ GetChannelGroup() [2/2]
| channelGroup_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelGroup | ( | ) | const |
◆ GetChannelNumber() [1/2]
|
inline |
◆ GetChannelNumber() [2/2]
| channelNumber_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetChannelNumber | ( | ) | const |
◆ GetComment() [1/2]
|
inline |
◆ GetComment() [2/2]
| const comment_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetComment | ( | ) | const |
◆ GetDataValid() [1/2]
|
inline |
Retrieve the overRange value.
- Returns
- The value of the overRange field.
◆ GetDataValid() [2/2]
| dataValid_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetDataValid | ( | ) | const |
Retrieve the overRange value.
- Returns
- The value of the overRange field.
◆ GetFShift() [1/2]
|
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]
| 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/2]
|
inline |
◆ GetName() [2/2]
| const name_type & FrameCPP::Version_8::FrAdcDataImpl::Data::GetName | ( | ) | const |
◆ GetNBits() [1/2]
|
inline |
Tne number of bits in the A/D output.
- Returns
- Tne number of bits in the A/D output.
◆ GetNBits() [2/2]
| 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/2]
|
inline |
Phase of hetrodyning signal at start of dataset.
- Returns
- The Phase (in radians) of hetrodyning signal at start of dataset.
◆ GetPhase() [2/2]
| 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/2]
|
inline |
The data acquisition rate.
- Returns
- The data acquisition rate.
◆ GetSampleRate() [2/2]
| sampleRate_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSampleRate | ( | ) | const |
The data acquisition rate.
- Returns
- The data acquisition rate.
◆ GetSlope() [1/2]
|
inline |
ADC calibration units per count.
- Returns
- ADC calibration units per count.
◆ GetSlope() [2/2]
| slope_type FrameCPP::Version_8::FrAdcDataImpl::Data::GetSlope | ( | ) | const |
ADC calibration units per count.
- Returns
- ADC calibration units per count.
◆ GetTimeOffset() [1/2]
|
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/2]
| 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/2]
|
inline |
The units used in the ADC calibration.
- Returns
- The units used in the ADC calibration
◆ GetUnits() [2/2]
| 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/2]
|
inlineprotected |
◆ incrementTimeOffset() [2/2]
|
protected |
◆ operator==() [1/3]
|
inlineinherited |
◆ operator==() [2/3]
|
inline |
◆ operator==() [3/3]
| bool FrameCPP::Version_8::FrAdcDataImpl::Data::operator== | ( | Data const & | RHS | ) | const |
◆ RefAux() [1/4]
|
inline |
Identifier for vector for user-provided information.
- Returns
- A reference to the user-provided information.
◆ RefAux() [2/4]
| 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/4]
|
inline |
Identifier for vector for user-provided information.
- Returns
- A constant reference to the user-provided information.
◆ RefAux() [4/4]
| 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/4]
|
inline |
Identifier for vector of sampled data.
- Returns
- A reference to the sampled data.
◆ RefData() [2/4]
| data_type & FrameCPP::Version_8::FrAdcDataImpl::Data::RefData | ( | ) |
Identifier for vector of sampled data.
- Returns
- A reference to the sampled data.
◆ RefData() [3/4]
|
inline |
Identifier for vector of sampled data.
- Returns
- A constant reference to the sampled data.
◆ RefData() [4/4]
| 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/2]
|
inline |
Establish the value of the bias field.
- Parameters
-
[in] bias The desired value of the bias field.
◆ SetBias() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetBias | ( | bias_type | bias | ) |
Establish the value of the bias field.
- Parameters
-
[in] bias The desired value of the bias field.
◆ SetChannelGroup() [1/2]
|
inline |
Establish the value of the channelGroup field.
- Parameters
-
[in] Value The desired value of the channelGroup field.
◆ SetChannelGroup() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelGroup | ( | channelGroup_type | Value | ) |
Establish the value of the channelGroup field.
- Parameters
-
[in] Value The desired value of the channelGroup field.
◆ SetChannelNumber() [1/2]
|
inline |
Establish the value of the channelNumber field.
- Parameters
-
[in] Value The desired value of the channelNumber field.
◆ SetChannelNumber() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetChannelNumber | ( | channelNumber_type | Value | ) |
Establish the value of the channelNumber field.
- Parameters
-
[in] Value The desired value of the channelNumber field.
◆ SetComment() [1/2]
|
inline |
Set the comment associated with the FrAdcData structure.
- Parameters
-
[in] Value The desired value for the comment field.
◆ SetComment() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetComment | ( | const comment_type & | Value | ) |
Set the comment associated with the FrAdcData structure.
- Parameters
-
[in] Value The desired value for the comment field.
◆ SetDataValid() [1/2]
|
inline |
Establish the value of the dataValid field.
- Parameters
-
[in] flag The desired value of the overRange field.
◆ SetDataValid() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetDataValid | ( | dataValid_type | flag | ) |
Establish the value of the dataValid field.
- Parameters
-
[in] flag The desired value of the overRange field.
◆ setName() [1/2]
|
inlineprotected |
◆ setName() [2/2]
|
protected |
◆ SetNBits() [1/2]
|
inline |
Tne number of bits in the A/D output.
- Returns
- Tne number of bits in the A/D output.
◆ SetNBits() [2/2]
| 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/2]
|
inline |
Establish the value of the sampleRate field.
- Parameters
-
[in] Value The desired value of the sampleRate field.
◆ SetSampleRate() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSampleRate | ( | sampleRate_type | Value | ) |
Establish the value of the sampleRate field.
- Parameters
-
[in] Value The desired value of the sampleRate field.
◆ SetSlope() [1/2]
|
inline |
Establish the value of the slope field.
- Parameters
-
[in] slope The desired value of the slope field.
◆ SetSlope() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetSlope | ( | slope_type | slope | ) |
Establish the value of the slope field.
- Parameters
-
[in] slope The desired value of the slope field.
◆ SetTimeOffset() [1/2]
|
inline |
Establish the value of the timeOffset field.
- Parameters
-
[in] Value The value for the timeOffset field.
◆ SetTimeOffset() [2/2]
| void FrameCPP::Version_8::FrAdcDataImpl::Data::SetTimeOffset | ( | timeOffset_type | Value | ) |
Establish the value of the timeOffset field.
- Parameters
-
[in] Value The value for the timeOffset field.
◆ StructName() [1/2]
template<typename Object_T>
|
inlinestaticinherited |
◆ StructName() [2/2]
template<typename Object_T>
|
inlinestaticinherited |
Member Data Documentation
◆ aux
|
protected |
Identifier for vector for user-provided information; use is generic
◆ bias
|
protected |
DC bias on channel (Units @ ADC counts = 0).
◆ channelGroup
|
protected |
Channel grouping number containing ADC.
◆ channelNumber
|
protected |
Channel nubmer.
◆ comment
|
protected |
Comment.
◆ data
|
protected |
Identifier for vector of sampled data.
◆ dataValid
|
protected |
Data valid flag.
◆ DEFAULT_BIAS
|
staticconstexpr |
◆ DEFAULT_DATA_VALID
|
staticconstexpr |
◆ DEFAULT_FSHIFT
|
staticconstexpr |
◆ DEFAULT_PHASE
|
staticconstexpr |
◆ DEFAULT_SLOPE
|
staticconstexpr |
◆ DEFAULT_TIME_OFFSET
|
staticconstexpr |
◆ fShift
|
protected |
fShift is the frequency (in Hz) in the original data that corresponds to 0 Hz in the heterodyned series.
◆ MAX_REF
|
staticconstexprprotected |
◆ name
|
protected |
Channel name – must be unique with the frame.
◆ nBits
|
protected |
Number of bits in A/D output.
◆ phase
|
protected |
Phase (in radian) of hetrodyning signal at start of dataset
◆ sampleRate
|
protected |
Data acquisition rate, samples/s.
◆ slope
|
protected |
ADC calibration: input units/ct.
◆ struct_desc
template<typename Object_T>
|
staticinherited |
◆ struct_id
template<typename Object_T>
|
staticinherited |
◆ struct_name
template<typename Object_T>
|
staticinherited |
◆ timeOffset
|
protected |
Offset of 1st sample relative to the frame start time.
◆ units
|
protected |
ADC calibration: input units for slope.
The documentation for this class was generated from the following files:
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version8/impl/FrAdcDataData.hh
- /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version8/impl/FrAdcDataData.hh
