RcuConf::Component Class Reference
[Component interfaces]

#include <Component.h>

Inheritance diagram for RcuConf::Component:

RcuConf::BusComponent RcuConf::Rcu RcuConf::Altro RcuConf::Bc RcuConf::Fmd

Detailed Description

Base class for component configurators.

Definition at line 63 of file Component.h.

Public Types

enum  {
  kSuccess = 0, kNotSupported, kUnknownParameter, kInvalidValue,
  kInvalidAddress, kFailure
}

Public Member Functions

 Component ()
virtual ~Component ()
virtual unsigned int Write (const Parameter &p, const SingleValue &v)=0
virtual unsigned int Write (const Parameter &p, const SingleValue &v, const Address &a)
virtual unsigned int Write (const Parameter &p, const BlobValue &v)
virtual unsigned int Write (const Parameter &p, const BlobValue &v, const Address &a)
virtual unsigned int Read (const Parameter &p, SingleValue &v)=0
virtual unsigned int Read (const Parameter &p, const Address &a, SingleValue &v)
virtual unsigned int Read (const Parameter &p, BlobValue &v)
virtual unsigned int Read (const Parameter &p, const Address &a, BlobValue &v)

Static Protected Member Functions

void Create (RcuDb::Server &s, const std::string &name, Parameter::Where dest, bool isBlob, unsigned int mask) throw (bool)


Member Enumeration Documentation

anonymous enum
 

Status codes.

Note, that negative errors correspond to Rcu++ error codes.

Enumeration values:
kSuccess  Success.
kNotSupported  Operation not supported for this component.
kUnknownParameter  The parameter does not belong to this component.
kInvalidValue  The value has wrong cardinality for the parameter.
kInvalidAddress  Invalid address for this register (i.e., trying to broadcast when it's not allowed.
kFailure  Other errors.

Definition at line 73 of file Component.h.


Constructor & Destructor Documentation

RcuConf::Component::Component  )  [inline]
 

Constructor.

Definition at line 67 of file Component.h.

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

Destructor.

Definition at line 69 of file Component.h.


Member Function Documentation

void RcuConf::Component::Create RcuDb::Server &  s,
const std::string &  name,
Parameter::Where  dest,
bool  isBlob,
unsigned int  mask
throw (bool) [static, protected]
 

Create an entry in the parameter table.

Parameters:
s Server to contact
name Name of the parameter
dest Destination
isBlob Whether this parameter has blob value
mask Mask used for verification.
Exceptions:
bool of value false in case of errors.

Definition at line 35 of file Component.cxx.

References RcuConf::Parameter::Insert().

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

Read Parameter p, with BlobValue 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

Definition at line 155 of file Component.h.

References kNotSupported.

virtual unsigned int RcuConf::Component::Read const Parameter p,
BlobValue v
[inline, virtual]
 

Read Parameter p, with BlobValue 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

Reimplemented in RcuConf::Rcu.

Definition at line 146 of file Component.h.

References kNotSupported.

virtual unsigned int RcuConf::Component::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 in RcuConf::BusComponent.

Definition at line 138 of file Component.h.

References kNotSupported.

virtual unsigned int RcuConf::Component::Read const Parameter p,
SingleValue v
[pure 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

Implemented in RcuConf::BusComponent, and RcuConf::Rcu.

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

Write Parameter p, with BlobValue 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

Definition at line 120 of file Component.h.

References kNotSupported.

virtual unsigned int RcuConf::Component::Write const Parameter p,
const BlobValue v
[inline, virtual]
 

Write Parameter p, with BlobValue 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

Reimplemented in RcuConf::Rcu.

Definition at line 111 of file Component.h.

References kNotSupported.

virtual unsigned int RcuConf::Component::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 in RcuConf::BusComponent.

Definition at line 103 of file Component.h.

References kNotSupported.

virtual unsigned int RcuConf::Component::Write const Parameter p,
const SingleValue v
[pure 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

Implemented in RcuConf::BusComponent, and RcuConf::Rcu.

Referenced by RcuConf::Configurator::Write().


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