FrameCPP::Version_3::FrAdcData Class Reference

ADC Data Structure Definition. More...

#include <FrAdcData.hh>

Inheritance diagram for FrameCPP::Version_3::FrAdcData:

Collaboration diagram for FrameCPP::Version_3::FrAdcData:

Public Types
typedef FrAdcDataNPS	nps_type
typedef FrAdcDataPS	ps_type
typedef FrAdcDataNPS	nps_type
typedef FrAdcDataPS	ps_type
typedef STRING	name_type
typedef STRING	name_type
typedef STRING	comment_type
typedef STRING	comment_type
typedef FR_ADC_DATA_CRATE_TYPE	crate_type
typedef FR_ADC_DATA_CRATE_TYPE	crate_type
typedef FR_ADC_DATA_CHANNEL_TYPE	channel_type
typedef FR_ADC_DATA_CHANNEL_TYPE	channel_type
typedef FR_ADC_DATA_N_BITS_TYPE	nBits_type
typedef FR_ADC_DATA_N_BITS_TYPE	nBits_type
typedef FR_ADC_DATA_BIAS_TYPE	bias_type
typedef FR_ADC_DATA_BIAS_TYPE	bias_type
typedef FR_ADC_DATA_SLOPE_TYPE	slope_type
typedef FR_ADC_DATA_SLOPE_TYPE	slope_type
typedef STRING	units_type
typedef STRING	units_type
typedef FR_ADC_DATA_SAMPLERATE_TYPE	sampleRate_type
typedef FR_ADC_DATA_SAMPLERATE_TYPE	sampleRate_type
typedef FR_ADC_DATA_TIMEOFFSETS_TYPE	timeOffsetS_type
typedef FR_ADC_DATA_TIMEOFFSETS_TYPE	timeOffsetS_type
typedef FR_ADC_DATA_TIMEOFFSETN_TYPE	timeOffsetN_type
typedef FR_ADC_DATA_TIMEOFFSETN_TYPE	timeOffsetN_type
typedef FR_ADC_DATA_FSHIFT_TYPE	fShift_type
typedef FR_ADC_DATA_FSHIFT_TYPE	fShift_type
typedef FR_ADC_DATA_OVERRANGE_TYPE	overRange_type
typedef FR_ADC_DATA_OVERRANGE_TYPE	overRange_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef FrameSpec::version_type	frame_spec_version_type
typedef boost::shared_ptr< Object >	object_type
typedef boost::shared_ptr< Object >	object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef std::unique_ptr< Object >	unique_object_type
typedef object_type	demote_arg_type
typedef object_type	demote_arg_type
typedef object_type	demote_ret_type
typedef object_type	demote_ret_type
typedef object_type	promote_arg_type
typedef object_type	promote_arg_type
typedef object_type	promote_ret_type
typedef object_type	promote_ret_type

Public Member Functions
	FrAdcData ()
	Default constructor. More...
	FrAdcData (const FrAdcData &Source)
	FrAdcData (const std::string &name, crate_type crate, channel_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=FR_ADC_DATA_DEFAULT_BIAS, slope_type slope=FR_ADC_DATA_DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=FR_ADC_DATA_DEFAULT_FSHIFT, timeOffsetS_type timeOffsetS=FR_ADC_DATA_DEFAULT_TIME_OFFSET_S, timeOffsetN_type timeOffsetN=FR_ADC_DATA_DEFAULT_TIME_OFFSET_N, overRange_type overRange=FR_ADC_DATA_DEFAULT_OVER_RANGE)
	~FrAdcData ()
const std::string &	GetNameSlow () const
	Retrieve the name of the FrAdcData struture. More...
bool	operator== (const FrAdcData &RHS) const
bool	operator!= (const FrAdcData &RHS) const
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator More...
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)
void	SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
virtual FrAdcData *	Create (istream_type &Stream) const
	constructor - virtual More...
