---

CScalerBank Class Reference

#include <CScalerBank.h>

List of all members.

Public Methods
	CScalerBank ()
	Default constructor.
	CScalerBank (const ScalerList &rhs)
	Construct from scaler list.
	CScalerBank (CScaler **ppScalers)
	From null terminated ptr array.
	CScalerBank (unsigned nScalers, CScaler **ppScalers)
	From counted scaler array.
	CScalerBank (const CScalerBank &rhs)
	Copy constructor.
virtual	~CScalerBank ()
	Destructor.
CScalerBank &	operator= (const CScalerBank &rhs)
	Assignment.
int	operator== (const CScalerBank &rhs) const
	Comparison for equality.
int	operator!= (const CScalerBank &rhs) const
void	Initialize ()
vector< unsigned long >	Read ()
void	Clear ()
void	AddScalerModule (CScaler *pScaler)
void	DeleteScalerModule (CScaler *pModule)
ScalerListIterator	begin ()
ScalerListIterator	end ()
unsigned int	size ()
unsigned int	getChannelCount ()
Private Attributes
ScalerList	m_Scalers
	List of scalers in the bank.

---

Constructor & Destructor Documentation

CScalerBank::CScalerBank (    )

Default constructor. Construct an empty scaler bank. Definition at line 287 of file CScalerBank.cpp.

CScalerBank::CScalerBank (  const ScalerList &    rhs )

Construct from scaler list. Construct a scaler bank populated with scalers from an STL list: Parameters: rhs  - Reference to a ScalerList which is already populated with an initial set of scalers. Definition at line 295 of file CScalerBank.cpp. References ScalerList.

CScalerBank::CScalerBank (  CScaler **    ppScalers )

From null terminated ptr array. Construct a scaler bank populated with scalers in a null terminated array of pointers to the scaler pointers. Parameters: ppScalers  - Pointer to an array of pointers to scalers. The last element of the array is null. Scalers are added to the bank until the null is encountered. Definition at line 307 of file CScalerBank.cpp. References AddScalerModule().

CScalerBank::CScalerBank (  unsigned    nScalers, CScaler **    ppScalers )

From counted scaler array. Construct a scaler bank populated with scalers from a counted array of scaler pointers. Parameters: nScalers  - Number of scalers in the bank. ppScalers  - Pointer to an array of CScaler*. Definition at line 320 of file CScalerBank.cpp. References AddScalerModule().

CScalerBank::CScalerBank (  const CScalerBank &    rhs )

Copy constructor. Copy construction. This is invoked when e.g. an object is passed by value to a function. The copy constructor makes a clone of the rhs object. Definition at line 333 of file CScalerBank.cpp.

virtual CScalerBank::~CScalerBank (    )  [inline, virtual]

Destructor. Definition at line 326 of file CScalerBank.h.

---

Member Function Documentation

void CScalerBank::AddScalerModule (  CScaler *    pScaler )

Adds a scaler module to the set which are managed by this bank. Parameters: CScaler  * pScaler Definition at line 418 of file CScalerBank.cpp. References m_Scalers. Referenced by CExperiment::AddScalerModule(), CExperiment::CExperiment(), and CScalerBank().

list< CScaler * >::iterator CScalerBank::begin (    )

Returns a looping iterator to the start of the list of scalers managed by this bank. Definition at line 449 of file CScalerBank.cpp. References m_Scalers. Referenced by Clear(), DeleteScalerModule(), getChannelCount(), Initialize(), and Read().

void CScalerBank::Clear (    )

Walks the list of scalers and clears them. Definition at line 401 of file CScalerBank.cpp. References begin(), end(), and ScalerListIterator. Referenced by CExperiment::Start(), CExperiment::TriggerScalerReadout(), and CExperiment::TriggerSnapshotScaler().

void CScalerBank::DeleteScalerModule (  CScaler *    pModule )

Deletes a scaler module from the set being readout. Parameters: pModule  The module to delete. Exceptions: CNoSuchObjectException  if the scaler is not in the list. Definition at line 431 of file CScalerBank.cpp. References begin(), end(), m_Scalers, and ScalerListIterator. Referenced by CExperiment::RemoveScalerModule().

list< CScaler * >::iterator CScalerBank::end (    )

Returns a looping iterator to the end of the set of scalers managed by this bank. Definition at line 461 of file CScalerBank.cpp. References m_Scalers. Referenced by Clear(), DeleteScalerModule(), getChannelCount(), Initialize(), and Read().

unsigned int CScalerBank::getChannelCount (    )

Returns the number of channels read out by the bank. Parameters: Definition at line 485 of file CScalerBank.cpp. References begin(), end(), and ScalerListIterator.

void CScalerBank::Initialize (    )

Walks through the list of modules initializing them. Definition at line 368 of file CScalerBank.cpp. References begin(), end(), and ScalerListIterator.

int CScalerBank::operator!= (  const CScalerBank &    rhs )  const [inline]

Definition at line 330 of file CScalerBank.h. References operator==().

CScalerBank & CScalerBank::operator= (  const CScalerBank &    aCScalerBank )

Assignment. Assignment operation. This member function supports assignment of an object of this class to an object of the same class. Definition at line 343 of file CScalerBank.cpp. References m_Scalers.

int CScalerBank::operator== (  const CScalerBank &    rhs )  const

Comparison for equality. Equality comparison: Definition at line 356 of file CScalerBank.cpp. References m_Scalers. Referenced by operator!=().

vector< unsigned long > CScalerBank::Read (    )

Walks the list of scalers and reads them into a vector of unsigned longs which is returned to the caller. Definition at line 384 of file CScalerBank.cpp. References begin(), end(), and ScalerListIterator. Referenced by CExperiment::TriggerScalerReadout(), and CExperiment::TriggerSnapshotScaler().

unsigned int CScalerBank::size (    )

Returns the number of scaler modules in the bank. Definition at line 472 of file CScalerBank.cpp. References m_Scalers.

---

Member Data Documentation

ScalerList CScalerBank::m_Scalers [private]

List of scalers in the bank. Definition at line 315 of file CScalerBank.h. Referenced by AddScalerModule(), begin(), DeleteScalerModule(), end(), operator=(), operator==(), and size().

---

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

• CScalerBank.h
• CScalerBank.cpp

---