A class to encapsulate details of the frame software board. More...

#include <carma/antenna/sza/antenna/control/FrameBoard.h>

Inheritance diagram for sza::antenna::control::FrameBoard:

Public Member Functions
void	archiveFeatures (unsigned features, unsigned seq)
	Update the features bitmask. More...

void	archiveNsnap (unsigned nsnap)
	Update the local register that contains a count of the number of integrated snapshots per frame. More...

void	archiveRecordNumber (unsigned record)
	Update the record number. More...

void	archiveTime ()
	Record the time in the register database. More...

void	archiveWalshState (unsigned walshState)
	Update the Walsh state in effect during the last frame. More...

	FrameBoard (SzaShare *share, std::string name)
	Constructor function for this board. More...

void	reset ()
	Stub this out until needed. More...

void	setTime ()
	Set the time in the register database. More...

Public Member Functions inherited from sza::antenna::control::Board
	Board (SzaShare *share, std::string name)
	Constructor looks up a board by name and stores a pointer to it in private member board_ (below). More...

	Board (SzaShare *share, sza::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) More...

	Board (SzaShare *share)
	Constructor for a virtual board. More...

RegMapBlock *	findReg (char *name)
	Return a pointer to a register of the board managed by this object. More...

int	getIndex ()
	Public function to return the index of this board in the register database. More...

bool	isReachable ()
	Verify that this board is reachable. More...

virtual void	readReg (RegMapBlock blk, unsigned int first, unsigned int nreg, unsigned int value)
	Method to read a register from this board. More...

virtual void	writeReg (RegMapBlock blk, unsigned int first, unsigned int nreg, unsigned int value)
	Methods to write to a register of this board. More...

virtual void	writeReg (RegMapBlock blk, unsigned int first, unsigned int nreg, bool value)
	Methods to write to a register of this board. More...

virtual	~Board ()
	Declaration of destructor as pure virtual prevents instantiation of this base class. More...

Additional Inherited Members
Protected Attributes inherited from sza::antenna::control::Board
RegMapBoard *	board_
	A pointer to the board this object refers to. More...

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

SzaShare *	share_
	The resource object of the shared memory database. More...

Detailed Description

A class to encapsulate details of the frame software board.

Definition at line 21 of file FrameBoard.h.

Constructor & Destructor Documentation

sza::antenna::control::FrameBoard::FrameBoard	(	SzaShare *	share,
		std::string	name
	)

Constructor function for this board.

Exceptions

Exception (via Board::findReg)

Member Function Documentation

void sza::antenna::control::FrameBoard::archiveFeatures	(	unsigned	features,
		unsigned	seq
	)

Update the features bitmask.

Exceptions

Exception (via SzaShare::writeReg)

void sza::antenna::control::FrameBoard::archiveNsnap ( unsigned nsnap )

Update the local register that contains a count of the number of integrated snapshots per frame.

Exceptions

Exception;

void sza::antenna::control::FrameBoard::archiveRecordNumber ( unsigned record )

Update the record number.

Exceptions

Exception (via SzaShare::writeReg)

void sza::antenna::control::FrameBoard::archiveTime ( )

Record the time in the register database.

Exceptions

Exception (via SzaShare::writeReg)

void sza::antenna::control::FrameBoard::archiveWalshState ( unsigned walshState )

Update the Walsh state in effect during the last frame.

Exceptions

Exception (via SzaShare::writeReg)

void sza::antenna::control::FrameBoard::reset ( )

virtual

Stub this out until needed.

Reimplemented from sza::antenna::control::Board.

Definition at line 78 of file FrameBoard.h.

void sza::antenna::control::FrameBoard::setTime ( )

Set the time in the register database.

Exceptions

Exception (via SzaShare::writeReg)

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

carma/antenna/sza/antenna/control/FrameBoard.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation