ldas-tools-framecpp  2.5.8
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | List of all members
FrameCPP::Version_6::FrAdcDataNPS Class Reference

#include <FrAdcDataNPS.hh>

Inheritance diagram for FrameCPP::Version_6::FrAdcDataNPS:
FrameCPP::Version_6::FrAdcData

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
 

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...
 
STRING 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 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 timeOffset_type DEFAULT_TIME_OFFSET = FR_ADC_DATA_DEFAULT_TIME_OFFSET
 
static const phase_type DEFAULT_PHASE = FR_ADC_DATA_DEFAULT_PHASE
 
static const dataValid_type DEFAULT_DATA_VALID = FR_ADC_DATA_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)
 

Static Protected Member Functions

template<typename DescriptionType , typename FrSEType >
static void structDescription (DescriptionType &Desc)
 

Member Typedef Documentation

◆ bias_type

◆ channelGroup_type

◆ channelNumber_type

◆ comment_type

◆ dataValid_type

◆ fShift_type

◆ name_type

◆ nBits_type

◆ phase_type

◆ sampleRate_type

◆ slope_type

◆ timeOffset_type

◆ units_type

Constructor & Destructor Documentation

◆ FrAdcDataNPS() [1/5]

FrAdcDataNPS::FrAdcDataNPS ( )
inlineprotected

Default constructor.

◆ FrAdcDataNPS() [2/5]

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

Stream constructor.

◆ FrAdcDataNPS() [3/5]

FrAdcDataNPS::FrAdcDataNPS ( const FrAdcDataNPS Source,
Common::IStream Stream 
)
inlineprotected

Promotion constructor.

◆ FrAdcDataNPS() [4/5]

FrAdcDataNPS::FrAdcDataNPS ( const Previous::FrAdcData &  Source,
Common::IStream Stream 
)
inlineprotected

Stream copy constructor.

◆ FrAdcDataNPS() [5/5]

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.

Member Function Documentation

◆ AppendComment()

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

Extend the comment associated with the FrAdcData structure.

◆ bytes()

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.

◆ copyCore()

void FrAdcDataNPS::copyCore ( const FrAdcDataNPS Source)
inlineprotected

◆ DEFAULT_UNITS()

FrAdcDataNPS::units_type FrAdcDataNPS::DEFAULT_UNITS ( )
inlinestatic

◆ GetBias()

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

DC bias on channel.

Returns
DC bias on channel.

◆ GetChannelGroup()

INT_4U FrAdcDataNPS::GetChannelGroup ( ) const
inline

The channel group for the FrAdcData.

Returns
The crate number for the FrAdcData

◆ GetChannelNumber()

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

The channel number for the FrAdcData.

Returns
The channel number for the FrAdcData

◆ GetComment()

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

A brief description of the FrAdcData structure.

Returns
A brief description of the FrAdcData structure

◆ GetDataValid()

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

Retrieve the overRange value.

Returns
The value of the overRange field.

◆ GetFShift()

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.

◆ GetName()

const std::string & FrAdcDataNPS::GetName ( ) const
inline

Return the name associate with the FrAdcData structure.

Returns
The name associated with the FrAdcData structure

◆ GetNBits()

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.

◆ GetPhase()

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

Phase of hetrodyning signal at start of dataset.

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

◆ GetSampleRate()

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

The data acquisition rate.

Returns
The data acquisition rate.

◆ GetSlope()

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

ADC calibration units per count.

Returns
ADC calibration units per count.

◆ GetTimeOffset()

FrAdcDataNPS::timeOffset_type 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.

◆ GetUnits()

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

The units used in the ADC calibration.

Returns
The units used in the ADC calibration

◆ incrementTimeOffset()

void 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.

◆ operator==()

bool FrAdcDataNPS::operator== ( const FrAdcDataNPS RHS) const
inlineprotected

Comparison operator.

◆ SetBias()

void FrAdcDataNPS::SetBias ( bias_type  bias)
inline

Establish the value of the bias field.

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

◆ SetChannelGroup()

void FrAdcDataNPS::SetChannelGroup ( channelGroup_type  Value)
inline

Establish the value of the channelGroup field.

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

◆ SetChannelNumber()

void FrAdcDataNPS::SetChannelNumber ( channelNumber_type  Value)
inline

Establish the value of the channelNumber field.

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

◆ SetComment()

void FrAdcDataNPS::SetComment ( const comment_type Value)
inline

Set the comment associated with the FrAdcData structure.

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

◆ SetDataValid()

void FrAdcDataNPS::SetDataValid ( dataValid_type  flag)
inline

Establish the value of the dataValid field.

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

◆ setName()

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

◆ SetNBits()

void 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.

◆ SetSampleRate()

void FrAdcDataNPS::SetSampleRate ( sampleRate_type  Value)
inline

Establish the value of the sampleRate field.

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

◆ SetSlope()

void FrAdcDataNPS::SetSlope ( slope_type  slope)
inline

Establish the value of the slope field.

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

◆ SetTimeOffset()

void FrAdcDataNPS::SetTimeOffset ( timeOffset_type  Value)
inline

Establish the value of the timeOffset field.

Parameters
[in]ValueThe value for the timeOffset field.

◆ structDescription()

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

◆ write()

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

Write contents to the stream.

Member Data Documentation

◆ DEFAULT_BIAS

const FrAdcDataNPS::bias_type FrAdcDataNPS::DEFAULT_BIAS = FR_ADC_DATA_DEFAULT_BIAS
static

◆ DEFAULT_DATA_VALID

const FrAdcDataNPS::dataValid_type FrAdcDataNPS::DEFAULT_DATA_VALID = FR_ADC_DATA_DEFAULT_DATA_VALID
static

◆ DEFAULT_FSHIFT

const FrAdcDataNPS::fShift_type FrAdcDataNPS::DEFAULT_FSHIFT = FR_ADC_DATA_DEFAULT_FSHIFT
static

◆ DEFAULT_PHASE

const FrAdcDataNPS::phase_type FrAdcDataNPS::DEFAULT_PHASE = FR_ADC_DATA_DEFAULT_PHASE
static

◆ DEFAULT_SLOPE

const FrAdcDataNPS::slope_type FrAdcDataNPS::DEFAULT_SLOPE = FR_ADC_DATA_DEFAULT_SLOPE
static

◆ DEFAULT_TIME_OFFSET

const FrAdcDataNPS::timeOffset_type FrAdcDataNPS::DEFAULT_TIME_OFFSET = FR_ADC_DATA_DEFAULT_TIME_OFFSET
static

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