A register for storing configuration data. More...

#include <packetprocessor/V5FDRIRegister.hpp>

Inheritance diagram for bil::V5FDRIRegister:

Collaboration diagram for bil::V5FDRIRegister:

Public Member Functions
	V5FDRIRegister (const V5CMDRegister &cmdReg, V5FARRegister &farReg)
	Constructs a V5FDRIRegister instance.
virtual void	write (const boost::uint32_t *words, size_t wordCount)
	Every frame-sized data chunk will be packed into a frame and stored in configuration memory at the frame address denoted by the FAR register. After a frame is written, the FAR register is auto-incremented.
void	writePreviousFrame ()
	Writes the previous written frame again, but to the current FAR register's frame address.
const V5CMDRegister &	cmdRegister () const
	Gets linked V5CMDRegister register instance.
V5FARRegister &	farRegister () const
	Gets linked V5FARRegister register instance.
V5Configuration &	configuration ()
	Gets configuration.
const V5Configuration &	configuration () const
	Gets read only configuration.
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.
virtual void	read (boost::uint32_t *words, size_t wordCount) const
	Reads data words from the register.

Detailed Description

A register for storing configuration data.

The FDRI register is the input for configuration data. Because of this it is a write-only register and writes to it must be a multiple of the frame size. Every frame-sized data chunk will be packed into a frame and stored in configuration memory at the frame address denoted by the FAR register. After a frame is written, the FAR register is auto-incremented.

Definition at line 30 of file V5FDRIRegister.hpp.

Constructor & Destructor Documentation

V5FDRIRegister::V5FDRIRegister	(	const V5CMDRegister &	cmdReg,
		V5FARRegister &	farReg
	)

Constructs a V5FDRIRegister instance.

Parameters:

cmdReg	V5CMDRegister instance reference that should be linked to this register (e.g. for querying state).
farReg	V5FARRegister instance reference that should be linked to this register (e.g. for querying frame address). The FAR register's frame address layout pointer will also be set V5Configuration member's address layout.

Definition at line 15 of file V5FDRIRegister.cpp.

Member Function Documentation

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

virtual

Every frame-sized data chunk will be packed into a frame and stored in configuration memory at the frame address denoted by the FAR register. After a frame is written, the FAR register is auto-incremented.

Parameters:

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

Exceptions:

.

Reimplemented from bil::Register.

Definition at line 28 of file V5FDRIRegister.cpp.

void V5FDRIRegister::writePreviousFrame ( )

Writes the previous written frame again, but to the current FAR register's frame address.

This feature is used by the MFWRRegister for writing the same frame data to many different locations.

Exceptions:

.

Definition at line 69 of file V5FDRIRegister.cpp.

const V5CMDRegister & V5FDRIRegister::cmdRegister ( ) const

Gets linked V5CMDRegister register instance.

Returns:: Reference to the V5CMDRegister instance.

Definition at line 90 of file V5FDRIRegister.cpp.

V5FARRegister & V5FDRIRegister::farRegister ( ) const

Gets linked V5FARRegister register instance.

Returns:: Reference to the V5FARRegister instance.

Definition at line 96 of file V5FDRIRegister.cpp.

V5Configuration & V5FDRIRegister::configuration ( )

Gets configuration.

Returns:: Reference to V5Configuration instance.

Definition at line 78 of file V5FDRIRegister.cpp.

const V5Configuration & V5FDRIRegister::configuration ( ) const

Gets read only configuration.

Returns:: Reference to V5Configuration instance.

Definition at line 84 of file V5FDRIRegister.cpp.

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

packetprocessor/V5FDRIRegister.hpp
packetprocessor/V5FDRIRegister.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation