RcuConf::Rcu Class Reference
[Component interfaces]

#include <Rcu.h>

Inheritance diagram for RcuConf::Rcu:

RcuConf::Component

Detailed Description

Component configurator for the RCU.

Definition at line 45 of file Rcu.h.

Public Member Functions

 Rcu (Rcuxx::Rcu &rcu)
virtual ~Rcu ()
unsigned int Write (const Parameter &p, const SingleValue &v)
unsigned int Write (const Parameter &p, const BlobValue &v)
unsigned int Read (const Parameter &p, SingleValue &v)
unsigned int Read (const Parameter &p, BlobValue &v)
const std::string & ErrorString (int err)
void StartBlock ()
int EndBlock ()
long int * GetBlock () const

Static Public Member Functions

bool Create (RcuDb::Server &server)

Protected Member Functions

Rcuxx::RcuRegister * Name2Register (const std::string &name)
Rcuxx::RcuCommand * Name2Command (const std::string &name)
Rcuxx::RcuMemory * Name2Memory (const std::string &name)

Protected Attributes

Rcuxx::Rcu & fRcu
std::string fErrorString


Constructor & Destructor Documentation

RcuConf::Rcu::Rcu Rcuxx::Rcu &  rcu  )  [inline]
 

Constructor.

Parameters:
rcu Reference to low-level RCU interface

Definition at line 50 of file Rcu.h.

References fRcu.

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

Destructor.

Definition at line 52 of file Rcu.h.


Member Function Documentation

bool RcuConf::Rcu::Create RcuDb::Server &  server  )  [static]
 

Create entries for all parameters in the data base.

Parameters:
server Server to contact.
Returns:
true on success, false otherwise

Definition at line 236 of file Rcu.cxx.

int RcuConf::Rcu::EndBlock  ) 
 

End a data block.

Returns:
number of words in block

Definition at line 214 of file Rcu.cxx.

References fRcu.

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

const std::string & RcuConf::Rcu::ErrorString int  err  ) 
 

Get the latest error string.

Definition at line 229 of file Rcu.cxx.

References fErrorString, and fRcu.

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

long int * RcuConf::Rcu::GetBlock  )  const
 

Get the data block.

Returns:
Data block

Definition at line 221 of file Rcu.cxx.

References fRcu.

Referenced by RcuConf::CommandCoder::getDataBlock().

Rcuxx::RcuCommand * RcuConf::Rcu::Name2Command const std::string &  name  )  [protected]
 

Map a parameter name to a command.

Definition at line 65 of file Rcu.cxx.

References fRcu.

Referenced by Read(), and Write().

Rcuxx::RcuMemory * RcuConf::Rcu::Name2Memory const std::string &  name  )  [protected]
 

Map a parameter name to a memory.

Definition at line 98 of file Rcu.cxx.

References fRcu.

Referenced by Read(), and Write().

Rcuxx::RcuRegister * RcuConf::Rcu::Name2Register const std::string &  name  )  [protected]
 

Map a parameter name to a register.

Definition at line 33 of file Rcu.cxx.

References fRcu.

Referenced by Read(), and Write().

unsigned int RcuConf::Rcu::Read const Parameter p,
BlobValue v
[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 from RcuConf::Component.

Definition at line 187 of file Rcu.cxx.

References RcuConf::Parameter::IsBlob(), RcuConf::Parameter::Name(), Name2Memory(), and RcuConf::BlobValue::Set().

unsigned int RcuConf::Rcu::Read const Parameter p,
SingleValue v
[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 162 of file Rcu.cxx.

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

void RcuConf::Rcu::StartBlock  ) 
 

Start a data block.

Definition at line 206 of file Rcu.cxx.

References fRcu.

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

unsigned int RcuConf::Rcu::Write const Parameter p,
const BlobValue v
[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 from RcuConf::Component.

Definition at line 142 of file Rcu.cxx.

References RcuConf::Parameter::IsBlob(), RcuConf::Parameter::Name(), Name2Memory(), and RcuConf::BlobValue::Values().

unsigned int RcuConf::Rcu::Write const Parameter p,
const SingleValue v
[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 114 of file Rcu.cxx.

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


Field Documentation

std::string RcuConf::Rcu::fErrorString [protected]
 

Last error string.

Definition at line 112 of file Rcu.h.

Referenced by ErrorString().

Rcuxx::Rcu& RcuConf::Rcu::fRcu [protected]
 

Reference to low-level interface.

Definition at line 110 of file Rcu.h.

Referenced by EndBlock(), ErrorString(), GetBlock(), Name2Command(), Name2Memory(), Name2Register(), Rcu(), and StartBlock().


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