RcuConf::BusComponent Class Reference
[Component interfaces]

#include <Component.h>

Inheritance diagram for RcuConf::BusComponent:

RcuConf::Component RcuConf::Altro RcuConf::Bc RcuConf::Fmd

Detailed Description

a Component on the bus

Definition at line 177 of file Component.h.

Public Member Functions

 BusComponent ()
virtual ~BusComponent ()
virtual unsigned int Write (const Parameter &p, const SingleValue &v)
virtual unsigned int Write (const Parameter &p, const SingleValue &v, const Address &a)
virtual unsigned int Read (const Parameter &p, SingleValue &v)
virtual unsigned int Read (const Parameter &p, const Address &a, SingleValue &v)

Protected Member Functions

virtual Rcuxx::AltroRegister * Name2Register (const std::string &name)=0
virtual Rcuxx::AltroCommand * Name2Command (const std::string &name)=0
virtual unsigned int DoWrite (const Parameter &p, const SingleValue &v, int board, unsigned int chip, unsigned int channel)
virtual unsigned int DoRead (const Parameter &p, SingleValue &v, int board, unsigned int chip, unsigned int channel)


Constructor & Destructor Documentation

RcuConf::BusComponent::BusComponent  )  [inline]
 

Constructor.

Definition at line 181 of file Component.h.

virtual RcuConf::BusComponent::~BusComponent  )  [inline, virtual]
 

Destructor.

Definition at line 183 of file Component.h.


Member Function Documentation

unsigned int RcuConf::BusComponent::DoRead const Parameter p,
SingleValue v,
int  board,
unsigned int  chip,
unsigned int  channel
[protected, virtual]
 

Do the actual read.

The address/broadcast is set before, so only the parameter and the value is passed

Parameters:
p Parameter entry
v Value entry
board Board #
chip Chip #
channel Channel #
Returns:
0 on success, error code otherwise

Definition at line 83 of file Component.cxx.

References RcuConf::Parameter::IsBlob(), RcuConf::Parameter::Name(), Name2Command(), Name2Register(), and RcuConf::SingleValue::Set().

Referenced by Read().

unsigned int RcuConf::BusComponent::DoWrite const Parameter p,
const SingleValue v,
int  board,
unsigned int  chip,
unsigned int  channel
[protected, virtual]
 

Do the actual write.

The address/broadcast is set before, so only the parameter and the value is passed

Parameters:
p Parameter entry
v Value entry
board Board #
chip Chip #
channel Channel #
Returns:
0 on success, error code otherwise

Definition at line 46 of file Component.cxx.

References RcuConf::Parameter::IsBlob(), RcuConf::Parameter::Name(), Name2Command(), Name2Register(), and RcuConf::SingleValue::Values().

Referenced by Write().

virtual Rcuxx::AltroCommand* RcuConf::BusComponent::Name2Command const std::string &  name  )  [protected, pure virtual]
 

Map a parameter name to a command.

Implemented in RcuConf::Altro, RcuConf::Bc, and RcuConf::Fmd.

Referenced by DoRead(), and DoWrite().

virtual Rcuxx::AltroRegister* RcuConf::BusComponent::Name2Register const std::string &  name  )  [protected, pure virtual]
 

Map a parameter name to a register.

Implemented in RcuConf::Altro, RcuConf::Bc, and RcuConf::Fmd.

Referenced by DoRead(), and DoWrite().

virtual unsigned int RcuConf::BusComponent::Read const Parameter p,
const Address a,
SingleValue v
[inline, virtual]
 

Read Parameter p, with SingleValue v for the Address a.

A call to this member function implies writing to a particular address on the bus.

Parameters:
p Parameter entry
v Value entry
a Address entry
Returns:
0 on success, error code otherwise

Reimplemented from RcuConf::Component.

Definition at line 226 of file Component.h.

References RcuConf::Address::Board(), RcuConf::Address::Channel(), RcuConf::Address::Chip(), and DoRead().

virtual unsigned int RcuConf::BusComponent::Read const Parameter p,
SingleValue v
[inline, virtual]
 

Read Parameter p, with SingleValue v.

A call to this member function implies writing in broadcast.

Parameters:
p Parameter entry
v Value entry
Returns:
0 on success, error code otherwise

Implements RcuConf::Component.

Definition at line 214 of file Component.h.

References DoRead().

virtual unsigned int RcuConf::BusComponent::Write const Parameter p,
const SingleValue v,
const Address a
[inline, virtual]
 

Write Parameter p, with SingleValue v for the Address a.

A call to this member function implies writing to a particular address on the bus.

Parameters:
p Parameter entry
v Value entry
a Address entry
Returns:
0 on success, error code otherwise

Reimplemented from RcuConf::Component.

Definition at line 202 of file Component.h.

References RcuConf::Address::Board(), RcuConf::Address::Channel(), RcuConf::Address::Chip(), and DoWrite().

virtual unsigned int RcuConf::BusComponent::Write const Parameter p,
const SingleValue v
[inline, virtual]
 

Write Parameter p, with SingleValue v.

A call to this member function implies writing in broadcast.

Parameters:
p Parameter entry
v Value entry
Returns:
0 on success, error code otherwise

Implements RcuConf::Component.

Definition at line 190 of file Component.h.

References DoWrite().


The documentation for this class was generated from the following files:
Top of page Last update Fri Apr 27 01:54:16 2007
Copyright © 2004 Christian Holm Created by DoxyGen 1.3.5