ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
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:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Version_3::FrAdcDataNPS:
Collaboration graph
[legend]

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
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.
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.
channel_type GetChannel () const
 The channel number for the FrAdcData.
crate_type GetCrate () const
 The crate 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.
overRange_type GetOverRange () const
 Retrieve the overRange value.
void SetCrate (crate_type Value)
 Set the numeric crate id for the channel.
void SetChannel (channel_type Value)
 Set the numeric id for the channel.
void SetComment (const comment_type &comment)
 Set the comment associated with the FrAdcData structure.
void SetOverRange (overRange_type flag)
 Establish the value of the overRange field.
void SetBias (bias_type bias)
 Establish the value of the bias field.
void SetNBits (nBits_type NBits)
 The number of bits in the A/D output.
void SetSampleRate (sampleRate_type SampleRate)
 Establish the value of the sampleRate field.
void SetSlope (slope_type slope)
 Establish the value of the slope field.
void SetTimeOffset (timeOffsetS_type Seconds, timeOffsetN_type Nanoseconds)
 Establish the value of the timeOffset field.
void SetTimeOffsetS (timeOffsetS_type time)
 Establish the value of the timeOffset field.
void SetTimeOffsetN (timeOffsetN_type time)
 Establish the value of the timeOffset field.
void AppendComment (const comment_type &Comment)
 Extend the comment associated with the FrAdcData structure.
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.
channel_type GetChannel () const
 The channel number for the FrAdcData.
crate_type GetCrate () const
 The crate 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.
overRange_type GetOverRange () const
 Retrieve the overRange value.
void SetCrate (crate_type Value)
 Set the numeric crate id for the channel.
void SetChannel (channel_type Value)
 Set the numeric id for the channel.
void SetComment (const comment_type &comment)
 Set the comment associated with the FrAdcData structure.
void SetOverRange (overRange_type flag)
 Establish the value of the overRange field.
void SetBias (bias_type bias)
 Establish the value of the bias field.
void SetNBits (nBits_type NBits)
 The number of bits in the A/D output.
void SetSampleRate (sampleRate_type SampleRate)
 Establish the value of the sampleRate field.
void SetSlope (slope_type slope)
 Establish the value of the slope field.
void SetTimeOffset (timeOffsetS_type Seconds, timeOffsetN_type Nanoseconds)
 Establish the value of the timeOffset field.
void SetTimeOffsetS (timeOffsetS_type time)
 Establish the value of the timeOffset field.
void SetTimeOffsetN (timeOffsetN_type time)
 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 overRange_type DEFAULT_OVER_RANGE

Protected Member Functions

 FrAdcDataNPS ()
 Default constructor.
 FrAdcDataNPS (Common::IStream &Stream)
 Initialzie the instance from an input stream.
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)
 Initialzie the instance from an input stream.
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.

Protected Attributes

name_type name
comment_type comment
crate_type crate
channel_type channel
nBits_type nBits
bias_type bias
slope_type slope
units_type units
sampleRate_type sampleRate
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

◆ bias_type [1/2]

typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::Version_3::FrAdcDataNPS::bias_type

◆ bias_type [2/2]

typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::Version_3::FrAdcDataNPS::bias_type

◆ channel_type [1/2]

typedef FR_ADC_DATA_CHANNEL_TYPE FrameCPP::Version_3::FrAdcDataNPS::channel_type

◆ channel_type [2/2]

typedef FR_ADC_DATA_CHANNEL_TYPE FrameCPP::Version_3::FrAdcDataNPS::channel_type

◆ comment_type [1/2]

typedef STRING FrameCPP::Version_3::FrAdcDataNPS::comment_type

◆ comment_type [2/2]

typedef STRING FrameCPP::Version_3::FrAdcDataNPS::comment_type

◆ crate_type [1/2]

typedef FR_ADC_DATA_CRATE_TYPE FrameCPP::Version_3::FrAdcDataNPS::crate_type

◆ crate_type [2/2]

typedef FR_ADC_DATA_CRATE_TYPE FrameCPP::Version_3::FrAdcDataNPS::crate_type

◆ fShift_type [1/2]

typedef FR_ADC_DATA_FSHIFT_TYPE FrameCPP::Version_3::FrAdcDataNPS::fShift_type

◆ fShift_type [2/2]

typedef FR_ADC_DATA_FSHIFT_TYPE FrameCPP::Version_3::FrAdcDataNPS::fShift_type

◆ name_type [1/2]

typedef STRING FrameCPP::Version_3::FrAdcDataNPS::name_type

◆ name_type [2/2]

typedef STRING FrameCPP::Version_3::FrAdcDataNPS::name_type

◆ nBits_type [1/2]

typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::Version_3::FrAdcDataNPS::nBits_type

◆ nBits_type [2/2]

typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::Version_3::FrAdcDataNPS::nBits_type

◆ overRange_type [1/2]

typedef FR_ADC_DATA_OVERRANGE_TYPE FrameCPP::Version_3::FrAdcDataNPS::overRange_type

◆ overRange_type [2/2]

typedef FR_ADC_DATA_OVERRANGE_TYPE FrameCPP::Version_3::FrAdcDataNPS::overRange_type

◆ sampleRate_type [1/2]

typedef FR_ADC_DATA_SAMPLERATE_TYPE FrameCPP::Version_3::FrAdcDataNPS::sampleRate_type

◆ sampleRate_type [2/2]

typedef FR_ADC_DATA_SAMPLERATE_TYPE FrameCPP::Version_3::FrAdcDataNPS::sampleRate_type

◆ slope_type [1/2]

typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::Version_3::FrAdcDataNPS::slope_type

◆ slope_type [2/2]

typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::Version_3::FrAdcDataNPS::slope_type

◆ timeOffsetN_type [1/2]

typedef FR_ADC_DATA_TIMEOFFSETN_TYPE FrameCPP::Version_3::FrAdcDataNPS::timeOffsetN_type

◆ timeOffsetN_type [2/2]

typedef FR_ADC_DATA_TIMEOFFSETN_TYPE FrameCPP::Version_3::FrAdcDataNPS::timeOffsetN_type

◆ timeOffsetS_type [1/2]

typedef FR_ADC_DATA_TIMEOFFSETS_TYPE FrameCPP::Version_3::FrAdcDataNPS::timeOffsetS_type

◆ timeOffsetS_type [2/2]

typedef FR_ADC_DATA_TIMEOFFSETS_TYPE FrameCPP::Version_3::FrAdcDataNPS::timeOffsetS_type

◆ units_type [1/2]

typedef STRING FrameCPP::Version_3::FrAdcDataNPS::units_type

◆ units_type [2/2]

typedef STRING FrameCPP::Version_3::FrAdcDataNPS::units_type

Constructor & Destructor Documentation

◆ FrAdcDataNPS() [1/4]

FrAdcDataNPS::FrAdcDataNPS ( )
protected

Default constructor.

◆ FrAdcDataNPS() [2/4]

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

Initialzie the instance from an input stream.

◆ FrAdcDataNPS() [3/4]

FrameCPP::Version_3::FrAdcDataNPS::FrAdcDataNPS ( )
protected

Default constructor.

◆ FrAdcDataNPS() [4/4]

FrameCPP::Version_3::FrAdcDataNPS::FrAdcDataNPS ( Common::IStream & Stream)
protected

Initialzie the instance from an input stream.

Member Function Documentation

◆ AppendComment() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::AppendComment ( const comment_type & Comment)
inline

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::AppendComment ( const comment_type & Comment)

Extend the comment associated with the FrAdcData structure.

◆ bytes() [1/2]

cmn_streamsize_type FrameCPP::Version_3::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.

◆ bytes() [2/2]

cmn_streamsize_type FrameCPP::Version_3::FrAdcDataNPS::bytes ( const Common::StreamBase & Stream) const
protected

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.

◆ GetBias() [1/2]

FrAdcDataNPS::bias_type FrameCPP::Version_3::FrAdcDataNPS::GetBias ( ) const
inline

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/2]

bias_type FrameCPP::Version_3::FrAdcDataNPS::GetBias ( ) const

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannel() [1/2]

FrAdcDataNPS::channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel ( ) const
inline

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannel() [2/2]

channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel ( ) const

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment() [1/2]

const FrAdcDataNPS::comment_type & FrameCPP::Version_3::FrAdcDataNPS::GetComment ( ) const
inline

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/2]

const comment_type & FrameCPP::Version_3::FrAdcDataNPS::GetComment ( ) const

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetCrate() [1/2]

FrAdcDataNPS::crate_type FrameCPP::Version_3::FrAdcDataNPS::GetCrate ( ) const
inline