virtual void	Write (ostream_type &Stream) const
	Write object to the stream. More...
	FrAdcData ()
	Default constructor. More...
	FrAdcData (const FrAdcData &Source)
	FrAdcData (const std::string &name, crate_type crate, channel_type channel, nBits_type nBits, sampleRate_type sampleRate, bias_type bias=FR_ADC_DATA_DEFAULT_BIAS, slope_type slope=FR_ADC_DATA_DEFAULT_SLOPE, const std::string &units=FR_ADC_DATA_DEFAULT_UNITS(), fShift_type fShift=FR_ADC_DATA_DEFAULT_FSHIFT, timeOffsetS_type timeOffsetS=FR_ADC_DATA_DEFAULT_TIME_OFFSET_S, timeOffsetN_type timeOffsetN=FR_ADC_DATA_DEFAULT_TIME_OFFSET_N, overRange_type overRange=FR_ADC_DATA_DEFAULT_OVER_RANGE)
	~FrAdcData ()
const std::string &	GetNameSlow () const
	Retrieve the name of the FrAdcData struture. More...
bool	operator== (const FrAdcData &RHS) const
bool	operator!= (const FrAdcData &RHS) const
virtual bool	operator== (const Common::FrameSpec::Object &Obj) const
	comparison operator More...
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)
void	SetTimeOffset (INT_4U Seconds, INT_4U Nanoseconds)
virtual FrAdcData *	Create (istream_type &Stream) const
	constructor - virtual More...
virtual void	Write (ostream_type &Stream) const
	Write object to the stream. More...
void	AppendComment (const comment_type &Comment)
	Extend the comment associated with the FrAdcData structure. More...
void	AppendComment (const comment_type &Comment)
	Extend the comment associated with the FrAdcData structure. More...
const name_type &	GetName () const
	Return the name associate with the FrAdcData structure. More...
const name_type &	GetName () const
	Return the name associate with the FrAdcData structure. More...
const comment_type &	GetComment () const
	A brief description of the FrAdcData structure. More...
const comment_type &	GetComment () const
	A brief description of the FrAdcData structure. More...
channel_type	GetChannel () const
	The channel number for the FrAdcData. More...
channel_type	GetChannel () const
	The channel number for the FrAdcData. More...
crate_type	GetCrate () const
	The crate number for the FrAdcData. More...
crate_type	GetCrate () const
	The crate 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...
overRange_type	GetOverRange () const
	Retrieve the overRange value. More...
overRange_type	GetOverRange () const
	Retrieve the overRange value. More...
void	SetCrate (crate_type Value)
	Set the numeric crate id for the channel. More...
void	SetCrate (crate_type Value)
	Set the numeric crate id for the channel. More...
void	SetChannel (channel_type Value)
	Set the numeric id for the channel. More...
void	SetChannel (channel_type Value)
	Set the numeric id for the channel. More...
void	SetComment (const comment_type &comment)
	Set the comment associated with the FrAdcData structure. More...
void	SetComment (const comment_type &comment)
	Set the comment associated with the FrAdcData structure. More...
void	SetOverRange (overRange_type flag)
	Establish the value of the overRange field. More...
void	SetOverRange (overRange_type flag)
	Establish the value of the overRange field. More...
void	SetBias (bias_type bias)
	Establish the value of the bias field. More...
void	SetBias (bias_type bias)
	Establish the value of the bias field. More...
void	SetNBits (nBits_type NBits)
	The number of bits in the A/D output. More...
void	SetNBits (nBits_type NBits)
	The number of bits in the A/D output. More...
void	SetSampleRate (sampleRate_type SampleRate)
	Establish the value of the sampleRate field. More...
void	SetSampleRate (sampleRate_type SampleRate)
	Establish the value of the sampleRate field. More...
void	SetSlope (slope_type slope)
	Establish the value of the slope field. More...
void	SetSlope (slope_type slope)
	Establish the value of the slope field. More...
void	SetTimeOffset (timeOffsetS_type Seconds, timeOffsetN_type Nanoseconds)
	Establish the value of the timeOffset field. More...
void	SetTimeOffsetS (timeOffsetS_type time)
	Establish the value of the timeOffset field. More...
void	SetTimeOffsetS (timeOffsetS_type time)
	Establish the value of the timeOffset field. More...
void	SetTimeOffsetN (timeOffsetN_type time)
	Establish the value of the timeOffset field. More...
void	SetTimeOffsetN (timeOffsetN_type time)
	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 More...
virtual Object *	Create (std::istream &Buffer) const
	constructor - virtual More...
virtual Object *	Clone () const
	constructor - virtual copy constructor More...
virtual Object *	Clone () const
	constructor - virtual copy constructor More...
