uhal::_ValWord_< T > Struct Template Reference

A Template helper struct wrapping an IPbus header, a register for storing a single word of data, a valid flag and a mask for modifying returned values. More...

#include <uhal/ValMem.hpp>

Inheritance diagram for uhal::_ValWord_< T >:

Collaboration diagram for uhal::_ValWord_< T >:

Public Attributes
T	value
	A register for storing data. More...
uint32_t	mask
	A mask for modifying returned values. More...
Public Attributes inherited from uhal::_ValHeader_
bool	valid
	A flag for marking whether the data is actually valid. More...
std::deque< uint32_t >	IPbusHeaders
	The IPbus header associated with the transaction that returned this data. More...

Protected Member Functions
	_ValWord_ (const T &aValue, const bool &aValid, const uint32_t aMask)
	Constructor Private, since this struct should only be used by the ValWord. More...
Protected Member Functions inherited from uhal::_ValHeader_
	_ValHeader_ (const bool &aValid)
	Constructor Private, since this struct should only be used by the ValHeader. More...

Friends
class	ValWord< T >
	Make ValWord a friend since it is the only class that should be able to create an instance this struct. More...

Detailed Description

template<typename T>
struct uhal::_ValWord_< T >

A Template helper struct wrapping an IPbus header, a register for storing a single word of data, a valid flag and a mask for modifying returned values.

Definition at line 102 of file ValMem.hpp.

Constructor & Destructor Documentation

_ValWord_()

template<typename T >

uhal::_ValWord_< T >::_ValWord_ ( const T &  aValue, const bool &  aValid, const uint32_t  aMask  )

protected

Constructor Private, since this struct should only be used by the ValWord.

Parameters

aValue	an initial value
aValid	an initial validity
aMask	a mask value

Definition at line 51 of file ValMem.cpp.

Friends And Related Function Documentation

ValWord< T >

template<typename T >

friend class ValWord< T >

friend

Make ValWord a friend since it is the only class that should be able to create an instance this struct.

Definition at line 108 of file ValMem.hpp.

Member Data Documentation

mask

template<typename T >

uint32_t uhal::_ValWord_< T >::mask

A mask for modifying returned values.

Definition at line 108 of file ValMem.hpp.

value

template<typename T >

T uhal::_ValWord_< T >::value

A register for storing data.

Definition at line 106 of file ValMem.hpp.

---

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

• uhal/include/uhal/ValMem.hpp
• uhal/src/common/ValMem.cpp