ldas-tools-framecpp 3.0.4
Loading...
Searching...
No Matches
FrameCPP::Version_6::FrAdcDataNPS Class Reference

#include <FrAdcDataNPS.hh>

Inheritance diagram for FrameCPP::Version_6::FrAdcDataNPS:
Collaboration diagram for FrameCPP::Version_6::FrAdcDataNPS:

Public Types

typedef STRING name_type
typedef STRING comment_type
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_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_TIMEOFFSET_TYPE timeOffset_type
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
typedef FR_ADC_DATA_PHASE_TYPE phase_type
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_type
typedef STRING name_type
typedef STRING comment_type
typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE channelGroup_type
typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE channelNumber_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_TIMEOFFSET_TYPE timeOffset_type
typedef FR_ADC_DATA_FSHIFT_TYPE fShift_type
typedef FR_ADC_DATA_PHASE_TYPE phase_type
typedef FR_ADC_DATA_DATAVALID_TYPE dataValid_type

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.
const units_typeGetUnits () const
 The units used in the ADC calibration.
sampleRate_type GetSampleRate () const
 The data acquisition rate.
timeOffset_type GetTimeOffset () 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.
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset.
dataValid_type GetDataValid () const
 Retrieve the overRange value.
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure.
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field.
void SetBias (bias_type bias)
 Establish the value of the bias field.
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field.
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field.
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
void SetSlope (slope_type slope)
 Establish the value of the slope field.
void SetTimeOffset (timeOffset_type Value)
 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.
const units_typeGetUnits () const
 The units used in the ADC calibration.
sampleRate_type GetSampleRate () const
 The data acquisition rate.
timeOffset_type GetTimeOffset () 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.
phase_type GetPhase () const
 Phase of hetrodyning signal at start of dataset.
dataValid_type GetDataValid () const
 Retrieve the overRange value.
void AppendComment (const std::string &comment)
 Extend the comment associated with the FrAdcData structure.
void SetDataValid (dataValid_type flag)
 Establish the value of the dataValid field.
void SetBias (bias_type bias)
 Establish the value of the bias field.
void SetChannelGroup (channelGroup_type Value)
 Establish the value of the channelGroup field.
void SetChannelNumber (channelNumber_type Value)
 Establish the value of the channelNumber field.
void SetComment (const comment_type &Value)
 Set the comment associated with the FrAdcData structure.
void SetNBits (nBits_type Value)
 Tne number of bits in the A/D output.
void SetSampleRate (sampleRate_type Value)
 Establish the value of the sampleRate field.
void SetSlope (slope_type slope)
 Establish the value of the slope field.
void SetTimeOffset (timeOffset_type Value)
 Establish the value of the timeOffset field.

Static Public Member Functions

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.
 FrAdcDataNPS (Common::IStream &Stream)
 Stream constructor.
 FrAdcDataNPS (const FrAdcDataNPS &Source, Common::IStream *Stream)
 Promotion constructor.
 FrAdcDataNPS (const Previous::FrAdcData &Source, stream_base_type *Stream)
 Stream copy constructor.
 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.
cmn_streamsize_type bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
void copyCore (const FrAdcDataNPS &Source)
void incrementTimeOffset (timeOffset_type Value)
 Increment the time offset by the specified value.
void write (Common::OStream &Stream) const
 Write contents to the stream.
bool operator== (const FrAdcDataNPS &RHS) const
 Comparison operator.
void setName (const std::string &Name)
 FrAdcDataNPS ()
 Default constructor.
 FrAdcDataNPS (Common::IStream &Stream)
 Stream constructor.
 FrAdcDataNPS (const FrAdcDataNPS &Source, Common::IStream *Stream)
 Promotion constructor.
 FrAdcDataNPS (const Previous::FrAdcData &Source, stream_base_type *Stream)
 Stream copy constructor.
 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.
cmn_streamsize_type bytes (const Common::StreamBase &Stream) const
 Number of bytes needed to write this structure.
void copyCore (const FrAdcDataNPS &Source)
void incrementTimeOffset (timeOffset_type Value)
 Increment the time offset by the specified value.
void write (Common::OStream &Stream) const
 Write contents to the stream.
bool operator== (const FrAdcDataNPS &RHS) const
 Comparison operator.
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)

Private Attributes

name_type name
comment_type comment
channelGroup_type channelGroup
channelNumber_type channelNumber
nBits_type nBits
bias_type bias
slope_type slope
units_type units
sampleRate_type sampleRate
timeOffset_type timeOffset
fShift_type fShift
phase_type phase
dataValid_type dataValid

Member Typedef Documentation

◆ bias_type [1/2]

◆ bias_type [2/2]

◆ channelGroup_type [1/2]

◆ channelGroup_type [2/2]

◆ channelNumber_type [1/2]

◆ channelNumber_type [2/2]

◆ comment_type [1/2]

◆ comment_type [2/2]

◆ dataValid_type [1/2]

◆ dataValid_type [2/2]

◆ fShift_type [1/2]

◆ fShift_type [2/2]

◆ name_type [1/2]

◆ name_type [2/2]

◆ nBits_type [1/2]

◆ nBits_type [2/2]

◆ phase_type [1/2]

◆ phase_type [2/2]

◆ sampleRate_type [1/2]

◆ sampleRate_type [2/2]

◆ slope_type [1/2]

◆ slope_type [2/2]

◆ timeOffset_type [1/2]

◆ timeOffset_type [2/2]

◆ units_type [1/2]

◆ units_type [2/2]

Constructor & Destructor Documentation

◆ FrAdcDataNPS() [1/10]

FrameCPP::Version_6::FrAdcDataNPS::FrAdcDataNPS ( )
inlineprotected

Default constructor.

◆ FrAdcDataNPS() [2/10]

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

Stream constructor.

◆ FrAdcDataNPS() [3/10]

FrameCPP::Version_6::FrAdcDataNPS::FrAdcDataNPS ( const FrAdcDataNPS & Source,
Common::IStream * Stream )
inlineprotected

Promotion constructor.

◆ FrAdcDataNPS() [4/10]

FrameCPP::Version_6::FrAdcDataNPS::FrAdcDataNPS ( const Previous::FrAdcData & Source,
stream_base_type * Stream )
inlineprotected

Stream copy constructor.

◆ FrAdcDataNPS() [5/10]

FrameCPP::Version_6::FrAdcDataNPS::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 )
inlineprotected

Constructor.

◆ FrAdcDataNPS() [6/10]

FrameCPP::Version_6::FrAdcDataNPS::FrAdcDataNPS ( )
protected

Default constructor.

◆ FrAdcDataNPS() [7/10]

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

Stream constructor.

◆ FrAdcDataNPS() [8/10]

FrameCPP::Version_6::FrAdcDataNPS::FrAdcDataNPS ( const FrAdcDataNPS & Source,
Common::IStream * Stream )
protected

Promotion constructor.

◆ FrAdcDataNPS() [9/10]

FrameCPP::Version_6::FrAdcDataNPS::FrAdcDataNPS ( const Previous::FrAdcData & Source,
stream_base_type * Stream )
protected

Stream copy constructor.

◆ FrAdcDataNPS() [10/10]

FrameCPP::Version_6::FrAdcDataNPS::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 )
protected

Constructor.

Member Function Documentation

◆ AppendComment() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::AppendComment ( const std::string & comment)
inline

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::AppendComment ( const std::string & comment)

Extend the comment associated with the FrAdcData structure.

◆ bytes() [1/2]

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

◆ copyCore() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::copyCore ( const FrAdcDataNPS & Source)
inlineprotected

◆ copyCore() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::copyCore ( const FrAdcDataNPS & Source)
protected

◆ DEFAULT_UNITS() [1/2]

FrAdcDataNPS::units_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_UNITS ( )
inlinestatic

◆ DEFAULT_UNITS() [2/2]

units_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_UNITS ( )
static

◆ GetBias() [1/2]

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

DC bias on channel.

Returns
DC bias on channel.

◆ GetBias() [2/2]

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

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup() [1/2]

INT_4U FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup ( ) const
inline

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelGroup() [2/2]

channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelGroup ( ) const

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber() [1/2]

FrAdcDataNPS::channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber ( ) const
inline

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetChannelNumber() [2/2]

channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::GetChannelNumber ( ) const

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment() [1/2]

const std::string & FrameCPP::Version_6::FrAdcDataNPS::GetComment ( ) const
inline

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetComment() [2/2]

const std::string & FrameCPP::Version_6::FrAdcDataNPS::GetComment ( ) const

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid() [1/2]

FrAdcDataNPS::dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid ( ) const
inline

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetDataValid() [2/2]

dataValid_type FrameCPP::Version_6::FrAdcDataNPS::GetDataValid ( ) const

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetFShift() [1/2]

FrAdcDataNPS::fShift_type FrameCPP::Version_6::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_6::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 std::string & FrameCPP::Version_6::FrAdcDataNPS::GetName ( ) const
inline

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetName() [2/2]

const std::string & FrameCPP::Version_6::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_6::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_6::FrAdcDataNPS::GetNBits ( ) const

Tne number of bits in the A/D output.

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

◆ GetPhase() [1/2]

FrAdcDataNPS::phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase ( ) const
inline

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetPhase() [2/2]

phase_type FrameCPP::Version_6::FrAdcDataNPS::GetPhase ( ) const

Phase of hetrodyning signal at start of dataset.

Returns
The Phase (in radians) of hetrodyning signal at start of dataset.

◆ GetSampleRate() [1/2]

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSampleRate() [2/2]

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope() [1/2]

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetSlope() [2/2]

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffset() [1/2]

FrAdcDataNPS::timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::GetTimeOffset ( ) 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.

◆ GetTimeOffset() [2/2]

timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::GetTimeOffset ( ) 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]

const FrAdcDataNPS::units_type & FrameCPP::Version_6::FrAdcDataNPS::GetUnits ( ) const
inline

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ GetUnits() [2/2]

const units_type & FrameCPP::Version_6::FrAdcDataNPS::GetUnits ( ) const

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ incrementTimeOffset() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::incrementTimeOffset ( timeOffset_type Value)
inlineprotected

Increment the time offset by the specified value.

Parameters
[in]ValueThe amount of time by which to adjust the timeOffset value.

◆ incrementTimeOffset() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::incrementTimeOffset ( timeOffset_type Value)
protected

Increment the time offset by the specified value.

Parameters
[in]ValueThe amount of time by which to adjust the timeOffset value.

◆ operator==() [1/2]

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

Comparison operator.

◆ operator==() [2/2]

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

Comparison operator.

◆ SetBias() [1/2]

void FrameCPP::Version_6::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_6::FrAdcDataNPS::SetBias ( bias_type bias)

Establish the value of the bias field.

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

◆ SetChannelGroup() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelGroup ( channelGroup_type Value)
inline

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelGroup() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelGroup ( channelGroup_type Value)

Establish the value of the channelGroup field.

Parameters
[in]ValueThe desired value of the channelGroup field.

◆ SetChannelNumber() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelNumber ( channelNumber_type Value)
inline

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetChannelNumber() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetChannelNumber ( channelNumber_type Value)

Establish the value of the channelNumber field.

Parameters
[in]ValueThe desired value of the channelNumber field.

◆ SetComment() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetComment ( const comment_type & Value)
inline

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetComment() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetComment ( const comment_type & Value)

Set the comment associated with the FrAdcData structure.

Parameters
[in]ValueThe desired value for the comment field.

◆ SetDataValid() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetDataValid ( dataValid_type flag)
inline

Establish the value of the dataValid field.

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

◆ SetDataValid() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetDataValid ( dataValid_type flag)

Establish the value of the dataValid field.

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

◆ setName() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::setName ( const std::string & Name)
inlineprotected

◆ setName() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::setName ( const std::string & Name)
inlineprotected

◆ SetNBits() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetNBits ( nBits_type Value)
inline

Tne number of bits in the A/D output.

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

◆ SetNBits() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetNBits ( nBits_type Value)

Tne number of bits in the A/D output.

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

◆ SetSampleRate() [1/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetSampleRate ( sampleRate_type Value)
inline

Establish the value of the sampleRate field.

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

◆ SetSampleRate() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetSampleRate ( sampleRate_type Value)

Establish the value of the sampleRate field.

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

◆ SetSlope() [1/2]

void FrameCPP::Version_6::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_6::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_6::FrAdcDataNPS::SetTimeOffset ( timeOffset_type Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_6::FrAdcDataNPS::SetTimeOffset ( timeOffset_type Value)

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ structDescription() [1/2]

template<typename DescriptionType, typename FrSEType>
void FrameCPP::Version_6::FrAdcDataNPS::structDescription ( DescriptionType & Desc)
inlinestaticprotected

◆ structDescription() [2/2]

template<typename DescriptionType, typename FrSEType>
void FrameCPP::Version_6::FrAdcDataNPS::structDescription ( DescriptionType & Desc)
staticprotected

◆ write() [1/2]

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

Write contents to the stream.

◆ write() [2/2]

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

Write contents to the stream.

Member Data Documentation

◆ bias

bias_type FrameCPP::Version_6::FrAdcDataNPS::bias
private

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

◆ channelGroup

channelGroup_type FrameCPP::Version_6::FrAdcDataNPS::channelGroup
private

Channel grouping number containing ADC.

Note
This variable is determined by the site and must be unique over all detectors.

◆ channelNumber

channelNumber_type FrameCPP::Version_6::FrAdcDataNPS::channelNumber
private

Channel number

Note
This variable is determined by the site and must be unique over all detectors.

◆ comment

comment_type FrameCPP::Version_6::FrAdcDataNPS::comment
private

Comment for the ADC.

◆ dataValid

dataValid_type FrameCPP::Version_6::FrAdcDataNPS::dataValid
private

Data valid flag

Note
dataValid = 0 -> ADC data valid; dataValid != 0 -> ADC data suspect/not valid

◆ DEFAULT_BIAS

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

◆ DEFAULT_DATA_VALID

const dataValid_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_DATA_VALID
static
Initial value:
=
const FR_ADC_DATA_DATAVALID_TYPE FR_ADC_DATA_DEFAULT_DATA_VALID
Definition FrAdcDataNPS.hh:91

◆ DEFAULT_FSHIFT

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

◆ DEFAULT_PHASE

const phase_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_PHASE
static
Initial value:
=
const FR_ADC_DATA_PHASE_TYPE FR_ADC_DATA_DEFAULT_PHASE
Definition FrAdcDataNPS.hh:95

◆ DEFAULT_SLOPE

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

◆ DEFAULT_TIME_OFFSET

const timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::DEFAULT_TIME_OFFSET
static
Initial value:
=
const FR_ADC_DATA_TIMEOFFSET_TYPE FR_ADC_DATA_DEFAULT_TIME_OFFSET
Definition FrAdcDataNPS.hh:94

◆ fShift

fShift_type FrameCPP::Version_6::FrAdcDataNPS::fShift
private

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_6::FrAdcDataNPS::name
private

Channel name – must be unique with the frame

◆ nBits

nBits_type FrameCPP::Version_6::FrAdcDataNPS::nBits
private

Number of bits in A/D output.

◆ phase

phase_type FrameCPP::Version_6::FrAdcDataNPS::phase
private

Phase (in radian) of heterodyning signal at start of dataset.

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.

◆ sampleRate

sampleRate_type FrameCPP::Version_6::FrAdcDataNPS::sampleRate
private

Data acquisition rate, samples per second.

◆ slope

slope_type FrameCPP::Version_6::FrAdcDataNPS::slope
private

ADC calibration: input units/count.

◆ timeOffset

timeOffset_type FrameCPP::Version_6::FrAdcDataNPS::timeOffset
private

Offfset of 1st sample relative to the frame start time.

◆ units

units_type FrameCPP::Version_6::FrAdcDataNPS::units
private

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