ldas-tools-framecpp  2.6.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
FrameCPP::Version_3::FrAdcDataNPS Class Reference

ADC Data that does not reference a pointer. More...

#include <FrAdcDataNPS.hh>

Inheritance diagram for FrameCPP::Version_3::FrAdcDataNPS:
FrameCPP::Version_3::FrAdcData

Public Types

typedef STRING name_type
 
typedef STRING comment_type
 
typedef FR_ADC_DATA_CRATE_TYPE crate_type
 
typedef FR_ADC_DATA_CHANNEL_TYPE channel_type
 
typedef FR_ADC_DATA_N_BITS_TYPE nBits_type
 
typedef FR_ADC_DATA_BIAS_TYPE bias_type
 
typedef FR_ADC_DATA_SLOPE_TYPE slope_type
 
typedef STRING units_type
 
typedef FR_ADC_DATA_SAMPLERATE_TYPE sampleRate_type
 
typedef
FR_ADC_DATA_TIMEOFFSETS_TYPE 
timeOffsetS_type
 
typedef
FR_ADC_DATA_TIMEOFFSETN_TYPE 
timeOffsetN_type
 
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
 
typedef FR_ADC_DATA_OVERRANGE_TYPE overRange_type
 

Public Member Functions

void AppendComment (const comment_type &Comment)
 Extend the comment associated with the FrAdcData structure. More...
 
const name_typeGetName () const
 Return the name associate with the FrAdcData structure. More...
 
const comment_typeGetComment () 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 = FR_ADC_DATA_DEFAULT_BIAS
 
static const slope_type DEFAULT_SLOPE = FR_ADC_DATA_DEFAULT_SLOPE
 
static const fShift_type DEFAULT_FSHIFT = FR_ADC_DATA_DEFAULT_FSHIFT
 
static const timeOffsetS_type DEFAULT_TIME_OFFSET_S = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S
 
static const timeOffsetN_type DEFAULT_TIME_OFFSET_N = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N
 
static const overRange_type DEFAULT_OVER_RANGE = FR_ADC_DATA_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...
 

Protected Attributes

name_type name
 Channel name – must be unique with the frame. More...
 
comment_type comment
 Comment for the ADC. More...
 
crate_type crate
 
channel_type channel
 
nBits_type nBits
 Number of bits in A/D output. More...
 
bias_type bias
 DC bias on channel (Units @ ADC counts = 0) More...
 
slope_type slope
 ADC calibration: input units/count. More...
 
units_type units
 
sampleRate_type sampleRate
 Data acquisition rate, samples per second. More...
 
timeOffsetS_type timeOffsetS
 
timeOffsetN_type timeOffsetN
 
fShift_type fShift
 
overRange_type overRange
 

Detailed Description

ADC Data that does not reference a pointer.

Member Typedef Documentation

Constructor & Destructor Documentation

FrAdcDataNPS::FrAdcDataNPS ( )
protected

Default constructor.

FrAdcDataNPS::FrAdcDataNPS ( Common::IStream Stream)
protected

Initialzie the instance from an input stream.

Member Function Documentation

void FrAdcDataNPS::AppendComment ( const comment_type Comment)
inline

Extend the comment associated with the FrAdcData structure.

cmn_streamsize_type FrAdcDataNPS::bytes ( const Common::StreamBase Stream) const
inlineprotected

Number of bytes needed to write this structure.

Parameters
[in]StreamThe stream from which to the object is being read or written.
Returns
The number of bytes need to read or write this object.
FrAdcDataNPS::bias_type FrAdcDataNPS::GetBias ( ) const
inline

DC bias on channel.

Returns
DC bias on channel.
FrAdcDataNPS::channel_type FrAdcDataNPS::GetChannel ( ) const
inline

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData
const FrAdcDataNPS::comment_type & FrAdcDataNPS::GetComment ( ) const
inline

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure
FrAdcDataNPS::crate_type FrAdcDataNPS::GetCrate ( ) const
inline

The crate number for the FrAdcData.

Returns
The crate number for the FrAdcData
FrAdcDataNPS::fShift_type FrAdcDataNPS::GetFShift ( ) const
inline

The frequency in the original data corresponding to 0 Hz.

Returns
The frequency in the original data corresponding to 0 Hz.
const FrAdcDataNPS::name_type & FrAdcDataNPS::GetName ( ) const
inline

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure
FrAdcDataNPS::nBits_type FrAdcDataNPS::GetNBits ( ) const
inline

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.
FrAdcDataNPS::overRange_type FrAdcDataNPS::GetOverRange ( ) const
inline

Retrieve the overRange value.

Returns
The value of the overRange field.
FrAdcDataNPS::sampleRate_type FrAdcDataNPS::GetSampleRate ( ) const
inline

The data acquisition rate.

Returns
The data acquisition rate.
FrAdcDataNPS::slope_type FrAdcDataNPS::GetSlope ( ) const
inline

ADC calibration units per count.