The crate number for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetCrate() [2/2]

crate_type FrameCPP::Version_3::FrAdcDataNPS::GetCrate ( ) const

The crate number for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetFShift() [1/2]

FrAdcDataNPS::fShift_type FrameCPP::Version_3::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.

◆ GetFShift() [2/2]

fShift_type FrameCPP::Version_3::FrAdcDataNPS::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]

const FrAdcDataNPS::name_type & FrameCPP::Version_3::FrAdcDataNPS::GetName ( ) const
inline

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [2/2]

const name_type & FrameCPP::Version_3::FrAdcDataNPS::GetName ( ) const

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNBits() [1/2]

FrAdcDataNPS::nBits_type FrameCPP::Version_3::FrAdcDataNPS::GetNBits ( ) const
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_3::FrAdcDataNPS::GetNBits ( ) const

Tne number of bits in the A/D output.

Returns
Tne number of bits in the A/D output.

◆ GetOverRange() [1/2]

FrAdcDataNPS::overRange_type FrameCPP::Version_3::FrAdcDataNPS::GetOverRange ( ) const
inline

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetOverRange() [2/2]

overRange_type FrameCPP::Version_3::FrAdcDataNPS::GetOverRange ( ) const

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetSampleRate() [1/2]

FrAdcDataNPS::sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::GetSampleRate ( ) const
inline

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/2]

sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::GetSampleRate ( ) const

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/2]

FrAdcDataNPS::slope_type FrameCPP::Version_3::FrAdcDataNPS::GetSlope ( ) const
inline

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/2]

slope_type FrameCPP::Version_3::FrAdcDataNPS::GetSlope ( ) const

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffsetN() [1/2]

FrAdcDataNPS::timeOffsetN_type FrameCPP::Version_3::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.

◆ GetTimeOffsetN() [2/2]

timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetN ( ) 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.

◆ GetTimeOffsetS() [1/2]

FrAdcDataNPS::timeOffsetS_type FrameCPP::Version_3::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.

◆ GetTimeOffsetS() [2/2]

timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::GetTimeOffsetS ( ) 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]

FrAdcDataNPS::units_type FrameCPP::Version_3::FrAdcDataNPS::GetUnits ( ) const
inline

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/2]

STRING FrameCPP::Version_3::FrAdcDataNPS::GetUnits ( ) const

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ operator==() [1/2]

bool FrameCPP::Version_3::FrAdcDataNPS::operator== ( const FrAdcDataNPS & RHS) const
inlineprotected

Comparison operator.

◆ operator==() [2/2]

bool FrameCPP::Version_3::FrAdcDataNPS::operator== ( const FrAdcDataNPS & RHS) const
protected

Comparison operator.

◆ SetBias() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetBias ( bias_type bias)
inline

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetBias() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetBias ( bias_type bias)

Establish the value of the bias field.

Parameters
[in]biasThe desired value of the bias field.

◆ SetChannel() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetChannel ( channel_type Value)
inline

Set the numeric id for the channel.

◆ SetChannel() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetChannel ( channel_type Value)

Set the numeric id for the channel.

◆ SetComment() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetComment ( const comment_type & comment)
inline

Set the comment associated with the FrAdcData structure.

◆ SetComment() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetComment ( const comment_type & comment)

Set the comment associated with the FrAdcData structure.

◆ SetCrate() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetCrate ( crate_type Value)
inline

Set the numeric crate id for the channel.

◆ SetCrate() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetCrate ( crate_type Value)

Set the numeric crate id for the channel.

◆ SetNBits() [1/2]

void FrameCPP::Version_3::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.

◆ SetNBits() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetNBits ( nBits_type NBits)

The number of bits in the A/D output.

Parameters
[in]NBitsTne number of bits in the A/D output.

◆ SetOverRange() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetOverRange ( overRange_type flag)
inline

Establish the value of the overRange field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetOverRange() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetOverRange ( overRange_type flag)

Establish the value of the overRange field.

Parameters
[in]flagThe desired value of the overRange field.

◆ SetSampleRate() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetSampleRate ( sampleRate_type SampleRate)
inline

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSampleRate() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetSampleRate ( sampleRate_type SampleRate)

Establish the value of the sampleRate field.

Parameters
[in]SampleRateThe desired value of the sampleRate field.

◆ SetSlope() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetSlope ( slope_type slope)
inline

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetSlope() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetSlope ( slope_type slope)

