ldas-tools-framecpp 2.7.0
|
#include <FrAdcDataNPS.hh>
Public Member Functions | |
const std::string & | GetName () const |
Return the name associate with the FrAdcData structure. | |
const std::string & | 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. | |
STRING | GetUnits () 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. | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. | |
void | SetDataValid (INT_2U flag) |
Establish the value of the dataValid field. | |
void | SetBias (REAL_4 Value) |
Establish the value of the bias field. | |
void | SetSlope (REAL_4 Value) |
Establish the value of the slope field. | |
void | SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds) |
Establish the value of the timeOffset field. | |
const std::string & | GetName () const |
Return the name associate with the FrAdcData structure. | |
const std::string & | 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. | |
STRING | GetUnits () 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. | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. | |
void | SetDataValid (INT_2U flag) |
Establish the value of the dataValid field. | |
void | SetBias (REAL_4 Value) |
Establish the value of the bias field. | |
void | SetSlope (REAL_4 Value) |
Establish the value of the slope field. | |
void | SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds) |
Establish the value of the timeOffset field. | |
Static Public Attributes | |
static const bias_type | DEFAULT_BIAS |
static const slope_type | DEFAULT_SLOPE |
static const fShift_type | DEFAULT_FSHIFT |
static const timeOffsetS_type | DEFAULT_TIME_OFFSET_S |
static const timeOffsetN_type | DEFAULT_TIME_OFFSET_N |
static const dataValid_type | DEFAULT_DATA_VALID |
Protected Member Functions | |
FrAdcDataNPS () | |
Default constructor. | |
FrAdcDataNPS (Common::IStream &Stream) | |
Stream constructor. | |
FrAdcDataNPS (const Previous::FrAdcData &Source, Common::IStream *Stream) | |
Promotion constructor. | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. | |
FrAdcDataNPS () | |
Default constructor. | |
FrAdcDataNPS (Common::IStream &Stream) | |
Stream constructor. | |
FrAdcDataNPS (const Previous::FrAdcData &Source, Common::IStream *Stream) | |
Promotion constructor. | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. | |
Static Protected Member Functions | |
template<typename DescriptionType , typename FrSEType > | |
static void | structDescription (DescriptionType &Desc) |
template<typename DescriptionType , typename FrSEType > | |
static void | structDescription (DescriptionType &Desc) |
|
protected |
Default constructor.
|
protected |
Stream constructor.
|
protected |
Promotion constructor.
|
protected |
Default constructor.
|
protected |
Stream constructor.
|
protected |
Promotion constructor.
|
inline |
Extend the comment associated with the FrAdcData structure.
void FrameCPP::Version_4::FrAdcDataNPS::AppendComment | ( | const std::string & | comment | ) |
Extend the comment associated with the FrAdcData structure.
|
inlineprotected |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
protected |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inline |
DC bias on channel.
bias_type FrameCPP::Version_4::FrAdcDataNPS::GetBias | ( | ) | const |
DC bias on channel.
|
inline |
channelGroup_type FrameCPP::Version_4::FrAdcDataNPS::GetChannelGroup | ( | ) | const |
|
inline |
channelNumber_type FrameCPP::Version_4::FrAdcDataNPS::GetChannelNumber | ( | ) | const |
|
inline |
const std::string & FrameCPP::Version_4::FrAdcDataNPS::GetComment | ( | ) | const |
|
inline |
Retrieve the overRange value.
dataValid_type FrameCPP::Version_4::FrAdcDataNPS::GetDataValid | ( | ) | const |
Retrieve the overRange value.
|
inline |
The frequency in the original data corresponding to 0 Hz.
fShift_type FrameCPP::Version_4::FrAdcDataNPS::GetFShift | ( | ) | const |
The frequency in the original data corresponding to 0 Hz.
const std::string & FrAdcDataNPS::GetName | ( | ) | const |
const std::string & FrameCPP::Version_4::FrAdcDataNPS::GetName | ( | ) | const |
|
inline |
Tne number of bits in the A/D output.
nBits_type FrameCPP::Version_4::FrAdcDataNPS::GetNBits | ( | ) | const |
Tne number of bits in the A/D output.
|
inline |
The data acquisition rate.
sampleRate_type FrameCPP::Version_4::FrAdcDataNPS::GetSampleRate | ( | ) | const |
The data acquisition rate.
|
inline |
ADC calibration units per count.
slope_type FrameCPP::Version_4::FrAdcDataNPS::GetSlope | ( | ) | const |
ADC calibration units per count.
|
inline |
The offset of the first sample relative to the frame start time.
timeOffsetN_type FrameCPP::Version_4::FrAdcDataNPS::GetTimeOffsetN | ( | ) | const |
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.
timeOffsetS_type FrameCPP::Version_4::FrAdcDataNPS::GetTimeOffsetS | ( | ) | const |
The offset of the first sample relative to the frame start time.
|
inline |
The units used in the ADC calibration.
STRING FrameCPP::Version_4::FrAdcDataNPS::GetUnits | ( | ) | const |
The units used in the ADC calibration.
|
inlineprotected |
Comparison operator.
|
protected |
Comparison operator.
|
inline |
Establish the value of the bias field.
[in] | Value | The desired value of the bias field. |
void FrameCPP::Version_4::FrAdcDataNPS::SetBias | ( | REAL_4 | Value | ) |
Establish the value of the bias field.
[in] | Value | The desired value of the bias field. |
|
inline |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
void FrameCPP::Version_4::FrAdcDataNPS::SetDataValid | ( | INT_2U | flag | ) |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
|
inline |
Establish the value of the slope field.
[in] | Value | The desired value of the slope field. |
void FrameCPP::Version_4::FrAdcDataNPS::SetSlope | ( | REAL_4 | Value | ) |
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] | Seconds | The value for the timeOffsetS field. |
[in] | Nanoseconds | The value for the timeOffsetN field. |
void FrameCPP::Version_4::FrAdcDataNPS::SetTimeOffset | ( | INT_4U | Seconds, |
INT_4U | Nanoseconds | ||
) |
Establish the value of the timeOffset field.
[in] | Seconds | The value for the timeOffsetS field. |
[in] | Nanoseconds | The value for the timeOffsetN field. |
|
inlinestaticprotected |
|
staticprotected |
|
protected |
Write contents to the stream.
|
protected |
Write contents to the stream.
|
protected |
DC bias on channel (Units @ ADC counts = 0)
|
protected |
Channel grouping number containing ADC.
|
protected |
Channel number
|
protected |
Comment for the ADC.
|
protected |
Data valid flag
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
protected |
The frequency (in HZ) in the original data that corresponds to zero Hz in the heterodyned series.
|
protected |
Channel name – must be unique with the frame
|
protected |
Number of bits in A/D output.
|
protected |
Data acquisition rate, samples per second.
|
protected |
ADC calibration: input units/count.
|
protected |
For Triggered data lasting less than one frame, integer residual nanoseconds start time relative to frame start
|
protected |
For Triggered data lasting less than one frame, integer seconds start time relative to frame start
|
protected |
ADC calibration: input units for slope If dimensionless, then units == <NONE>, in CAPITALS (without <...>).