Returns
ADC calibration units per count.
FrAdcDataNPS::timeOffsetN_type FrAdcDataNPS::GetTimeOffsetN ( ) const
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.
FrAdcDataNPS::timeOffsetS_type FrAdcDataNPS::GetTimeOffsetS ( ) const
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.
FrAdcDataNPS::units_type FrAdcDataNPS::GetUnits ( ) const
inline

The units used in the ADC calibration.

Returns
The units used in the ADC calibration
bool FrAdcDataNPS::operator== ( const FrAdcDataNPS RHS) const
inlineprotected

Comparison operator.

void FrAdcDataNPS::SetBias ( bias_type  bias)
inline

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.
void FrAdcDataNPS::SetChannel ( channel_type  Value)
inline

Set the numeric id for the channel.

void FrAdcDataNPS::SetComment ( const comment_type comment)
inline

Set the comment associated with the FrAdcData structure.

void FrAdcDataNPS::SetCrate ( crate_type  Value)
inline

Set the numeric crate id for the channel.

void FrAdcDataNPS::SetNBits ( nBits_type  NBits)
inline

The number of bits in the A/D output.

Parameters
[in]NBitsTne number of bits in the A/D output.
void FrAdcDataNPS::SetOverRange ( overRange_type  flag)
inline

Establish the value of the overRange field.

Parameters
[in]flagThe desired value of the overRange field.
void FrAdcDataNPS::SetSampleRate ( sampleRate_type  SampleRate)
inline

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.
void FrAdcDataNPS::SetSlope ( slope_type  slope)
inline

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.
void FrAdcDataNPS::SetTimeOffset ( timeOffsetS_type  Seconds,
timeOffsetN_type  Nanoseconds 
)
inline

Establish the value of the timeOffset field.

void FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type  time)
inline

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.
void FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type  time)
inline

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.
void FrAdcDataNPS::write ( Common::OStream Stream) const
protected

Write contents to the stream.

Member Data Documentation

bias_type FrameCPP::Version_3::FrAdcDataNPS::bias
protected

DC bias on channel (Units @ ADC counts = 0)

channel_type FrameCPP::Version_3::FrAdcDataNPS::channel
protected

Channel number

Note
This variable is determined by the site and must be unique over all detectors.
comment_type FrameCPP::Version_3::FrAdcDataNPS::comment
protected

Comment for the ADC.

crate_type FrameCPP::Version_3::FrAdcDataNPS::crate
protected

Channel grouping number containing ADC.

Note
This variable is determined by the site and must be unique over all detectors.
const FrAdcDataNPS::bias_type FrAdcDataNPS::DEFAULT_BIAS = FR_ADC_DATA_DEFAULT_BIAS
static
const FrAdcDataNPS::fShift_type FrAdcDataNPS::DEFAULT_FSHIFT = FR_ADC_DATA_DEFAULT_FSHIFT
static
const FrAdcDataNPS::overRange_type FrAdcDataNPS::DEFAULT_OVER_RANGE = FR_ADC_DATA_DEFAULT_OVER_RANGE
static
const FrAdcDataNPS::slope_type FrAdcDataNPS::DEFAULT_SLOPE = FR_ADC_DATA_DEFAULT_SLOPE
static
const FrAdcDataNPS::timeOffsetN_type FrAdcDataNPS::DEFAULT_TIME_OFFSET_N = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N
static
const FrAdcDataNPS::timeOffsetS_type FrAdcDataNPS::DEFAULT_TIME_OFFSET_S = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S
static
fShift_type FrameCPP::Version_3::FrAdcDataNPS::fShift
protected

The frequency (in HZ) in the original data that corresponds to zero Hz in the heterodyned series.

Note
In the heterodyning process the real time series in multiplied by cos[2pi fShift(t-to) + phase] to get the real part and by -sin[2pi fShift(t-t(0)) + phase] to get the imaginary part of the resulting complex time series. The time origin t(0) is the beginning of the frame.
name_type FrameCPP::Version_3::FrAdcDataNPS::name
protected

Channel name – must be unique with the frame.

nBits_type FrameCPP::Version_3::FrAdcDataNPS::nBits
protected

Number of bits in A/D output.

overRange_type FrameCPP::Version_3::FrAdcDataNPS::overRange
protected

Data valid flag

Note
overRange = 0 -> ADC ddata valid; overRange != 0 -> ADC data suspect/not valid
sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::sampleRate
protected

Data acquisition rate, samples per second.

slope_type FrameCPP::Version_3::FrAdcDataNPS::slope
protected

ADC calibration: input units/count.

timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::timeOffsetN
protected

For Triggered data lasting less than one frame, integer residual nanoseconds start time relative to frame start

timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::timeOffsetS
protected

For Triggered data lasting less than one frame, integer seconds start time relative to frame start

units_type FrameCPP::Version_3::FrAdcDataNPS::units
protected

ADC calibration: input units for slope If dimensionless, then units == <NONE>, in CAPITALS (without <...>).


The documentation for this class was generated from the following files: