ADC Data Structure Definition. More...

#include <FrAdcData.hh>

Inheritance diagram for FrameCPP::Version_4::FrAdcData:

Collaboration diagram for FrameCPP::Version_4::FrAdcData:

Public Member Functions
	FrAdcData ()
	Default constructor.

	FrAdcData (const FrAdcData &Source)
	Copy constructor.

virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator

cmn_streamsize_type	Bytes (const Common::StreamBase &Stream) const
	Return the number of bytes for this object. More...

virtual const char *	ObjectStructName () const
	Retrieve the class name of the object. More...

FrAdcData &	Merge (const FrAdcData &RHS)

virtual FrAdcData *	Create (istream_type &Stream) const
	constructor - virtual

virtual void	Write (ostream_type &Stream) const
	Write object to the stream. More...

	FrAdcData ()
	Default constructor.

	FrAdcData (const FrAdcData &Source)
	Copy constructor.

virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator

cmn_streamsize_type	Bytes (const Common::StreamBase &Stream) const
	Return the number of bytes for this object. More...

virtual const char *	ObjectStructName () const
	Retrieve the class name of the object. More...

virtual FrAdcData *	Create (istream_type &Stream) const
	constructor - virtual

virtual void	Write (ostream_type &Stream) const
	Write object to the stream. More...

const std::string &	GetComment () const
	A brief description of 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...

channelGroup_type	GetChannelGroup () const
	The channel group for the FrAdcData. More...

channelNumber_type	GetChannelNumber () const
	The channel number 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...

nBits_type	GetNBits () const
	Tne number of bits in the A/D output. More...

bias_type	GetBias () const
	DC bias on channel. More...

bias_type	GetBias () const
	DC bias on channel. More...

slope_type	GetSlope () const
	ADC calibration units per count. More...

slope_type	GetSlope () const
	ADC calibration units per count. More...

STRING	GetUnits () const
	The units used in the ADC calibration. More...

STRING	GetUnits () const
	The units used in the ADC calibration. More...

sampleRate_type	GetSampleRate () const
	The data acquisition rate. 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...

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

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

fShift_type	GetFShift () const
	The frequency in the original data corresponding to 0 Hz. More...

dataValid_type	GetDataValid () const
	Retrieve the overRange value. More...

dataValid_type	GetDataValid () const
	Retrieve the overRange value. More...

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

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

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

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

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

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

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

void	SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
	Establish the value of the timeOffset field. More...

void	SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
	Establish the value of the timeOffset field. More...

class_type	GetClass () const
	Retrieve the class identifier. More...

class_type	GetClass () const
	Retrieve the class identifier. More...

const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object. More...

const Description *	GetDescription () const
	Retrieve FrSH/FrSE description of the parent object. More...

ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream. More...

ostream_type &	WriteNext (ostream_type &Stream) const
	Write a next pointer to the parent to the stream. More...

virtual Object *	Create () const
	constructor - virtual

virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual

virtual Object *	Clone () const
	constructor - virtual copy constructor

virtual Object *	Clone () const
	constructor - virtual copy constructor

virtual void	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object. More...

virtual void	VerifyObject (Verify &Verifier, IFrameStream &Stream) const
	Verify an object. More...

Static Public Member Functions
static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
	Down grade an object. More...

static object_type	DemoteObject (frame_spec_version_type Target, object_type Obj, istream_type *Stream)
	Down grade an object. More...

static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

template<typename PreviousType , typename CurrentType >
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

template<typename PreviousType , typename CurrentType >
static object_type	PromoteObject (frame_spec_version_type Target, frame_spec_version_type Source, object_type Obj, istream_type *Stream)
	Upgrade an object. More...

Protected Member Functions
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Down grade an object.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
	Upgrade an object.

virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Down grade an object.

virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
	Upgrade an object.

cmn_streamsize_type	bytes (const Common::StreamBase &Stream) const
	Number of bytes needed to write this structure. 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.

void	write (Common::OStream &Stream) const
	Write contents to the stream.

bool	operator== (const FrAdcDataNPS &RHS) const
	Comparison operator.

virtual class_type	getClass () const
	Retrieve the class identifier.

