#include <FrAdcDataNPS.hh>

Inheritance diagram for FrameCPP::Version_4::FrAdcDataNPS:

Collaboration diagram for FrameCPP::Version_4::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_TIMEOFFSETS_TYPE	timeOffsetS_type

typedef FR_ADC_DATA_TIMEOFFSETN_TYPE	timeOffsetN_type

typedef FR_ADC_DATA_FSHIFT_TYPE	fShift_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_TIMEOFFSETS_TYPE	timeOffsetS_type

typedef FR_ADC_DATA_TIMEOFFSETN_TYPE	timeOffsetN_type

typedef FR_ADC_DATA_FSHIFT_TYPE	fShift_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.

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.

dataValid_type	GetDataValid () const
	Retrieve the overRange value.

void	AppendComment (const std::string &comment)
	Extend the comment associated with the FrAdcData structure.

void	SetDataValid (INT_2U flag)
	Establish the value of the dataValid field.

void	SetBias (REAL_4 Value)
	Establish the value of the bias field.

void	SetSlope (REAL_4 Value)
	Establish the value of the slope field.

void	SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
	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.

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.

dataValid_type	GetDataValid () const
	Retrieve the overRange value.

void	AppendComment (const std::string &comment)
	Extend the comment associated with the FrAdcData structure.

void	SetDataValid (INT_2U flag)
	Establish the value of the dataValid field.

void	SetBias (REAL_4 Value)
	Establish the value of the bias field.

void	SetSlope (REAL_4 Value)
	Establish the value of the slope field.

void	SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
	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 dataValid_type	DEFAULT_DATA_VALID

Protected Member Functions
	FrAdcDataNPS ()
	Default constructor.

	FrAdcDataNPS (Common::IStream &Stream)
	Stream constructor.

	FrAdcDataNPS (const Previous::FrAdcData &Source, stream_base_type *Stream)
	Promotion constructor.

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)
	Stream constructor.

	FrAdcDataNPS (const Previous::FrAdcData &Source, stream_base_type *Stream)
	Promotion constructor.

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.

Static Protected Member Functions
template<typename DescriptionType, typename FrSEType>
static void	structDescription (DescriptionType &Desc)

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

Member Typedef Documentation

◆ bias_type [1/2]

typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::Version_4::FrAdcDataNPS::bias_type

◆ bias_type [2/2]

typedef FR_ADC_DATA_BIAS_TYPE FrameCPP::Version_4::FrAdcDataNPS::bias_type

◆ channelGroup_type [1/2]

typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE FrameCPP::Version_4::FrAdcDataNPS::channelGroup_type

◆ channelGroup_type [2/2]

typedef FR_ADC_DATA_CHANNEL_GROUP_TYPE FrameCPP::Version_4::FrAdcDataNPS::channelGroup_type

◆ channelNumber_type [1/2]

typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_4::FrAdcDataNPS::channelNumber_type

◆ channelNumber_type [2/2]

typedef FR_ADC_DATA_CHANNEL_NUMBER_TYPE FrameCPP::Version_4::FrAdcDataNPS::channelNumber_type

◆ comment_type [1/2]

typedef STRING FrameCPP::Version_4::FrAdcDataNPS::comment_type

◆ comment_type [2/2]

typedef STRING FrameCPP::Version_4::FrAdcDataNPS::comment_type

◆ dataValid_type [1/2]

typedef FR_ADC_DATA_DATAVALID_TYPE FrameCPP::Version_4::FrAdcDataNPS::dataValid_type

◆ dataValid_type [2/2]

typedef FR_ADC_DATA_DATAVALID_TYPE FrameCPP::Version_4::FrAdcDataNPS::dataValid_type

◆ fShift_type [1/2]

typedef FR_ADC_DATA_FSHIFT_TYPE FrameCPP::Version_4::FrAdcDataNPS::fShift_type

◆ fShift_type [2/2]

typedef FR_ADC_DATA_FSHIFT_TYPE FrameCPP::Version_4::FrAdcDataNPS::fShift_type

◆ name_type [1/2]

typedef STRING FrameCPP::Version_4::FrAdcDataNPS::name_type

◆ name_type [2/2]

typedef STRING FrameCPP::Version_4::FrAdcDataNPS::name_type

◆ nBits_type [1/2]

typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::Version_4::FrAdcDataNPS::nBits_type

◆ nBits_type [2/2]

typedef FR_ADC_DATA_N_BITS_TYPE FrameCPP::Version_4::FrAdcDataNPS::nBits_type

◆ sampleRate_type [1/2]

typedef FR_ADC_DATA_SAMPLERATE_TYPE FrameCPP::Version_4::FrAdcDataNPS::sampleRate_type

◆ sampleRate_type [2/2]

typedef FR_ADC_DATA_SAMPLERATE_TYPE FrameCPP::Version_4::FrAdcDataNPS::sampleRate_type

◆ slope_type [1/2]

typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::Version_4::FrAdcDataNPS::slope_type

◆ slope_type [2/2]

typedef FR_ADC_DATA_SLOPE_TYPE FrameCPP::Version_4::FrAdcDataNPS::slope_type

◆ timeOffsetN_type [1/2]

typedef FR_ADC_DATA_TIMEOFFSETN_TYPE FrameCPP::Version_4::FrAdcDataNPS::timeOffsetN_type

◆ timeOffsetN_type [2/2]

typedef FR_ADC_DATA_TIMEOFFSETN_TYPE FrameCPP::Version_4::FrAdcDataNPS::timeOffsetN_type

◆ timeOffsetS_type [1/2]

typedef FR_ADC_DATA_TIMEOFFSETS_TYPE FrameCPP::Version_4::FrAdcDataNPS::timeOffsetS_type

◆ timeOffsetS_type [2/2]

typedef FR_ADC_DATA_TIMEOFFSETS_TYPE FrameCPP::Version_4::FrAdcDataNPS::timeOffsetS_type

◆ units_type [1/2]

typedef STRING FrameCPP::Version_4::FrAdcDataNPS::units_type

◆ units_type [2/2]

typedef STRING FrameCPP::Version_4::FrAdcDataNPS::units_type

Constructor & Destructor Documentation

◆ FrAdcDataNPS() [1/6]

FrameCPP::Version_4::FrAdcDataNPS::FrAdcDataNPS ( )

protected

Default constructor.

◆ FrAdcDataNPS() [2/6]

FrameCPP::Version_4::FrAdcDataNPS::FrAdcDataNPS ( Common::IStream & Stream )

protected

Stream constructor.

◆ FrAdcDataNPS() [3/6]

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

protected

Promotion constructor.

◆ FrAdcDataNPS() [4/6]

FrameCPP::Version_4::FrAdcDataNPS::FrAdcDataNPS ( )

protected

Default constructor.

◆ FrAdcDataNPS() [5/6]

FrameCPP::Version_4::FrAdcDataNPS::FrAdcDataNPS ( Common::IStream & Stream )

protected

Stream constructor.

◆ FrAdcDataNPS() [6/6]

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

protected

Promotion constructor.

Member Function Documentation

◆ AppendComment() [1/2]

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

inline

Extend the comment associated with the FrAdcData structure.

◆ AppendComment() [2/2]

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

Extend the comment associated with the FrAdcData structure.

◆ bytes() [1/2]

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

inlineprotected

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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_4::FrAdcDataNPS::bytes ( const Common::StreamBase & Stream ) const

protected

Number of bytes needed to write this structure.

Parameters

[in] Stream The 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_4::FrAdcDataNPS::GetBias ( ) const

inline

DC bias on channel.

Returns: DC bias on channel.

◆ GetBias() [2/2]

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

DC bias on channel.

Returns: DC bias on channel.

◆ GetChannelGroup() [1/2]

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

inline

The channel group for the FrAdcData.

Returns: The crate number for the FrAdcData

◆ GetChannelGroup() [2/2]

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

The channel group for the FrAdcData.

Returns: The crate number for the FrAdcData

◆ GetChannelNumber() [1/2]

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

inline

The channel number for the FrAdcData.

Returns: The channel number for the FrAdcData

◆ GetChannelNumber() [2/2]

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

The channel number for the FrAdcData.

Returns: The channel number for the FrAdcData

◆ GetComment() [1/2]

const std::string & FrameCPP::Version_4::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_4::FrAdcDataNPS::GetComment ( ) const

A brief description of the FrAdcData structure.

Returns: A brief description of the FrAdcData structure

◆ GetDataValid() [1/2]

INT_2U FrameCPP::Version_4::FrAdcDataNPS::GetDataValid ( ) const

inline

Retrieve the overRange value.

Returns: The value of the overRange field.

◆ GetDataValid() [2/2]

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

Retrieve the overRange value.

Returns: The value of the overRange field.

◆ GetFShift() [1/2]

FrAdcDataNPS::fShift_type FrameCPP::Version_4::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_4::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_4::FrAdcDataNPS::GetName ( ) const

Return the name associate with the FrAdcData structure.

Returns: The name associated with the FrAdcData structure

◆ GetName() [2/2]

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

Tne number of bits in the A/D output.

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

◆ GetSampleRate() [1/2]

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

inline

The data acquisition rate.

Returns: The data acquisition rate.

◆ GetSampleRate() [2/2]

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

The data acquisition rate.

Returns: The data acquisition rate.

◆ GetSlope() [1/2]

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

inline

ADC calibration units per count.

Returns: ADC calibration units per count.

◆ GetSlope() [2/2]

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

ADC calibration units per count.

Returns: ADC calibration units per count.

◆ GetTimeOffsetN() [1/2]

FrAdcDataNPS::timeOffsetN_type FrameCPP::Version_4::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_4::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_4::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_4::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]

STRING FrameCPP::Version_4::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_4::FrAdcDataNPS::GetUnits ( ) const

The units used in the ADC calibration.

Returns: The units used in the ADC calibration

◆ operator==() [1/2]

bool FrameCPP::Version_4::FrAdcDataNPS::operator== ( const FrAdcDataNPS & RHS ) const

inlineprotected

Comparison operator.

◆ operator==() [2/2]

bool FrameCPP::Version_4::FrAdcDataNPS::operator== ( const FrAdcDataNPS & RHS ) const

protected

Comparison operator.

◆ SetBias() [1/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetBias ( REAL_4 Value )

inline

Establish the value of the bias field.

Parameters

[in] Value The desired value of the bias field.

◆ SetBias() [2/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetBias ( REAL_4 Value )

Establish the value of the bias field.

Parameters

[in] Value The desired value of the bias field.

◆ SetDataValid() [1/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetDataValid ( INT_2U flag )

inline

Establish the value of the dataValid field.

Parameters

[in] flag The desired value of the overRange field.

◆ SetDataValid() [2/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetDataValid ( INT_2U flag )

Establish the value of the dataValid field.

Parameters

[in] flag The desired value of the overRange field.

◆ SetSlope() [1/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetSlope ( REAL_4 Value )

inline

Establish the value of the slope field.

Parameters

[in] Value The desired value of the slope field.

◆ SetSlope() [2/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetSlope ( REAL_4 Value )

Establish the value of the slope field.

Parameters

[in] Value The desired value of the slope field.

◆ SetTimeOffset() [1/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetTimeOffset	(	INT_4U	Seconds,
		INT_4U	Nanoseconds )

inline

Establish the value of the timeOffset field.

Parameters

[in]	Seconds	The value for the timeOffsetS field.
[in]	Nanoseconds	The value for the timeOffsetN field.

◆ SetTimeOffset() [2/2]

void FrameCPP::Version_4::FrAdcDataNPS::SetTimeOffset	(	INT_4U	Seconds,
		INT_4U	Nanoseconds )

Establish the value of the timeOffset field.

Parameters

[in]	Seconds	The value for the timeOffsetS field.
[in]	Nanoseconds	The value for the timeOffsetN field.

◆ structDescription() [1/2]

template<typename DescriptionType, typename FrSEType>

void FrameCPP::Version_4::FrAdcDataNPS::structDescription ( DescriptionType & Desc )

inlinestaticprotected

◆ structDescription() [2/2]

template<typename DescriptionType, typename FrSEType>

static void FrameCPP::Version_4::FrAdcDataNPS::structDescription ( DescriptionType & Desc )

staticprotected

◆ write() [1/2]

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

protected

Write contents to the stream.

◆ write() [2/2]

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

protected

Write contents to the stream.

Member Data Documentation

◆ bias

bias_type FrameCPP::Version_4::FrAdcDataNPS::bias

protected

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

◆ channelGroup

channelGroup_type FrameCPP::Version_4::FrAdcDataNPS::channelGroup

protected

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_4::FrAdcDataNPS::channelNumber

protected

Channel number

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

◆ comment

comment_type FrameCPP::Version_4::FrAdcDataNPS::comment

protected

Comment for the ADC.

◆ dataValid

dataValid_type FrameCPP::Version_4::FrAdcDataNPS::dataValid

protected

Data valid flag

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

◆ DEFAULT_BIAS

static const bias_type FrameCPP::Version_4::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_DATA_VALID

static const dataValid_type FrameCPP::Version_4::FrAdcDataNPS::DEFAULT_DATA_VALID

static

Initial value:

=

FR_ADC_DATA_DEFAULT_DATA_VALID

FrameCPP::Version_4::FR_ADC_DATA_DEFAULT_DATA_VALID

const FR_ADC_DATA_DATAVALID_TYPE FR_ADC_DATA_DEFAULT_DATA_VALID

Definition FrAdcDataNPS.hh:91

◆ DEFAULT_FSHIFT

static const fShift_type FrameCPP::Version_4::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_SLOPE

static const slope_type FrameCPP::Version_4::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

static const timeOffsetN_type FrameCPP::Version_4::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

static const timeOffsetS_type FrameCPP::Version_4::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_4::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_4::FrAdcDataNPS::name

protected

Channel name – must be unique with the frame

◆ nBits

nBits_type FrameCPP::Version_4::FrAdcDataNPS::nBits

protected

Number of bits in A/D output.

◆ sampleRate

sampleRate_type FrameCPP::Version_4::FrAdcDataNPS::sampleRate

protected

Data acquisition rate, samples per second.

◆ slope

slope_type FrameCPP::Version_4::FrAdcDataNPS::slope

protected

ADC calibration: input units/count.

◆ timeOffsetN

timeOffsetN_type FrameCPP::Version_4::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_4::FrAdcDataNPS::timeOffsetS

protected

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

◆ units

units_type FrameCPP::Version_4::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/Version4/FrAdcDataNPS.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version4/FrAdcDataNPS.hh
/home/abuild/rpmbuild/BUILD/ldas-tools-framecpp-3.0.4-build/ldas-tools-framecpp-3.0.4/src/Version4/FrAdcData.cc

Protected 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

timeOffsetS_type	timeOffsetS

timeOffsetN_type	timeOffsetN

fShift_type	fShift

dataValid_type	dataValid

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

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]

◆ sampleRate_type [1/2]

◆ sampleRate_type [2/2]

◆ slope_type [1/2]

◆ slope_type [2/2]

◆ timeOffsetN_type [1/2]

◆ timeOffsetN_type [2/2]

◆ timeOffsetS_type [1/2]

◆ timeOffsetS_type [2/2]

◆ units_type [1/2]

◆ units_type [2/2]

Constructor & Destructor Documentation

◆ FrAdcDataNPS() [1/6]

◆ FrAdcDataNPS() [2/6]

◆ FrAdcDataNPS() [3/6]

◆ FrAdcDataNPS() [4/6]

◆ FrAdcDataNPS() [5/6]

◆ FrAdcDataNPS() [6/6]

Member Function Documentation

◆ AppendComment() [1/2]

◆ AppendComment() [2/2]

◆ bytes() [1/2]

◆ bytes() [2/2]

◆ GetBias() [1/2]

◆ GetBias() [2/2]

◆ GetChannelGroup() [1/2]

◆ GetChannelGroup() [2/2]

◆ GetChannelNumber() [1/2]

◆ GetChannelNumber() [2/2]

◆ GetComment() [1/2]

◆ GetComment() [2/2]

◆ GetDataValid() [1/2]

◆ GetDataValid() [2/2]

◆ GetFShift() [1/2]

◆ GetFShift() [2/2]

◆ GetName() [1/2]

◆ GetName() [2/2]

◆ GetNBits() [1/2]

◆ GetNBits() [2/2]

◆ GetSampleRate() [1/2]

◆ GetSampleRate() [2/2]

◆ GetSlope() [1/2]

◆ GetSlope() [2/2]

◆ GetTimeOffsetN() [1/2]

◆ GetTimeOffsetN() [2/2]

◆ GetTimeOffsetS() [1/2]

◆ GetTimeOffsetS() [2/2]

◆ GetUnits() [1/2]

◆ GetUnits() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ SetBias() [1/2]

◆ SetBias() [2/2]

◆ SetDataValid() [1/2]

◆ SetDataValid() [2/2]

◆ SetSlope() [1/2]

◆ SetSlope() [2/2]

◆ SetTimeOffset() [1/2]