SctData::ChipConfiguration Class Reference

This class represents the configuration of a chip. More...

#include <ChipConfiguration.h>

Inheritance diagram for SctData::ChipConfiguration:

[legend]Collaboration diagram for SctData::ChipConfiguration:

[legend]

Public Member Functions
	ChipConfiguration (ABCDChip &chipConfig) throw ()
virtual std::string	getClassName () const throw ()
	Get the class name for this object.
bool	isActive () const throw ()
	true if chip is participating in a scan
void	setActive (const bool active) throw ()
	set the chip activity status active if set true
unsigned char	getAddress () const throw ()
	There is a had-coded address associated with each chip position on the module.
unsigned char	getTrimTarget () const throw ()
	the trim target in steps of 2.5 mV
void	setTrimTarget (const unsigned char target) throw (LogicError)
	set the trim target target in steps of 2.5 mV
unsigned char	getTrim (unsigned int channel) const throw (LogicError)
	get the trim channel 0->127 trim 0->15
void	setTrim (const unsigned channel, const unsigned char trim) throw (LogicError)
	set the trim channel 0->127 trim 0->15
unsigned char	getThreshold () const throw ()
	get the value of the threshold in UNITS?
void	setThreshold (const unsigned char threshold) throw (LogicError)
	set the threhold in UNITS?
unsigned char	getCalCharge () const throw ()
	get the value of the calibration charge
void	setCalCharge (const unsigned char calCharge) throw ()
	set the value of the calibration charge in UNITS
unsigned char	getStrobeDelay () const throw ()
	get the value of the strobe delay in UNITS
void	setStrobeDelay (const unsigned char strobeDelay) throw (LogicError)
	set the value of the strobe delay in UNITS
void	resetMask () throw ()
	unmask all channels
void	setMask (const unsigned ichannel, const bool value) throw (LogicError)
	mask mutator channel index 0->127 mask if true, unmask if false
void	mask (const unsigned ichannel) throw (LogicError)
	mask mutator channel index 0->127
void	unmask (const unsigned ichannel) throw (LogicError)
	mask mutator channel index 0->127
bool	isMasked (const unsigned ichannel) const throw (LogicError)
	mask access true if channel is masked channel index 0->127
unsigned char	getTrimRange () const throw ()
void	setTrimRange (const unsigned char) throw (LogicError)
char	getRcFunctionIndex () const throw ()
void	setRcFunctionIndex (const char) throw (LogicError)
	Response curve function index.
double	getRcParam (const unsigned ipar) const throw (LogicError)
	Get the response curve parameter index of parameter 0->2; value of parameter.
void	setRcParam (const unsigned ipar, const double val) const throw (LogicError)
	Set the response curve parameter.
void	setCalFactor (const float factor) throw ()
	theshold calibration factor by which the nominal threshold must be multiplied
float	getCalFactor () const throw ()
	accessor @}
void	setMaster (bool value) throw ()
void	setEnd (bool value) throw ()
void	setFeedThrough (bool value) throw ()
void	setInputBypass (bool value) throw ()
void	setOutputBypass (bool value) throw ()
bool	isMaster () const throw ()
bool	isEnd () const throw ()
bool	isFeedThrough () const throw ()
bool	isInputBypass () const throw ()
bool	isOutputBypass () const throw ()
const ABCDChip &	getConfig () const
	Get const reference to underlying ABCDChip - used by IO.
ABCDChip &	getConfig ()
	Get non-const reference to underlying ABCDChip - used by IO.
Private Attributes
ABCDChip &	config

---

Detailed Description

This class represents the configuration of a chip.

It is based on the data stored in ABCDChip

Author:

Matthew Palmer

Date:

28 May 2003

Definition at line 22 of file ChipConfiguration.h.

---

Member Function Documentation

unsigned char SctData::ChipConfiguration::getAddress (   )  const throw () [inline]

There is a had-coded address associated with each chip position on the module. Returns: the address. Definition at line 157 of file ChipConfiguration.h.

unsigned char SctData::ChipConfiguration::getCalCharge (   )  const throw () [inline]

get the value of the calibration charge Definition at line 205 of file ChipConfiguration.h.

float SctData::ChipConfiguration::getCalFactor (   )  const throw () [inline]

accessor @} Definition at line 237 of file ChipConfiguration.h.

std::string SctData::ChipConfiguration::getClassName (   )  const throw () [inline, virtual]

