CModule32 Class Reference

#include <CModule32.h>

Inheritance diagram for CModule32:

List of all members.

Public Member Functions
	CModule32 (unsigned long base, unsigned int size, int crate=0)
	~CModule32 ()
CVmeModule &	getModule ()
Protected Member Functions
unsigned long	peek (unsigned long byteoff) const
unsigned long	poke (unsigned long data, unsigned long byteoff) const
void	Key (unsigned long offset) const
	write a key register.
Static Protected Member Functions
static unsigned long	Offset (unsigned long off)
static void	ThrowString (const char *pLeader, const char *pMessage) throw (STD(string))
Private Member Functions
	CModule32 (const CModule32 &)
CModule32 &	operator= (const CModule32 &)
int	operator== (const CModule32 &)
int	operator!= (const CModule32 &)
Private Attributes
CVmeModule	m_Module

---

Detailed Description

Base class for modules that have 32 bit wide register sets. This module is especially useful as a base class for several Struck (SIS) modules as their register sets have some common characteristics:

• Full 32 bit.
• Existence of 'key' registers.

Definition at line 296 of file CModule32.h.

---

Constructor & Destructor Documentation

CModule32::CModule32	(	unsigned long	base,
		unsigned int	size,
		int	crate = 0
	)

Construct the object.

Parameters:

	base	(unsigned long [in]) base address of the module.
	crate	(int [in] = 0): Crate in which the module lives.

Definition at line 296 of file CModule32.cpp.

CModule32::~CModule32

(

)

Destructor (currently a no-op).

Definition at line 304 of file CModule32.cpp.

CModule32::CModule32

(

const CModule32 &

)

[private]

---

Member Function Documentation

CModule32& CModule32::operator=

(

const CModule32 &

)

[private]

int CModule32::operator==

(

const CModule32 &

)

[private]

int CModule32::operator!=

(

const CModule32 &

)

[private]

CVmeModule& CModule32::getModule

(

)

[inline]

Definition at line 318 of file CModule32.h.

References m_Module.

unsigned long CModule32::peek

(

unsigned long

byteoff

)

const [inline, protected]

Definition at line 327 of file CModule32.h.

References m_Module, Offset(), and CVmeModule::peekl().

Referenced by CSIS3600::DataReady(), CSIS3600::ExternalClearEnabled(), CSIS3600::ExternalNextEnabled(), CSIS3820::getAcqMode(), CSIS3820::getCsr(), CSIS3820::getModuleInfo(), CSIS3600::isLatchMode(), CSIS3600::isLedLit(), CSIS3600::Read(), CSIS3820::ReadChannel(), and CSIS3820::ReadLatchedChannel().

unsigned long CModule32::poke	(	unsigned long	data,
		unsigned long	byteoff
	)			const [inline, protected]

Definition at line 330 of file CModule32.h.

References m_Module, Offset(), and CVmeModule::pokel().

Referenced by CSIS3600::ClearLed(), CSIS3600::DisableExternalClear(), CSIS3600::DisableExternalNext(), CSIS3600::EnableExternalClear(), CSIS3600::EnableExternalNext(), CSIS3600::EndLatch(), Key(), CSIS3600::LightLed(), CSIS3820::setAcqMode(), CSIS3600::SetCoincidenceMode(), CSIS3820::setCSR(), CSIS3600::SetFastClearWindow(), CSIS3600::SetLatchMode(), and CSIS3600::StartLatch().

void CModule32::Key

(

unsigned long

offset

)

const [protected]

write a key register.

Write to a key register:

Parameters:

offset

(unsigned long [in]): The offset to the register.

Definition at line 313 of file CModule32.cpp.

References poke().

Referenced by CSIS3820::Arm(), CSIS3820::ClearChannels(), CSIS3600::ClearData(), CSIS3600::Clock(), CSIS3820::Disable(), CSIS3600::Disable(), CSIS3820::Enable(), CSIS3600::Enable(), CSIS3820::Latch(), CSIS3820::Reset(), and CSIS3600::Reset().

static unsigned long CModule32::Offset

(

unsigned long

off

)

[inline, static, protected]

Definition at line 336 of file CModule32.h.

Referenced by peek(), and poke().

void CModule32::ThrowString	(	const char *	pLeader,
		const char *	pMessage
	)			throw (STD(string)) [static, protected]

Throw a string message built up out of two components a leader for the function and the actual message. To make this even easier, the two strings are passed as const char*

Parameters:

	pLeader	(const char* [in]): The first part of the message.
	pMessage	(const char* [in]): The second part of the message.

Exceptions:

string

(that's the purpose after all). A string exception made up of "CModule32::" + pLeader + " - " + pMessage is thrown

Definition at line 333 of file CModule32.cpp.

Referenced by CSIS3600::Read(), and CSIS3600::SetFastClearWindow().

---

Member Data Documentation

CVmeModule CModule32::m_Module [mutable, private]

Definition at line 300 of file CModule32.h.

Referenced by getModule(), peek(), and poke().

---

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

• CModule32.h
• CModule32.cpp

---