ldas-tools-framecpp 2.8.1
|
#include <FrAdcDataNPS.hh>
Public Member Functions | |
const std::string & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const std::string & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
channelGroup_type | GetChannelGroup () const |
The channel group for the FrAdcData. More... | |
channelNumber_type | GetChannelNumber () const |
The channel 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... | |
const units_type & | GetUnits () const |
The units used in the ADC calibration. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
timeOffset_type | GetTimeOffset () 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... | |
phase_type | GetPhase () const |
Phase of hetrodyning signal at start of dataset. More... | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. More... | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. More... | |
void | SetDataValid (dataValid_type flag) |
Establish the value of the dataValid field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetChannelGroup (channelGroup_type Value) |
Establish the value of the channelGroup field. More... | |
void | SetChannelNumber (channelNumber_type Value) |
Establish the value of the channelNumber field. More... | |
void | SetComment (const comment_type &Value) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetNBits (nBits_type Value) |
Tne number of bits in the A/D output. More... | |
void | SetSampleRate (sampleRate_type Value) |
Establish the value of the sampleRate field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetTimeOffset (timeOffset_type Value) |
Establish the value of the timeOffset field. More... | |
const std::string & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const std::string & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
channelGroup_type | GetChannelGroup () const |
The channel group for the FrAdcData. More... | |
channelNumber_type | GetChannelNumber () const |
The channel 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... | |
const units_type & | GetUnits () const |
The units used in the ADC calibration. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
timeOffset_type | GetTimeOffset () 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... | |
phase_type | GetPhase () const |
Phase of hetrodyning signal at start of dataset. More... | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. More... | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. More... | |
void | SetDataValid (dataValid_type flag) |
Establish the value of the dataValid field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetChannelGroup (channelGroup_type Value) |
Establish the value of the channelGroup field. More... | |
void | SetChannelNumber (channelNumber_type Value) |
Establish the value of the channelNumber field. More... | |
void | SetComment (const comment_type &Value) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetNBits (nBits_type Value) |
Tne number of bits in the A/D output. More... | |
void | SetSampleRate (sampleRate_type Value) |
Establish the value of the sampleRate field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetTimeOffset (timeOffset_type Value) |
Establish the value of the timeOffset field. More... | |
const std::string & | GetName () const |
Return the name associate with the FrAdcData structure. More... | |
const std::string & | GetComment () const |
A brief description of the FrAdcData structure. More... | |
channelGroup_type | GetChannelGroup () const |
The channel group for the FrAdcData. More... | |
channelNumber_type | GetChannelNumber () const |
The channel 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... | |
const units_type & | GetUnits () const |
The units used in the ADC calibration. More... | |
sampleRate_type | GetSampleRate () const |
The data acquisition rate. More... | |
timeOffset_type | GetTimeOffset () 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... | |
phase_type | GetPhase () const |
Phase of hetrodyning signal at start of dataset. More... | |
dataValid_type | GetDataValid () const |
Retrieve the overRange value. More... | |
void | AppendComment (const std::string &comment) |
Extend the comment associated with the FrAdcData structure. More... | |
void | SetDataValid (dataValid_type flag) |
Establish the value of the dataValid field. More... | |
void | SetBias (bias_type bias) |
Establish the value of the bias field. More... | |
void | SetChannelGroup (channelGroup_type Value) |
Establish the value of the channelGroup field. More... | |
void | SetChannelNumber (channelNumber_type Value) |
Establish the value of the channelNumber field. More... | |
void | SetComment (const comment_type &Value) |
Set the comment associated with the FrAdcData structure. More... | |
void | SetNBits (nBits_type Value) |
Tne number of bits in the A/D output. More... | |
void | SetSampleRate (sampleRate_type Value) |
Establish the value of the sampleRate field. More... | |
void | SetSlope (slope_type slope) |
Establish the value of the slope field. More... | |
void | SetTimeOffset (timeOffset_type Value) |
Establish the value of the timeOffset field. More... | |
Static Public Member Functions | |
static units_type | DEFAULT_UNITS () |
static units_type | DEFAULT_UNITS () |
static units_type | DEFAULT_UNITS () |
Static Public Attributes | |
static const bias_type | DEFAULT_BIAS |
static const slope_type | DEFAULT_SLOPE |
static const fShift_type | DEFAULT_FSHIFT |
static const timeOffset_type | DEFAULT_TIME_OFFSET |
static const phase_type | DEFAULT_PHASE |
static const dataValid_type | DEFAULT_DATA_VALID |
Protected Member Functions | |
FrAdcDataNPS () | |
Default constructor. More... | |
FrAdcDataNPS (Common::IStream &Stream) | |
Stream constructor. More... | |
FrAdcDataNPS (const FrAdcDataNPS &Source, Common::IStream *Stream) | |
Promotion constructor. More... | |
FrAdcDataNPS (const Previous::FrAdcData &Source, Common::IStream *Stream) | |
Stream copy constructor. More... | |
FrAdcDataNPS (const name_type &Name, channelGroup_type Group, channelNumber_type Channel, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias, slope_type Slope, const units_type &Units, fShift_type FShift, timeOffset_type TimeOffset, dataValid_type DataValid, phase_type Phase) | |
Constructor. More... | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
void | copyCore (const FrAdcDataNPS &Source) |
void | incrementTimeOffset (timeOffset_type Value) |
Increment the time offset by the specified value. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. More... | |
void | setName (const std::string &Name) |
FrAdcDataNPS () | |
Default constructor. More... | |
FrAdcDataNPS (Common::IStream &Stream) | |
Stream constructor. More... | |
FrAdcDataNPS (const FrAdcDataNPS &Source, Common::IStream *Stream) | |
Promotion constructor. More... | |
FrAdcDataNPS (const Previous::FrAdcData &Source, Common::IStream *Stream) | |
Stream copy constructor. More... | |
FrAdcDataNPS (const name_type &Name, channelGroup_type Group, channelNumber_type Channel, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias, slope_type Slope, const units_type &Units, fShift_type FShift, timeOffset_type TimeOffset, dataValid_type DataValid, phase_type Phase) | |
Constructor. More... | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
void | copyCore (const FrAdcDataNPS &Source) |
void | incrementTimeOffset (timeOffset_type Value) |
Increment the time offset by the specified value. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. More... | |
void | setName (const std::string &Name) |
FrAdcDataNPS () | |
Default constructor. More... | |
FrAdcDataNPS (Common::IStream &Stream) | |
Stream constructor. More... | |
FrAdcDataNPS (const FrAdcDataNPS &Source, Common::IStream *Stream) | |
Promotion constructor. More... | |
FrAdcDataNPS (const Previous::FrAdcData &Source, Common::IStream *Stream) | |
Stream copy constructor. More... | |
FrAdcDataNPS (const name_type &Name, channelGroup_type Group, channelNumber_type Channel, nBits_type NBits, sampleRate_type SampleRate, bias_type Bias, slope_type Slope, const units_type &Units, fShift_type FShift, timeOffset_type TimeOffset, dataValid_type DataValid, phase_type Phase) | |
Constructor. More... | |
cmn_streamsize_type | bytes (const Common::StreamBase &Stream) const |
Number of bytes needed to write this structure. More... | |
void | copyCore (const FrAdcDataNPS &Source) |
void | incrementTimeOffset (timeOffset_type Value) |
Increment the time offset by the specified value. More... | |
void | write (Common::OStream &Stream) const |
Write contents to the stream. More... | |
bool | operator== (const FrAdcDataNPS &RHS) const |
Comparison operator. More... | |
void | setName (const std::string &Name) |
Static Protected Member Functions | |
template<typename DescriptionType , typename FrSEType > | |
static void | structDescription (DescriptionType &Desc) |
template<typename DescriptionType , typename FrSEType > | |
static void | structDescription (DescriptionType &Desc) |
template<typename DescriptionType , typename FrSEType > | |
static void | structDescription (DescriptionType &Desc) |
|
inlineprotected |
Default constructor.
|
protected |
Stream constructor.
|
inlineprotected |
Promotion constructor.
|
inlineprotected |
Stream copy constructor.
|
inlineprotected |
Constructor.
|
protected |
Default constructor.
|
protected |
Stream constructor.
|
protected |
Promotion constructor.
|
protected |
Stream copy constructor.
|
protected |
Constructor.
|
protected |
Default constructor.
|
protected |
Stream constructor.
|
protected |
Promotion constructor.
|
protected |
Stream copy constructor.
|
protected |
Constructor.
|
inline |
Extend the comment associated with the FrAdcData structure.
void FrameCPP::Version_6::FrAdcDataNPS::AppendComment | ( | const std::string & | comment | ) |
Extend the comment associated with the FrAdcData structure.
void FrameCPP::Version_6::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. |
|
protected |
Number of bytes needed to write this structure.
[in] | Stream | The stream from which to the object is being read or written. |
|
inlineprotected |
|
protected |
|
protected |
|
inlinestatic |
|
static |
|
static |
|
inline |
DC bias on channel.
bias_type FrameCPP::Version_6::FrAdcDataNPS::GetBias | ( | ) | const |
DC bias on channel.
bias_type FrameCPP::Version_6::FrAdcDataNPS::GetBias | ( | ) | const |
DC bias on channel.
|
inline |
channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup | ( | ) | const |
channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup | ( | ) | const |
|
inline |
channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber | ( | ) | const |
channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber | ( | ) | const |
|
inline |
const std::string & FrameCPP::Version_6::FrAdcDataNPS::GetComment | ( | ) | const |
const std::string & FrameCPP::Version_6::FrAdcDataNPS::GetComment | ( | ) | const |
|
inline |
Retrieve the overRange value.
dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid | ( | ) | const |
Retrieve the overRange value.
dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid | ( | ) | const |
Retrieve the overRange value.
|
inline |
The frequency in the original data corresponding to 0 Hz.
fShift_type FrameCPP::Version_6::FrAdcDataNPS::GetFShift | ( | ) | const |
The frequency in the original data corresponding to 0 Hz.
fShift_type FrameCPP::Version_6::FrAdcDataNPS::GetFShift | ( | ) | const |
The frequency in the original data corresponding to 0 Hz.
|
inline |
const std::string & FrameCPP::Version_6::FrAdcDataNPS::GetName | ( | ) | const |
const std::string & FrameCPP::Version_6::FrAdcDataNPS::GetName | ( | ) | const |
|
inline |
Tne number of bits in the A/D output.
nBits_type FrameCPP::Version_6::FrAdcDataNPS::GetNBits | ( | ) | const |
Tne number of bits in the A/D output.
nBits_type FrameCPP::Version_6::FrAdcDataNPS::GetNBits | ( | ) | const |
Tne number of bits in the A/D output.
|
inline |
Phase of hetrodyning signal at start of dataset.
phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase | ( | ) | const |
Phase of hetrodyning signal at start of dataset.
phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase | ( | ) | const |
Phase of hetrodyning signal at start of dataset.
|
inline |
The data acquisition rate.
sampleRate_type FrameCPP::Version_6::FrAdcDataNPS::GetSampleRate | ( | ) | const |
The data acquisition rate.
sampleRate_type FrameCPP::Version_6::FrAdcDataNPS::GetSampleRate | ( | ) | const |
The data acquisition rate.
|
inline |
ADC calibration units per count.
slope_type FrameCPP::Version_6::FrAdcDataNPS::GetSlope | ( | ) | const |
ADC calibration units per count.
slope_type FrameCPP::Version_6::FrAdcDataNPS::GetSlope | ( | ) | const |
ADC calibration units per count.
|
inline |
The offset of the first sample relative to the frame start time.
timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::GetTimeOffset | ( | ) | const |
The offset of the first sample relative to the frame start time.
timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::GetUnits | ( | ) | const |
The units used in the ADC calibration.
const units_type & FrameCPP::Version_6::FrAdcDataNPS::GetUnits | ( | ) | const |
The units used in the ADC calibration.
|
inlineprotected |
Increment the time offset by the specified value.
[in] | Value | The amount of time by which to adjust the timeOffset value. |
|
protected |
Increment the time offset by the specified value.
[in] | Value | The amount of time by which to adjust the timeOffset value. |
|
protected |
Increment the time offset by the specified value.
[in] | Value | The amount of time by which to adjust the timeOffset value. |
|
inlineprotected |
Comparison operator.
|
protected |
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_6::FrAdcDataNPS::SetBias | ( | bias_type | bias | ) |
Establish the value of the bias field.
[in] | bias | The desired value of the bias field. |
void FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::SetChannelGroup | ( | channelGroup_type | Value | ) |
Establish the value of the channelGroup field.
[in] | Value | The desired value of the channelGroup field. |
void FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::SetChannelNumber | ( | channelNumber_type | Value | ) |
Establish the value of the channelNumber field.
[in] | Value | The desired value of the channelNumber field. |
void FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::SetComment | ( | const comment_type & | Value | ) |
Set the comment associated with the FrAdcData structure.
[in] | Value | The desired value for the comment field. |
void FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::SetDataValid | ( | dataValid_type | flag | ) |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
void FrameCPP::Version_6::FrAdcDataNPS::SetDataValid | ( | dataValid_type | flag | ) |
Establish the value of the dataValid field.
[in] | flag | The desired value of the overRange field. |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inline |
Tne number of bits in the A/D output.
void FrameCPP::Version_6::FrAdcDataNPS::SetNBits | ( | nBits_type | Value | ) |
Tne number of bits in the A/D output.
void FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::SetSampleRate | ( | sampleRate_type | Value | ) |
Establish the value of the sampleRate field.
[in] | Value | The desired value of the sampleRate field. |
void FrameCPP::Version_6::FrAdcDataNPS::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_6::FrAdcDataNPS::SetSlope | ( | slope_type | slope | ) |
Establish the value of the slope field.
[in] | slope | The desired value of the slope field. |
void FrameCPP::Version_6::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.
[in] | Value | The value for the timeOffset field. |
void FrameCPP::Version_6::FrAdcDataNPS::SetTimeOffset | ( | timeOffset_type | Value | ) |
Establish the value of the timeOffset field.
[in] | Value | The value for the timeOffset field. |
void FrameCPP::Version_6::FrAdcDataNPS::SetTimeOffset | ( | timeOffset_type | Value | ) |
Establish the value of the timeOffset field.
[in] | Value | The value for the timeOffset field. |
|
inlinestaticprotected |
|
staticprotected |
|
staticprotected |
|
protected |
Write contents to the stream.
|
protected |
Write contents to the stream.
|
protected |
Write contents to the stream.
|
private |
DC bias on channel (Units @ ADC counts = 0)
|
private |
Channel grouping number containing ADC.
|
private |
Channel number
|
private |
Comment for the ADC.
|
private |
Data valid flag
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
|
private |
The frequency (in HZ) in the original data that corresponds to zero Hz in the heterodyned series.
|
private |
Channel name – must be unique with the frame
|
private |
Number of bits in A/D output.
|
private |
Phase (in radian) of heterodyning signal at start of dataset.
|
private |
Data acquisition rate, samples per second.
|
private |
ADC calibration: input units/count.
|
private |
Offfset of 1st sample relative to the frame start time.
|
private |
ADC calibration: input units for slope If dimensionless, then units == <NONE>, in CAPITALS (without <...>).