virtual class_type	getClass () const
	Retrieve the class identifier.

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

Detailed Description

ADC Data Structure Definition.

Member Function Documentation

◆ Bytes() [1/2]

cmn_streamsize_type FrameCPP::Version_4::FrAdcData::Bytes ( const Common::StreamBase & Stream ) const

virtual

Return the number of bytes for this object.

Parameters

[in] Stream The stream on which the object will be written or read.

Returns: The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Bytes() [2/2]

FrameCPP::cmn_streamsize_type FrameCPP::Version_4::FrAdcData::Bytes ( const Common::StreamBase & Stream ) const

virtual

Return the number of bytes for this object.

Parameters

[in] Stream The stream on which the object will be written or read.

Returns: The number of bytes required by this object for the specified stream.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ bytes() [1/2]

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

inlineprotectedinherited

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

protectedinherited

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.

◆ DemoteObject() [1/2]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject	(	frame_spec_version_type	Target,
		object_type	Obj,
		istream_type *	Stream
	)

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns: A pointer to the objected derived by demoting Obj.

◆ DemoteObject() [2/2]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::DemoteObject	(	frame_spec_version_type	Target,
		object_type	Obj,
		istream_type *	Stream
	)

staticinherited

Down grade an object.

Parameters

[in]	Target	This is the version of the frame specification of the demoted object.
[in]	Obj	The base object.
[in]	Stream	Stream from which Obj was created.

Returns: A pointer to the objected derived by demoting Obj.

◆ GetBias() [1/2]

FrAdcDataNPS::bias_type FrAdcDataNPS::GetBias ( ) const

inlineinherited

DC bias on channel.

Returns: DC bias on channel.

◆ GetBias() [2/2]

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

inherited

DC bias on channel.

Returns: DC bias on channel.

◆ GetChannelGroup() [1/2]

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

inherited

The channel group for the FrAdcData.

Returns: The crate number for the FrAdcData

◆ GetChannelGroup() [2/2]

FrAdcDataNPS::channelGroup_type FrAdcDataNPS::GetChannelGroup ( ) const

inlineinherited

The channel group for the FrAdcData.

Returns: The crate number for the FrAdcData

◆ GetChannelNumber() [1/2]

FrAdcDataNPS::channelNumber_type FrAdcDataNPS::GetChannelNumber ( ) const

inlineinherited

The channel number for the FrAdcData.

Returns: The channel number for the FrAdcData

◆ GetChannelNumber() [2/2]

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

inherited

The channel number for the FrAdcData.

Returns: The channel number for the FrAdcData

◆ GetClass() [1/2]

FrameSpec::class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inlineinherited

Retrieve the class identifier.

Returns: The class identifier.

◆ GetClass() [2/2]

class_type FrameCPP::Common::FrameSpec::Object::GetClass ( ) const

inherited

Retrieve the class identifier.

Returns: The class identifier.

◆ GetComment() [1/2]

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

inherited

A brief description of the FrAdcData structure.

Returns: A brief description of the FrAdcData structure

◆ GetComment() [2/2]

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

inlineinherited

A brief description of the FrAdcData structure.

Returns: A brief description of the FrAdcData structure

◆ GetDataValid() [1/2]

INT_2U FrAdcDataNPS::GetDataValid ( ) const

inlineinherited

Retrieve the overRange value.

Returns: The value of the overRange field.

◆ GetDataValid() [2/2]

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

inherited

Retrieve the overRange value.

Returns: The value of the overRange field.

◆ GetDescription() [1/2]

const Description* FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

virtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns: The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetDescription() [2/2]

const Description * FrameCPP::Common::FrameSpec::Object::GetDescription ( ) const

inlinevirtualinherited

Retrieve FrSH/FrSE description of the parent object.

Returns: The description of the parent class.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ GetFShift() [1/2]

FrAdcDataNPS::fShift_type FrAdcDataNPS::GetFShift ( ) const

inlineinherited

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

inherited

The frequency in the original data corresponding to 0 Hz.

Returns: The frequency in the original data corresponding to 0 Hz.

◆ GetNBits() [1/2]

FrAdcDataNPS::nBits_type FrAdcDataNPS::GetNBits ( ) const

inlineinherited

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