template<typename PreviousType , typename CurrentType >
FrameSpec::ObjectInterface::promote_ret_type	PromoteObject (FrameSpec::ObjectInterface::frame_spec_version_type Target, FrameSpec::ObjectInterface::frame_spec_version_type Source, FrameSpec::ObjectInterface::promote_arg_type Obj, IStream *Stream)
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 const char *	StructName ()
static const Common::Description *	StructDescription ()
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
static const char *	StructName ()
static const Common::Description *	StructDescription ()
static promote_ret_type	Promote (INT_2U Source, promote_arg_type Obj, istream_type *Stream)
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...

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
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Down grade an object. More...
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
	Upgrade an object. More...
virtual demote_ret_type	demote (INT_2U Target, demote_arg_type Obj, istream_type *Stream) const
	Down grade an object. More...
virtual promote_ret_type	promote (INT_2U Target, promote_arg_type Obj, istream_type *Stream) const
	Upgrade an object. More...
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. More...
void	write (Common::OStream &Stream) const
	Write contents to the stream. More...
bool	operator== (const FrAdcDataNPS &RHS) const
	Comparison operator. More...
virtual class_type	getClass () const
	Retrieve the class identifier. More...
virtual class_type	getClass () const
	Retrieve the class identifier. More...

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

Private Member Functions
	FrAdcData (istream_type &Stream)
void	copy_core (const FrAdcData &Source)
	FrAdcData (istream_type &Stream)
void	copy_core (const FrAdcData &Source)

Detailed Description

ADC Data Structure Definition.

Member Typedef Documentation

bias_type [1/2]

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

inherited

bias_type [2/2]

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

inherited

channel_type [1/2]

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

inherited

channel_type [2/2]

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

inherited

comment_type [1/2]

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

inherited

comment_type [2/2]

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

inherited

crate_type [1/2]

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

inherited

crate_type [2/2]

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

inherited

demote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_arg_type

inherited

demote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

demote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::demote_ret_type

inherited

