ldas-tools-framecpp
2.7.0
|
ADC Data that does not reference a pointer. More...
#include <FrAdcDataNPS.hh>
Public Member Functions | |
void | AppendComment (const comment_type &Comment) |
Extend the comment associated with the FrAdcData structure. More... | |
const name_type & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const comment_type & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
channel_type | GetChannel () const |
The channel number for the FrAdcData. More... | |
crate_type | GetCrate () const |
The crate number for the FrAdcData. More... | |
nBits_type | GetNBits () const |
Tne number of bits in the A/D output. More... | |
bias_type | GetBias () const |
DC bias on channel. More... | |
slope_type | GetSlope () const |
ADC calibration units per count. More... | |
STRING | GetUnits () const |
The units used in the ADC calibration. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
timeOffsetS_type | GetTimeOffsetS () const |
The offset of the first sample relative to the frame start time. More... | |
timeOffsetN_type | GetTimeOffsetN () const |
The offset of the first sample relative to the frame start time. More... | |
fShift_type | GetFShift () const |
The frequency in the original data corresponding to 0 Hz. More... | |
overRange_type | GetOverRange () const |
Retrieve the overRange value. More... | |
void | SetCrate (crate_type Value) |
Set the numeric crate id for the channel. More... | |
void | SetChannel (channel_type Value) |
Set the numeric id for the channel. More... | |
void | SetComment (const comment_type &comment) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetOverRange (overRange_type flag) |
Establish the value of the overRange field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetNBits (nBits_type NBits) |
The number of bits in the A/D output. More... | |
void | SetSampleRate (sampleRate_type SampleRate) |
Establish the value of the sampleRate field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetTimeOffset (timeOffsetS_type Seconds, timeOffsetN_type Nanoseconds) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetS (timeOffsetS_type time) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetN (timeOffsetN_type time) |
Establish the value of the timeOffset field. More... | |
void | AppendComment (const comment_type &Comment) |
Extend the comment associated with the FrAdcData structure. More... | |
const name_type & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const comment_type & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
channel_type | GetChannel () const |
The channel number for the FrAdcData. More... | |
crate_type | GetCrate () const |
The crate number for the FrAdcData. More... | |
nBits_type | GetNBits () const |
Tne number of bits in the A/D output. More... | |
bias_type | GetBias () const |
DC bias on channel. More... | |
slope_type | GetSlope () const |
ADC calibration units per count. More... | |
STRING | GetUnits () const |
The units used in the ADC calibration. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
timeOffsetS_type | GetTimeOffsetS () const |
The offset of the first sample relative to the frame start time. More... | |
timeOffsetN_type | GetTimeOffsetN () const |
The offset of the first sample relative to the frame start time. More... | |
fShift_type | GetFShift () const |
The frequency in the original data corresponding to 0 Hz. More... | |
overRange_type | GetOverRange () const |
Retrieve the overRange value. More... | |
void | SetCrate (crate_type Value) |
Set the numeric crate id for the channel. More... | |
void | SetChannel (channel_type Value) |
Set the numeric id for the channel. More... | |
void | SetComment (const comment_type &comment) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetOverRange (overRange_type flag) |
Establish the value of the overRange field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetNBits (nBits_type NBits) |
The number of bits in the A/D output. More... | |
void | SetSampleRate (sampleRate_type SampleRate) |
Establish the value of the sampleRate field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetTimeOffset (timeOffsetS_type Seconds, timeOffsetN_type Nanoseconds) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetS (timeOffsetS_type time) |
Establish the value of the timeOffset field. More... | |
void | SetTimeOffsetN (timeOffsetN_type time) |
Establish the value of the timeOffset field. More... | |
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 overRange_type | DEFAULT_OVER_RANGE |
Protected Member Functions | |
FrAdcDataNPS () | |
Default constructor. More... | |
FrAdcDataNPS (Common::IStream &Stream) | |
Initialzie the instance from an input stream. More... | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. More... | |
FrAdcDataNPS () | |
Default constructor. More... | |
FrAdcDataNPS (Common::IStream &Stream) | |
Initialzie the instance from an input stream. More... | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. More... | |
ADC Data that does not reference a pointer.
|
protected |
Default constructor.
|
protected |
Initialzie the instance from an input stream.
|
protected |
Default constructor.
|
protected |
Initialzie the instance from an input stream.
|
inline |
Extend the comment associated with the FrAdcData structure.
void FrameCPP::Version_3::FrAdcDataNPS::AppendComment | ( | const comment_type & | 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_3::FrAdcDataNPS::GetBias | ( | ) | const |
DC bias on channel.
|
inline |
channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel | ( | ) | const |
|
inline |
const comment_type& FrameCPP::Version_3::FrAdcDataNPS::GetComment | ( | ) | const |
|
inline |
crate_type FrameCPP::Version_3::FrAdcDataNPS::GetCrate | ( | ) | const |
|
inline |
The frequency in the original data corresponding to 0 Hz.
fShift_type FrameCPP::Version_3::FrAdcDataNPS::GetFShift | ( | ) | const |
The frequency in the original data corresponding to 0 Hz.
|
inline |
const name_type& FrameCPP::Version_3::FrAdcDataNPS::GetName | ( | ) | const |
|
inline |
Tne number of bits in the A/D output.
nBits_type FrameCPP::Version_3::FrAdcDataNPS::GetNBits | ( | ) | const |
Tne number of bits in the A/D output.
|
inline |
Retrieve the overRange value.
overRange_type FrameCPP::Version_3::FrAdcDataNPS::GetOverRange | ( | ) | const |
Retrieve the overRange value.
|
inline |
The data acquisition rate.
sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::GetSampleRate | ( | ) | const |
The data acquisition rate.
|
inline |
ADC calibration units per count.
slope_type FrameCPP::Version_3::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_3::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_3::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_3::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] | bias | The desired value of the bias field. |
void FrameCPP::Version_3::FrAdcDataNPS::SetBias | ( | bias_type | bias | ) |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
|
inline |
Set the numeric id for the channel.
void FrameCPP::Version_3::FrAdcDataNPS::SetChannel | ( | channel_type | Value | ) |
Set the numeric id for the channel.
|
inline |
Set the comment associated with the FrAdcData structure.
void FrameCPP::Version_3::FrAdcDataNPS::SetComment | ( | const comment_type & | comment | ) |
Set the comment associated with the FrAdcData structure.
|
inline |
Set the numeric crate id for the channel.
void FrameCPP::Version_3::FrAdcDataNPS::SetCrate | ( | crate_type | Value | ) |
Set the numeric crate id for the channel.
|
inline |
The number of bits in the A/D output.
[in] | NBits | Tne number of bits in the A/D output. |
void FrameCPP::Version_3::FrAdcDataNPS::SetNBits | ( | nBits_type | NBits | ) |
The number of bits in the A/D output.
[in] | NBits | Tne number of bits in the A/D output. |
|
inline |
Establish the value of the overRange field.
[in] | flag | The desired value of the overRange field. |
void FrameCPP::Version_3::FrAdcDataNPS::SetOverRange | ( | overRange_type | flag | ) |
Establish the value of the overRange field.
[in] | flag | The desired value of the overRange field. |
|
inline |
Establish the value of the sampleRate field.
[in] | SampleRate | The desired value of the sampleRate field. |
void FrameCPP::Version_3::FrAdcDataNPS::SetSampleRate | ( | sampleRate_type | SampleRate | ) |
Establish the value of the sampleRate field.
[in] | SampleRate | 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_3::FrAdcDataNPS::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.
void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffset | ( | timeOffsetS_type | Seconds, |
timeOffsetN_type | Nanoseconds | ||
) |
Establish the value of the timeOffset field.
|
inline |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetN | ( | timeOffsetN_type | time | ) |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
inline |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetS | ( | timeOffsetS_type | time | ) |
Establish the value of the timeOffset field.
[in] | time | The desired value of the timeOffset field. |
|
protected |
Write contents to the stream.
|
protected |
Write contents to the stream.
|
protected |
DC bias on channel (Units @ ADC counts = 0)
|
protected |
Channel number
|
protected |
Comment for the ADC.
|
protected |
Channel grouping number containing ADC.
|
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 valid flag
|
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 <...>).