inherited

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 FrAdcDataNPS::GetSampleRate ( ) const

inlineinherited

The data acquisition rate.

Returns: The data acquisition rate.

◆ GetSampleRate() [2/2]

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

inherited

The data acquisition rate.

Returns: The data acquisition rate.

◆ GetSlope() [1/2]

FrAdcDataNPS::slope_type FrAdcDataNPS::GetSlope ( ) const

inlineinherited

ADC calibration units per count.

Returns: ADC calibration units per count.

◆ GetSlope() [2/2]

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

inherited

ADC calibration units per count.

Returns: ADC calibration units per count.

◆ GetTimeOffsetN() [1/2]

FrAdcDataNPS::timeOffsetN_type FrAdcDataNPS::GetTimeOffsetN ( ) const

inlineinherited

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

inherited

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 FrAdcDataNPS::GetTimeOffsetS ( ) const

inlineinherited

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

inherited

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 FrAdcDataNPS::GetUnits ( ) const

inlineinherited

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

inherited

The units used in the ADC calibration.

Returns: The units used in the ADC calibration

◆ Merge()

FrAdcData & FrameCPP::Version_4::FrAdcData::Merge ( const FrAdcData & RHS )

Todo:: Need to implement Merge routine

◆ ObjectStructName() [1/2]

virtual const char* FrameCPP::Version_4::FrAdcData::ObjectStructName ( ) const

virtual

Retrieve the class name of the object.

Returns: The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ ObjectStructName() [2/2]

const char * FrameCPP::Version_4::FrAdcData::ObjectStructName ( ) const

virtual

Retrieve the class name of the object.

Returns: The name of the class associated with the object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ PromoteObject() [1/4]

FrameSpec::ObjectInterface::object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		istream_type *	Stream
	)

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [2/4]

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		istream_type *	Stream
	)

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [3/4]

template<typename PreviousType , typename CurrentType >

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		istream_type *	Stream
	)

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ PromoteObject() [4/4]

template<typename PreviousType , typename CurrentType >

static object_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject	(	frame_spec_version_type	Target,
		frame_spec_version_type	Source,
		object_type	Obj,
		istream_type *	Stream
	)

staticinherited

Upgrade an object.

Parameters

[in]	Target	Promote Obj to this version of the frame specification.
[in]	Source	Obj conforms to this version of the frame specification.
[in]	Obj	Object to be converted
[in]	Stream	Originating stream for Obj.

Returns: A pointer to the objected derived by promoting Obj.

◆ SetBias() [1/2]

void FrAdcDataNPS::SetBias ( REAL_4 Value )

inlineinherited

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 )

inherited

Establish the value of the bias field.

Parameters

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

◆ SetDataValid() [1/2]

void FrAdcDataNPS::SetDataValid ( INT_2U flag )

inlineinherited

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 )

inherited

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 )

inherited

Establish the value of the slope field.

Parameters

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

◆ SetSlope() [2/2]

void FrAdcDataNPS::SetSlope ( REAL_4 Value )

inlineinherited

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
	)

inherited

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 FrAdcDataNPS::SetTimeOffset	(	INT_4U	Seconds,
		INT_4U	Nanoseconds
	)

inlineinherited

Establish the value of the timeOffset field.

Parameters

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

◆ VerifyObject() [1/2]

virtual void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject	(	Verify &	Verifier,
		IFrameStream &	Stream
	)		const

virtualinherited

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, and FrameCPP::Version_8::FrHeader.

◆ VerifyObject() [2/2]

void FrameCPP::Common::FrameSpec::ObjectInterface::VerifyObject	(	Verify &	Verifier,
		IFrameStream &	Stream
	)		const

virtualinherited

Verify an object.

Parameters

[in,out]	Verifier	Set of rules to use in verification of the object. If an error occurs, the violation is logged here.
[in]	Stream	The stream that is being used to read the object.

Reimplemented in FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, and FrameCPP::Version_8::FrHeader.

◆ Write() [1/2]

void FrameCPP::Version_4::FrAdcData::Write ( ostream_type & Stream ) const

virtual

Write object to the stream.

Parameters

[in,out] Stream The stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ Write() [2/2]

