bil::V5FARRegister Class Reference

A register holding a frame address. More...

#include <packetprocessor/V5FARRegister.hpp>

Inheritance diagram for bil::V5FARRegister:

Collaboration diagram for bil::V5FARRegister:

List of all members.

Public Member Functions
	V5FARRegister ()
	Constructs a V5FARRegister instance.
virtual void	write (const boost::uint32_t *words, size_t wordCount)
	When writing a word, it sets the current frame address.
virtual void	read (boost::uint32_t *words, size_t wordCount) const
	When reading a word, the current frame address is returned.
V5FrameAddress &	frameAddress ()
	Gets frame address.
const V5FrameAddress &	frameAddress () const
	Gets read only frame address.
Public Member Functions inherited from bil::Register
	Register (RegisterAddress::address_t address, const std::string &name, bool writable=true, bool readable=true)
	Constructs a Register instance.
virtual	~Register ()=0
	Destructs a Register instance.
RegisterAddress::address_t	address () const
	Gets register address.
const std::string &	name () const
	Gets register name.
bool	writable () const
	Tells if register is writable.
bool	readable () const
	Tells if register is readable.

---

Detailed Description

A register holding a frame address.

The FAR register is an one word write- and readable register containing a frame address. Writes will alter its frame address to point to a new target. Reads will return the current frame address.

Definition at line 23 of file V5FARRegister.hpp.

---

Constructor & Destructor Documentation

V5FARRegister::V5FARRegister

(

)

Constructs a V5FARRegister instance.

Definition at line 13 of file V5FARRegister.cpp.

---

Member Function Documentation

void V5FARRegister::write ( const boost::uint32_t *  words, size_t  wordCount  )

virtual

When writing a word, it sets the current frame address.

Parameters:

words	Pointer to data words to write.
wordCount	Number of data words to write.

Exceptions:

.

Reimplemented from bil::Register.

Definition at line 21 of file V5FARRegister.cpp.

void V5FARRegister::read ( boost::uint32_t *  words, size_t  wordCount  ) const

virtual

When reading a word, the current frame address is returned.

Parameters:

words	Pointer to data buffer.
wordCount	Number of data words to read.

Exceptions:

.

Reimplemented from bil::Register.

Definition at line 32 of file V5FARRegister.cpp.

V5FrameAddress & V5FARRegister::frameAddress

(

)

Gets frame address.

Returns:

Reference to FARRegister's V5FrameAddress instance.

Definition at line 43 of file V5FARRegister.cpp.

const V5FrameAddress & V5FARRegister::frameAddress

(

)

const

Gets read only frame address.

Returns:

Reference to FARRegister's V5FrameAddress instance.

Definition at line 49 of file V5FARRegister.cpp.

---

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

• packetprocessor/V5FARRegister.hpp
• packetprocessor/V5FARRegister.cpp