#include <Board.h>

Inheritance diagram for gcp::antenna::control::Board:

Public Member Functions
	Board (SpecificShare *share, std::string name)

	Board (SpecificShare *share, gcp::util::AntNum ant)

	Board (SpecificShare *share)

	Board ()

virtual	~Board ()

RegMapBlock *	findReg (char *name)

bool	isReachable ()

virtual void	reset ()

int	getIndex ()

virtual void	readRegNoLock (RegMapBlock blk, unsigned int first, unsigned int nreg, unsigned int value)

virtual void	readReg (RegMapBlock blk, unsigned int first, unsigned int nreg, unsigned int value)

virtual void	readReg (RegMapBlock blk, unsigned int first, unsigned int nreg, float value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, signed char value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, unsigned char value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, signed short value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, unsigned short value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, int value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, unsigned int value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, float value)

virtual void	writeRegNoLock (RegMapBlock blk, unsigned first, unsigned nreg, double value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, signed char value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, unsigned char value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, signed short value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, unsigned short value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, int value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, unsigned int value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, float value)

virtual void	writeReg (RegMapBlock blk, unsigned first, unsigned nreg, double value)

Protected Attributes
SpecificShare *	share_

RegMapBoard *	board_

bool	hasBoard_

Detailed Description

A class which encapsulates resources of a board of the shared register map.

Constructor & Destructor Documentation

gcp::antenna::control::Board::Board	(	SpecificShare *	share,
		std::string	name
	)

Constructor looks up a board by name and stores a pointer to it in private member board_ (below).

Exceptions

Exception

Board::Board	(	SpecificShare *	share,
		gcp::util::AntNum	ant
	)

Constructor looks up the rx board corresponding to the requested antenna and stores a pointer to it in private member board_ (below)

Exceptions

Exception ....................................................................... Constructor function

Board::Board ( SpecificShare * share )

Constructor for a virtual board

Exceptions

Exception ....................................................................... Constructor function for a virtual board

Board::Board ( )

....................................................................... Constructor function

Board::~Board ( )

virtual

Declaration of destructor as pure virtual prevents instantiation of this base class

....................................................................... Empty function body for the virtual destructor

Member Function Documentation

RegMapBlock * Board::findReg ( char * name )

Return a pointer to a register of the board managed by this object.

Exceptions

Exception ....................................................................... Look up a register of this board

int Board::getIndex ( )

Public function to return the index of this board in the register database

....................................................................... Return the index of this board in the register database

bool Board::isReachable ( )

Verify that this board is reachable.

Exceptions

(indirectly) Exception

....................................................................... A public function to verify that this board is reachable

void Board::readReg	(	RegMapBlock *	blk,
		unsigned int	first,
		unsigned int	nreg,
		unsigned int *	value
	)

virtual

....................................................................... Method to read a register from this board.

void Board::readRegNoLock	(	RegMapBlock *	blk,
		unsigned int	first,
		unsigned int	nreg,
		unsigned int *	value
	)

virtual

Method to read a register from this board.

virtual void gcp::antenna::control::Board::reset ( )

inlinevirtual

Function to reset private members of a board-management object. Should be overwritten by classes which inherit from Board

Exceptions

Exception

Reimplemented in gcp::antenna::control::FrameBoard.

virtual void gcp::antenna::control::Board::writeRegNoLock	(	RegMapBlock *	blk,
		unsigned	first,
		unsigned	nreg,
		signed char *	value
	)

virtual

Methods to write to a register of this board.

Member Data Documentation

RegMapBoard* gcp::antenna::control::Board::board_

protected

A pointer to the board this object refers to.

bool gcp::antenna::control::Board::hasBoard_

protected

True if this Board has a real board corresponding to it.

SpecificShare* gcp::antenna::control::Board::share_

protected

The resource object of the shared memory database

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

gcpCbass/antenna/control/cbass/Board.h
gcpCbass/antenna/control/cbass/Board.cc

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation