base::Peripheral Class Reference

Base class to represent ROC peripherals. More...

#include <Peripheral.h>

Inheritance diagram for base::Peripheral:

Collaboration diagram for base::Peripheral:

Public Member Functions
	Peripheral ()
	Peripheral (base::Board *board)
	Contructor with roc::Board pointer.
virtual	~Peripheral ()
base::Board &	board ()
	Return reference to roc::Board which hosts the Peripheral.
base::Board *	getBoard () const
	Returns pointer to the roc::Board which hosts the Peripheral.
Protected Attributes
base::Board *	fBoard
	board pointer

---

Detailed Description

Base class to represent ROC peripherals.

Concrete ROC peripherals, like the I2C bus interface, will be represented by classes derived from Peripheral.

The class holds the address information needed to reach the Peripheral, which at the base class level is just the pointer to the roc::Board which hosts the Peripheral.

Definition at line 24 of file Peripheral.h.

---

Constructor & Destructor Documentation

base::Peripheral::Peripheral

(

)

[inline]

Definition at line 28 of file Peripheral.h.

base::Peripheral::Peripheral

(

base::Board *

board

)

Contructor with roc::Board pointer.

base::Peripheral should always constructed via this ctor because the board pointer to a roc::Board instance is always needed.

Parameters:

board

pointer to the roc::Board which hosts the Peripheral.

Definition at line 19 of file Peripheral.cxx.

References fBoard.

virtual base::Peripheral::~Peripheral

(

)

[inline, virtual]

Definition at line 30 of file Peripheral.h.

---

Member Function Documentation

base::Board & base::Peripheral::board

(

)

Return reference to roc::Board which hosts the Peripheral.

Exceptions:

std::runtime_error

if board pointer not initialized or 0.

Definition at line 30 of file Peripheral.cxx.

References fBoard.

Referenced by nxyter::RocNx::fireTestPulse(), nxyter::MainAdc::getAdcDirect(), nxyter::NxChip::getChannelDelay(), nxyter::MainAdc::getChannelLatency(), nxyter::MainAdc::getClockDelayBufg(), nxyter::MainAdc::getClockDelaySrInit(), base::Gpio::getConfig(), nxyter::RocNx::getDataDebug(), nxyter::RocNx::getFifoEmpty(), nxyter::RocNx::getFifoFull(), nxyter::RocNx::getNxActive(), roc::I2cDevice::getRegister(), nxyter::MainAdc::getRegister(), roc::I2cDevice::getRegister16(), base::Gpio::getSyncBaud(), base::Gpio::getSyncScale(), nxyter::FebBase::initRoc(), nxyter::FebBase::resetNxI2cBus(), nxyter::FebBase::resetNxI2cRegister(), nxyter::RocNx::resetRocNxTs(), nxyter::NxChip::setChannelDelay(), nxyter::MainAdc::setChannelLatency(), nxyter::MainAdc::setChannelMux(), nxyter::MainAdc::setClockDelay(), nxyter::MainAdc::setClockDelayBufg(), nxyter::MainAdc::setClockDelaySrInit(), base::Gpio::setConfig(), nxyter::RocNx::setDebugMode(), nxyter::RocNx::setLTSDelay(), nxyter::RocNx::setNxActive(), nxyter::NxChip::setNxNumber(), nxyter::RocNx::setParityCheck(), roc::I2cDevice::setRegister(), nxyter::MainAdc::setRegister(), roc::I2cDevice::setRegisterVerify(), base::Gpio::setSyncBaud(), base::Gpio::setSyncScale(), and nxyter::RocNx::setToDefault().

base::Board* base::Peripheral::getBoard

(

)

const [inline]

Returns pointer to the roc::Board which hosts the Peripheral.

Note: normally using board() is more convenient.

Definition at line 38 of file Peripheral.h.

References fBoard.

Referenced by nxyter::FebUtil::acquireTestTriggerData(), nxyter::NxChip::activate(), nxyter::FebBase::addNxChip(), nxyter::NxChip::deactivate(), nxyter::NxChip::isactive(), and nxyter::QuickDaq::QuickDaq().

---

Field Documentation

base::Board* base::Peripheral::fBoard [protected]

board pointer

Definition at line 26 of file Peripheral.h.

Referenced by board(), getBoard(), and Peripheral().

---

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

• include/base/Peripheral.h (r4864/r4162)
• roclib/src_base/Peripheral.cxx (r4864/r4162)