bil::V5MFWRRegister Class Reference

Register for use with bitstream compression. More...

#include <packetprocessor/V5MFWRRegister.hpp>

Inheritance diagram for bil::V5MFWRRegister:

Collaboration diagram for bil::V5MFWRRegister:

List of all members.

Public Member Functions
	V5MFWRRegister (const V5CMDRegister &cmdReg, V5FDRIRegister &fdriReg)
	Constructs a V5FDRIRegister instance.
virtual void	write (const boost::uint32_t *words, size_t wordCount)
	Writes cause the FDRI register to write the previous written frame again to the current frame address in FAR.
const V5CMDRegister &	cmdRegister () const
	Gets linked V5CMDRegister register instance.
V5FDRIRegister &	fdriRegister () const
	Gets linked V5FDRIRegister register instance.
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

Register for use with bitstream compression.

The MFWR register is a write-only register. Writes of at least two dummy words to it cause the FDRI register to write the previous written frame again to the current frame address in FAR.

Definition at line 26 of file V5MFWRRegister.hpp.

---

Constructor & Destructor Documentation

V5MFWRRegister::V5MFWRRegister	(	const V5CMDRegister &	cmdReg,
		V5FDRIRegister &	fdriReg
	)

Constructs a V5FDRIRegister instance.

Parameters:

cmdReg	V5CMDRegister instance reference that should be linked to this register (e.g. for querying state).
fdriReg	V5FDRIRegister instance reference that should be linked to this register (e.g. for triggering frame writes).

Definition at line 15 of file V5MFWRRegister.cpp.

---

Member Function Documentation

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

virtual

Writes cause the FDRI register to write the previous written frame again to the current frame address in FAR.

Parameters:

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

Exceptions:

.

Reimplemented from bil::Register.

Definition at line 24 of file V5MFWRRegister.cpp.

const V5CMDRegister & V5MFWRRegister::cmdRegister

(

)

const

Gets linked V5CMDRegister register instance.

Returns:

Reference to the V5CMDRegister instance.

Definition at line 37 of file V5MFWRRegister.cpp.

V5FDRIRegister & V5MFWRRegister::fdriRegister

(

)

const

Gets linked V5FDRIRegister register instance.

Returns:

Reference to the V5FDRIRegister instance.

Definition at line 43 of file V5MFWRRegister.cpp.

---

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

• packetprocessor/V5MFWRRegister.hpp
• packetprocessor/V5MFWRRegister.cpp