Establish the value of the slope field.

Parameters
[in]slopeThe desired value of the slope field.

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffset ( timeOffsetS_type Seconds,
timeOffsetN_type Nanoseconds )
inline

Establish the value of the timeOffset field.

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffset ( timeOffsetS_type Seconds,
timeOffsetN_type Nanoseconds )

Establish the value of the timeOffset field.

◆ SetTimeOffsetN() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type time)
inline

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetN() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type time)

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetS() [1/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type time)
inline

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ SetTimeOffsetS() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type time)

Establish the value of the timeOffset field.

Parameters
[in]timeThe desired value of the timeOffset field.

◆ write() [1/2]

void FrAdcDataNPS::write ( Common::OStream & Stream) const
protected

Write contents to the stream.

◆ write() [2/2]

void FrameCPP::Version_3::FrAdcDataNPS::write ( Common::OStream & Stream) const
protected

Write contents to the stream.

Member Data Documentation

◆ bias

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

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

◆ channel

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

comment_type FrameCPP::Version_3::FrAdcDataNPS::comment
protected

Comment for the ADC.

◆ crate

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.

◆ DEFAULT_BIAS

const bias_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_BIAS
static
Initial value:
=
FR_ADC_DATA_DEFAULT_BIAS
FrameCPP::Version_3::FR_ADC_DATA_DEFAULT_BIAS
const FR_ADC_DATA_BIAS_TYPE FR_ADC_DATA_DEFAULT_BIAS
Definition FrAdcDataNPS.hh:84

◆ DEFAULT_FSHIFT

const fShift_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_FSHIFT
static
Initial value:
=
FR_ADC_DATA_DEFAULT_FSHIFT
FrameCPP::Version_3::FR_ADC_DATA_DEFAULT_FSHIFT
const FR_ADC_DATA_FSHIFT_TYPE FR_ADC_DATA_DEFAULT_FSHIFT
Definition FrAdcDataNPS.hh:86

◆ DEFAULT_OVER_RANGE

const overRange_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_OVER_RANGE
static
Initial value:
=
FR_ADC_DATA_DEFAULT_OVER_RANGE
FrameCPP::Version_3::FR_ADC_DATA_DEFAULT_OVER_RANGE
const FR_ADC_DATA_OVERRANGE_TYPE FR_ADC_DATA_DEFAULT_OVER_RANGE
Definition FrAdcDataNPS.hh:91

◆ DEFAULT_SLOPE

const slope_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_SLOPE
static
Initial value:
=
FR_ADC_DATA_DEFAULT_SLOPE
FrameCPP::Version_3::FR_ADC_DATA_DEFAULT_SLOPE
const FR_ADC_DATA_SLOPE_TYPE FR_ADC_DATA_DEFAULT_SLOPE
Definition FrAdcDataNPS.hh:85

◆ DEFAULT_TIME_OFFSET_N

const timeOffsetN_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_TIME_OFFSET_N
static
Initial value:
=
FR_ADC_DATA_DEFAULT_TIME_OFFSET_N
FrameCPP::Version_3::FR_ADC_DATA_DEFAULT_TIME_OFFSET_N
const FR_ADC_DATA_TIMEOFFSETN_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET_N
Definition FrAdcDataNPS.hh:89

◆ DEFAULT_TIME_OFFSET_S

const timeOffsetS_type FrameCPP::Version_3::FrAdcDataNPS::DEFAULT_TIME_OFFSET_S
static
Initial value:
=
FR_ADC_DATA_DEFAULT_TIME_OFFSET_S
FrameCPP::Version_3::FR_ADC_DATA_DEFAULT_TIME_OFFSET_S
const FR_ADC_DATA_TIMEOFFSETS_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET_S
Definition FrAdcDataNPS.hh:87

◆ fShift

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

name_type FrameCPP::Version_3::FrAdcDataNPS::name
protected

Channel name – must be unique with the frame

◆ nBits

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

Number of bits in A/D output.

◆ overRange

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

sampleRate_type FrameCPP::Version_3::FrAdcDataNPS::sampleRate
protected

Data acquisition rate, samples per second.

◆ slope

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

ADC calibration: input units/count.

◆ timeOffsetN

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

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

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:
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/build/include/framecpp/Version3/FrAdcDataNPS.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrAdcDataNPS.hh
  • /home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version3/FrAdcData.cc