virtual void FrameCPP::Version_4::FrAdcData::Write ( ostream_type & Stream ) const

virtual

Write object to the stream.

Parameters

[in,out] Stream The stream being written with the contents of object.

Implements FrameCPP::Common::FrameSpec::ObjectInterface.

◆ WriteNext() [1/2]

ostream_type& FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream ) const

inherited

Write a next pointer to the parent to the stream.

Parameters

[in,out] Stream The output stream to receive the next pointer.

Returns: The output stream.

◆ WriteNext() [2/2]

ostream_type & FrameCPP::Common::FrameSpec::Object::WriteNext ( ostream_type & Stream ) const

inherited

Write a next pointer to the parent to the stream.

Parameters

[in,out] Stream The output stream to receive the next pointer.

Returns: The output stream.

Member Data Documentation

◆ bias

bias_type FrAdcDataNPS::bias

protectedinherited

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

◆ channelGroup

channelGroup_type FrAdcDataNPS::channelGroup

protectedinherited

Channel grouping number containing ADC.

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

◆ channelNumber

channelNumber_type FrAdcDataNPS::channelNumber

protectedinherited

Channel number

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

◆ comment

comment_type FrAdcDataNPS::comment

protectedinherited

Comment for the ADC.

◆ dataValid

dataValid_type FrAdcDataNPS::dataValid

protectedinherited

Data valid flag

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

◆ fShift

fShift_type FrAdcDataNPS::fShift

protectedinherited

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

protectedinherited

Channel name – must be unique with the frame

◆ nBits

nBits_type FrAdcDataNPS::nBits

protectedinherited

Number of bits in A/D output.

◆ sampleRate

sampleRate_type FrAdcDataNPS::sampleRate

protectedinherited

Data acquisition rate, samples per second.

◆ slope

slope_type FrAdcDataNPS::slope

protectedinherited

ADC calibration: input units/count.

◆ timeOffsetN

timeOffsetN_type FrAdcDataNPS::timeOffsetN

protectedinherited

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

◆ timeOffsetS

timeOffsetS_type FrAdcDataNPS::timeOffsetS

protectedinherited

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

◆ units

units_type FrAdcDataNPS::units

protectedinherited

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-2.7.0/include/framecpp/Version4/FrAdcData.hh
Version4/FrAdcData.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ Bytes() [1/2]

◆ Bytes() [2/2]

◆ bytes() [1/2]

◆ bytes() [2/2]

◆ DemoteObject() [1/2]

◆ DemoteObject() [2/2]

◆ GetBias() [1/2]

◆ GetBias() [2/2]

◆ GetChannelGroup() [1/2]

◆ GetChannelGroup() [2/2]

◆ GetChannelNumber() [1/2]

◆ GetChannelNumber() [2/2]

◆ GetClass() [1/2]

◆ GetClass() [2/2]

◆ GetComment() [1/2]

◆ GetComment() [2/2]

◆ GetDataValid() [1/2]

◆ GetDataValid() [2/2]

◆ GetDescription() [1/2]

◆ GetDescription() [2/2]

◆ GetFShift() [1/2]

◆ GetFShift() [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]

◆ Merge()

◆ ObjectStructName() [1/2]

◆ ObjectStructName() [2/2]

◆ PromoteObject() [1/4]

◆ PromoteObject() [2/4]

◆ PromoteObject() [3/4]

◆ PromoteObject() [4/4]

◆ SetBias() [1/2]

◆ SetBias() [2/2]

◆ SetDataValid() [1/2]

◆ SetDataValid() [2/2]

◆ SetSlope() [1/2]

◆ SetSlope() [2/2]

◆ SetTimeOffset() [1/2]

◆ SetTimeOffset() [2/2]

◆ VerifyObject() [1/2]

◆ VerifyObject() [2/2]

◆ Write() [1/2]

◆ Write() [2/2]

◆ WriteNext() [1/2]

◆ WriteNext() [2/2]

Member Data Documentation

◆ bias

◆ channelGroup

◆ channelNumber

◆ comment

◆ dataValid

◆ fShift

◆ name

◆ nBits

◆ sampleRate

◆ slope

◆ timeOffsetN

◆ timeOffsetS

◆ units