frame_spec_version_type [1/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

frame_spec_version_type [2/2]

typedef FrameSpec::version_type FrameCPP::Common::FrameSpec::ObjectInterface::frame_spec_version_type

inherited

fShift_type [1/2]

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

inherited

fShift_type [2/2]

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

inherited

name_type [1/2]

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

inherited

name_type [2/2]

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

inherited

nBits_type [1/2]

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

inherited

nBits_type [2/2]

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

inherited

nps_type [1/2]

typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type

nps_type [2/2]

typedef FrAdcDataNPS FrameCPP::Version_3::FrAdcData::nps_type

object_type [1/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type

inherited

object_type [2/2]

typedef boost::shared_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::object_type

inherited

overRange_type [1/2]

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

inherited

overRange_type [2/2]

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

inherited

promote_arg_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_arg_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_arg_type

inherited

promote_ret_type [1/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

promote_ret_type [2/2]

typedef object_type FrameCPP::Common::FrameSpec::ObjectInterface::promote_ret_type

inherited

ps_type [1/2]

typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type

ps_type [2/2]

typedef FrAdcDataPS FrameCPP::Version_3::FrAdcData::ps_type

sampleRate_type [1/2]

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

inherited

sampleRate_type [2/2]

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

inherited

slope_type [1/2]

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

inherited

slope_type [2/2]

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

inherited

timeOffsetN_type [1/2]

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

inherited

timeOffsetN_type [2/2]

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

inherited

timeOffsetS_type [1/2]

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

inherited

timeOffsetS_type [2/2]

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

inherited

unique_object_type [1/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

unique_object_type [2/2]

typedef std::unique_ptr< Object > FrameCPP::Common::FrameSpec::ObjectInterface::unique_object_type

inherited

units_type [1/2]

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

inherited

units_type [2/2]

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

inherited

Constructor & Destructor Documentation

FrAdcData() [1/8]

FrAdcData::FrAdcData

(

)

Default constructor.

FrAdcData() [2/8]

FrameCPP::Version_3::FrAdcData::FrAdcData

(

const FrAdcData &

Source

)

FrAdcData() [3/8]

FrameCPP::Version_3::FrAdcData::FrAdcData	(	const std::string &	name,
		crate_type	crate,
		channel_type	channel,
		nBits_type	nBits,
		sampleRate_type	sampleRate,
		bias_type	bias = FR_ADC_DATA_DEFAULT_BIAS,
		slope_type	slope = FR_ADC_DATA_DEFAULT_SLOPE,
		const std::string &	units = FR_ADC_DATA_DEFAULT_UNITS(),
		fShift_type	fShift = FR_ADC_DATA_DEFAULT_FSHIFT,
		timeOffsetS_type	timeOffsetS = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S,
		timeOffsetN_type	timeOffsetN = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N,
		overRange_type	overRange = FR_ADC_DATA_DEFAULT_OVER_RANGE
	)

~FrAdcData() [1/2]

FrameCPP::Version_3::FrAdcData::~FrAdcData

(

)

FrAdcData() [4/8]

FrameCPP::Version_3::FrAdcData::FrAdcData ( istream_type &  Stream )

private

FrAdcData() [5/8]

FrameCPP::Version_3::FrAdcData::FrAdcData

(

)

Default constructor.

FrAdcData() [6/8]

FrameCPP::Version_3::FrAdcData::FrAdcData

(

const FrAdcData &

Source

)

FrAdcData() [7/8]

FrameCPP::Version_3::FrAdcData::FrAdcData	(	const std::string &	name,
		crate_type	crate,
		channel_type	channel,
		nBits_type	nBits,
		sampleRate_type	sampleRate,
		bias_type	bias = FR_ADC_DATA_DEFAULT_BIAS,
		slope_type	slope = FR_ADC_DATA_DEFAULT_SLOPE,
		const std::string &	units = FR_ADC_DATA_DEFAULT_UNITS(),
		fShift_type	fShift = FR_ADC_DATA_DEFAULT_FSHIFT,
		timeOffsetS_type	timeOffsetS = FR_ADC_DATA_DEFAULT_TIME_OFFSET_S,
		timeOffsetN_type	timeOffsetN = FR_ADC_DATA_DEFAULT_TIME_OFFSET_N,
		overRange_type	overRange = FR_ADC_DATA_DEFAULT_OVER_RANGE
	)

~FrAdcData() [2/2]

FrameCPP::Version_3::FrAdcData::~FrAdcData

(

)

FrAdcData() [8/8]

FrameCPP::Version_3::FrAdcData::FrAdcData ( istream_type &  Stream )

private

Member Function Documentation

AppendComment() [1/2]

void FrAdcDataNPS::AppendComment ( const comment_type &  Comment )

inlineinherited

Extend the comment associated with the FrAdcData structure.

AppendComment() [2/2]

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

inherited

Extend the comment associated with the FrAdcData structure.

Bytes() [1/2]

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

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

Clone() [1/2]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const

virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

Clone() [2/2]

virtual Object* FrameCPP::Common::FrameSpec::ObjectInterface::Clone ( ) const

virtualinherited

constructor - virtual copy constructor

Reimplemented in FrameCPP::Version_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_4::FrStatData, FrameCPP::Version_4::FrStatData, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Common::StreamRef2< LT, CKT, CT, IT >, FrameCPP::Version_3::FrStatData, FrameCPP::Version_3::FrStatData, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrStatData, FrameCPP::Version_8::FrStatData, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Common::PTR_STRUCT< DC, DI >, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Common::PTR_STRUCT_BASE, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSH, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrSE, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_6::FrStatData, FrameCPP::Version_6::FrStatData, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_3::FrSE, FrameCPP::Version_3::FrSE, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Common::StreamRef< LT, CT, IT >, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrSH, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

copy_core() [1/2]

void FrameCPP::Version_3::FrAdcData::copy_core ( const FrAdcData &  Source )

private

copy_core() [2/2]

void FrameCPP::Version_3::FrAdcData::copy_core ( const FrAdcData &  Source )

private

Create() [1/4]

virtual FrAdcData* FrameCPP::Version_3::FrAdcData::Create ( istream_type &  Stream ) const

virtual

constructor - virtual

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

Create() [2/4]

virtual FrAdcData* FrameCPP::Version_3::FrAdcData::Create ( istream_type &  Stream ) const

virtual

constructor - virtual

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

Create() [3/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( ) const

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrTOC, FrameCPP::Version_8::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_6::FrTOC, FrameCPP::Version_4::FrTOC, and FrameCPP::Version_4::FrTOC.

Create() [4/4]

FrameSpec::Object * FrameCPP::Common::FrameSpec::ObjectInterface::Create ( std::istream &  Buffer ) const

virtualinherited

constructor - virtual

Reimplemented in FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrSH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameSpec::Object, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrDetector, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrameH, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrTOC, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Common::FrameSpec::ObjectWithChecksum< Common::FrStatData, checksum_type >, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_3::FrHeader, and FrameCPP::Version_3::FrHeader.

demote() [1/2]

virtual demote_ret_type FrameCPP::Version_3::FrAdcData::demote ( INT_2U  Target, demote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Down grade an object.

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

demote() [2/2]

virtual demote_ret_type FrameCPP::Version_3::FrAdcData::demote ( INT_2U  Target, demote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Down grade an object.

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

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

inherited

DC bias on channel.

Returns

DC bias on channel.

GetChannel() [1/2]

FrAdcDataNPS::channel_type FrAdcDataNPS::GetChannel ( ) const

inlineinherited

The channel number for the FrAdcData.

Returns

The channel number for the FrAdcData

GetChannel() [2/2]

channel_type FrameCPP::Version_3::FrAdcDataNPS::GetChannel ( ) 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.

getClass() [1/2]

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

protectedvirtualinherited

Retrieve the class identifier.

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

getClass() [2/2]

virtual class_type FrameCPP::Common::FrameSpec::Object::getClass ( ) const

protectedvirtualinherited

Retrieve the class identifier.

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

GetComment() [1/2]

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

inlineinherited

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

inherited

A brief description of the FrAdcData structure.

Returns

A brief description of the FrAdcData structure

GetCrate() [1/2]

FrAdcDataNPS::crate_type FrAdcDataNPS::GetCrate ( ) const

inlineinherited

The crate number for the FrAdcData.

Returns

The crate number for the FrAdcData

GetCrate() [2/2]

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

inherited

The crate number for the FrAdcData.

Returns

The crate number for the FrAdcData

GetDescription() [1/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.

GetDescription() [2/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.

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

GetName() [1/2]

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

inlineinherited

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

inherited

Return the name associate with the FrAdcData structure.

Returns

The name associated with the FrAdcData structure

GetNameSlow() [1/2]

const std::string& FrameCPP::Version_3::FrAdcData::GetNameSlow

(

)

const

Retrieve the name of the FrAdcData struture.

GetNameSlow() [2/2]

const std::string& FrameCPP::Version_3::FrAdcData::GetNameSlow

(

)

const

Retrieve the name of the FrAdcData struture.

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

inherited

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

inlineinherited

Retrieve the overRange value.

Returns

The value of the overRange field.

GetOverRange() [2/2]

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

inherited

Retrieve the overRange value.

Returns

The value of the overRange field.

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

inherited

The data acquisition rate.

Returns

The data acquisition rate.

GetSlope() [1/2]

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

inherited

ADC calibration units per count.

Returns

ADC calibration units per count.

GetSlope() [2/2]

FrAdcDataNPS::slope_type FrAdcDataNPS::GetSlope ( ) const

inlineinherited

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_3::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_3::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]

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

inherited

The units used in the ADC calibration.

Returns

The units used in the ADC calibration

Merge() [1/2]

FrAdcData& FrameCPP::Version_3::FrAdcData::Merge

(

const FrAdcData &

RHS

)

Merge() [2/2]

FrAdcData& FrameCPP::Version_3::FrAdcData::Merge

(

const FrAdcData &

RHS

)

ObjectStructName() [1/2]

virtual const char* FrameCPP::Version_3::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]

virtual const char* FrameCPP::Version_3::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.

operator!=() [1/2]

bool FrameCPP::Version_3::FrAdcData::operator!= ( const FrAdcData &  RHS ) const

inline

operator!=() [2/2]

bool FrameCPP::Version_3::FrAdcData::operator!=

(

const FrAdcData &

RHS

)

const

operator==() [1/5]

bool FrameCPP::Version_3::FrAdcData::operator== ( const FrAdcData &  RHS ) const

inline

operator==() [2/5]

bool FrameCPP::Version_3::FrAdcData::operator==

(

const FrAdcData &

RHS

)

const

operator==() [3/5]

virtual bool FrameCPP::Version_3::FrAdcData::operator== ( const Common::FrameSpec::Object &  Obj ) const

virtual

comparison operator

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

operator==() [4/5]

virtual bool FrameCPP::Version_3::FrAdcData::operator== ( const Common::FrameSpec::Object &  Obj ) const

virtual

comparison operator

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

operator==() [5/5]

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

inlineprotectedinherited

Comparison operator.

Promote() [1/2]

FrAdcData::promote_ret_type FrameCPP::Version_3::FrAdcData::Promote ( INT_2U  Source, promote_arg_type  Obj, istream_type *  Stream  )

inlinestatic

Promote() [2/2]

static promote_ret_type FrameCPP::Version_3::FrAdcData::Promote ( INT_2U  Source, promote_arg_type  Obj, istream_type *  Stream  )

static

promote() [1/2]

virtual promote_ret_type FrameCPP::Version_3::FrAdcData::promote ( INT_2U  Target, promote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Upgrade an object.

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

promote() [2/2]

virtual promote_ret_type FrameCPP::Version_3::FrAdcData::promote ( INT_2U  Target, promote_arg_type  Obj, istream_type *  Stream  ) const

protectedvirtual

Upgrade an object.

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

PromoteObject() [1/5]

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() [2/5]

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() [3/5]

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/5]

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() [5/5]

template<typename PreviousType , typename CurrentType >

FrameSpec::ObjectInterface::promote_ret_type FrameCPP::Common::FrameSpec::ObjectInterface::PromoteObject ( FrameSpec::ObjectInterface::frame_spec_version_type  Target, FrameSpec::ObjectInterface::frame_spec_version_type  Source, FrameSpec::ObjectInterface::promote_arg_type  Obj, IStream *  Stream  )

inherited

SetBias() [1/2]

void FrAdcDataNPS::SetBias ( bias_type  bias )

inlineinherited

Establish the value of the bias field.

Parameters

[in]

bias

The desired value of the bias field.

SetBias() [2/2]

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

inherited

Establish the value of the bias field.

Parameters

[in]

bias

The desired value of the bias field.

SetChannel() [1/2]

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

inherited

Set the numeric id for the channel.

SetChannel() [2/2]

void FrAdcDataNPS::SetChannel ( channel_type  Value )

inlineinherited

Set the numeric id for the channel.

SetComment() [1/2]

void FrAdcDataNPS::SetComment ( const comment_type &  comment )

inlineinherited

Set the comment associated with the FrAdcData structure.

SetComment() [2/2]

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

inherited

Set the comment associated with the FrAdcData structure.

SetCrate() [1/2]

void FrAdcDataNPS::SetCrate ( crate_type  Value )

inlineinherited

Set the numeric crate id for the channel.

SetCrate() [2/2]

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

inherited

Set the numeric crate id for the channel.

SetNBits() [1/2]

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

inherited

The number of bits in the A/D output.

Parameters

[in]

NBits

Tne number of bits in the A/D output.

SetNBits() [2/2]

void FrAdcDataNPS::SetNBits ( nBits_type  NBits )

inlineinherited

The number of bits in the A/D output.

Parameters

[in]

NBits

Tne number of bits in the A/D output.

SetOverRange() [1/2]

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

inherited

Establish the value of the overRange field.

Parameters

[in]

flag

The desired value of the overRange field.

SetOverRange() [2/2]

void FrAdcDataNPS::SetOverRange ( overRange_type  flag )

inlineinherited

Establish the value of the overRange field.

Parameters

[in]

flag

The desired value of the overRange field.

SetSampleRate() [1/2]

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

inherited

Establish the value of the sampleRate field.

Parameters

[in]

SampleRate

The desired value of the sampleRate field.

SetSampleRate() [2/2]

void FrAdcDataNPS::SetSampleRate ( sampleRate_type  SampleRate )

inlineinherited

Establish the value of the sampleRate field.

Parameters

[in]

SampleRate

The desired value of the sampleRate field.

SetSlope() [1/2]

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

inherited

Establish the value of the slope field.

Parameters

[in]

slope

The desired value of the slope field.

SetSlope() [2/2]

void FrAdcDataNPS::SetSlope ( slope_type  slope )

inlineinherited

Establish the value of the slope field.

Parameters

[in]

slope

The desired value of the slope field.

SetTimeOffset() [1/3]

void FrameCPP::Version_3::FrAdcData::SetTimeOffset	(	INT_4U	Seconds,
		INT_4U	Nanoseconds
	)

SetTimeOffset() [2/3]

void FrameCPP::Version_3::FrAdcData::SetTimeOffset	(	INT_4U	Seconds,
		INT_4U	Nanoseconds
	)

SetTimeOffset() [3/3]

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

inlineinherited

Establish the value of the timeOffset field.

SetTimeOffsetN() [1/2]

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

inherited

Establish the value of the timeOffset field.

Parameters

[in]

time

The desired value of the timeOffset field.

SetTimeOffsetN() [2/2]

void FrAdcDataNPS::SetTimeOffsetN ( timeOffsetN_type  time )

inlineinherited

Establish the value of the timeOffset field.

Parameters

[in]

time

The desired value of the timeOffset field.

SetTimeOffsetS() [1/2]

void FrAdcDataNPS::SetTimeOffsetS ( timeOffsetS_type  time )

inlineinherited

Establish the value of the timeOffset field.

Parameters

[in]

time

The desired value of the timeOffset field.

SetTimeOffsetS() [2/2]

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

inherited

Establish the value of the timeOffset field.

Parameters

[in]

time

The desired value of the timeOffset field.

StructDescription() [1/2]

static const Common::Description* FrameCPP::Version_3::FrAdcData::StructDescription ( )

static

StructDescription() [2/2]

static const Common::Description* FrameCPP::Version_3::FrAdcData::StructDescription ( )

static

StructName() [1/2]

static const char* FrameCPP::Version_3::FrAdcData::StructName ( )

static

StructName() [2/2]

const char * FrameCPP::Version_3::FrAdcData::StructName ( )

inlinestatic

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_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.

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_6::FrameH, FrameCPP::Version_6::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_4::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_3::FrameH, FrameCPP::Version_8::FrVect, FrameCPP::Version_8::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_3::FrVect, FrameCPP::Version_8::FrameH, FrameCPP::Version_8::FrameH, FrameCPP::Version_6::FrVect, FrameCPP::Version_6::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_4::FrVect, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrEndOfFile, FrameCPP::Version_8::FrHeader, FrameCPP::Version_8::FrHeader, FrameCPP::Version_7::FrameH, FrameCPP::Version_7::FrameH, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_6::FrEndOfFile, FrameCPP::Version_3::FrHeader, FrameCPP::Version_3::FrHeader, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_4::FrEndOfFile, FrameCPP::Version_3::FrEndOfFile, and FrameCPP::Version_3::FrEndOfFile.

Write() [1/2]

virtual void FrameCPP::Version_3::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_3::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() [1/2]

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

protectedinherited

Write contents to the stream.

write() [2/2]

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

protectedinherited

Write contents to the stream.

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)

channel

channel_type FrAdcDataNPS::channel

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.

crate

crate_type FrAdcDataNPS::crate

protectedinherited

Channel grouping number containing ADC.

Note

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

DEFAULT_BIAS

static const bias_type FrAdcDataNPS::DEFAULT_BIAS

staticinherited

Initial value:

=
    FR_ADC_DATA_DEFAULT_BIAS

DEFAULT_FSHIFT

static const fShift_type FrAdcDataNPS::DEFAULT_FSHIFT

staticinherited

Initial value:

=
    FR_ADC_DATA_DEFAULT_FSHIFT

DEFAULT_OVER_RANGE

static const overRange_type FrAdcDataNPS::DEFAULT_OVER_RANGE

staticinherited

Initial value:

=
    FR_ADC_DATA_DEFAULT_OVER_RANGE

DEFAULT_SLOPE

static const slope_type FrAdcDataNPS::DEFAULT_SLOPE

staticinherited

Initial value:

=
    FR_ADC_DATA_DEFAULT_SLOPE

DEFAULT_TIME_OFFSET_N

static const timeOffsetN_type FrAdcDataNPS::DEFAULT_TIME_OFFSET_N

staticinherited

Initial value:

=
    FR_ADC_DATA_DEFAULT_TIME_OFFSET_N

DEFAULT_TIME_OFFSET_S

static const timeOffsetS_type FrAdcDataNPS::DEFAULT_TIME_OFFSET_S

staticinherited

Initial value:

=
    FR_ADC_DATA_DEFAULT_TIME_OFFSET_S

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.

overRange

overRange_type FrAdcDataNPS::overRange

protectedinherited

Data valid flag

Note

overRange = 0 -> ADC ddata valid; overRange != 0 -> ADC data suspect/not valid

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/Version3/FrAdcData.hh
• Version3/FrAdcData.cc