Get the class name for this object. This is used to identify the precise type. Returns: the class name Note: Nothrow Implements Sct::Streamable. Definition at line 229 of file ChipConfiguration.h.

ABCDChip& SctData::ChipConfiguration::getConfig (   )  [inline]

Get non-const reference to underlying ABCDChip - used by IO. Definition at line 113 of file ChipConfiguration.h.

const ABCDChip& SctData::ChipConfiguration::getConfig (   )  const [inline]

Get const reference to underlying ABCDChip - used by IO. Definition at line 111 of file ChipConfiguration.h. Referenced by SctData::IO::ChipConfigurationStreamer_v1::read(), and SctData::IO::ChipConfigurationStreamer_v1::write().

double SctData::ChipConfiguration::getRcParam (  const unsigned  ipar  )  const throw (LogicError) [inline]

Get the response curve parameter index of parameter 0->2; value of parameter. Definition at line 180 of file ChipConfiguration.h.

unsigned char SctData::ChipConfiguration::getStrobeDelay (   )  const throw () [inline]

get the value of the strobe delay in UNITS Definition at line 216 of file ChipConfiguration.h.

unsigned char SctData::ChipConfiguration::getThreshold (   )  const throw () [inline]

get the value of the threshold in UNITS? Definition at line 169 of file ChipConfiguration.h.

unsigned char SctData::ChipConfiguration::getTrim (  unsigned int  channel  )  const throw (LogicError)

get the trim channel 0->127 trim 0->15

unsigned char SctData::ChipConfiguration::getTrimTarget (   )  const throw () [inline]

the trim target in steps of 2.5 mV Definition at line 161 of file ChipConfiguration.h.

bool SctData::ChipConfiguration::isActive (   )  const throw () [inline]

true if chip is participating in a scan Definition at line 149 of file ChipConfiguration.h.

bool SctData::ChipConfiguration::isMasked (  const unsigned  ichannel  )  const throw (LogicError) [inline]

mask access true if channel is masked channel index 0->127 Definition at line 120 of file ChipConfiguration.h. Referenced by SctAnalysis::TrimRangeAlgorithm::analyze().

void SctData::ChipConfiguration::mask (  const unsigned  ichannel  )  throw (LogicError) [inline]

mask mutator channel index 0->127 Definition at line 136 of file ChipConfiguration.h. Referenced by SctCalibrationController::ConfigUpdater::maskChannels().

void SctData::ChipConfiguration::resetMask (   )  throw () [inline]

unmask all channels Definition at line 143 of file ChipConfiguration.h. Referenced by SctCalibrationController::ConfigUpdater::maskChannels().

void SctData::ChipConfiguration::setActive (  const bool  active  )  throw () [inline]

set the chip activity status active if set true Definition at line 153 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setCalCharge (  const unsigned char  calCharge  )  throw () [inline]

set the value of the calibration charge in UNITS Definition at line 209 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setCalFactor (  const float  factor  )  throw () [inline]

theshold calibration factor by which the nominal threshold must be multiplied mutator Parameters: the  factor Definition at line 233 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setMask (  const unsigned  ichannel, const bool  value )  throw (LogicError) [inline]

mask mutator channel index 0->127 mask if true, unmask if false Definition at line 124 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setRcFunctionIndex (  const  char  )  throw (LogicError) [inline]

Response curve function index. Definition at line 198 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setRcParam (  const unsigned  ipar, const double  val )  const throw (LogicError) [inline]

Set the response curve parameter. Parameters: index  of parameter 0->2; the  value to set that parameter Definition at line 187 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setStrobeDelay (  const unsigned char  strobeDelay  )  throw (LogicError) [inline]

set the value of the strobe delay in UNITS Definition at line 220 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setThreshold (  const unsigned char  threshold  )  throw (LogicError) [inline]

set the threhold in UNITS? Definition at line 173 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setTrim (  const unsigned  channel, const unsigned char  trim )  throw (LogicError) [inline]

set the trim channel 0->127 trim 0->15 Definition at line 247 of file ChipConfiguration.h.

void SctData::ChipConfiguration::setTrimTarget (  const unsigned char  target  )  throw (LogicError) [inline]

set the trim target target in steps of 2.5 mV Definition at line 165 of file ChipConfiguration.h.

void SctData::ChipConfiguration::unmask (  const unsigned  ichannel  )  throw (LogicError) [inline]

mask mutator channel index 0->127 mask register is 128 bits implimented as UINT32 mask[4]; Definition at line 128 of file ChipConfiguration.h.

---

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

• ChipConfiguration.h

---