uhal::ValHeader Class Reference

A class which wraps a single word of data and marks whether or not it is valid. More...

#include <uhal/ValMem.hpp>

Collaboration diagram for uhal::ValHeader:

Public Member Functions
	ValHeader ()
	Default constructor. More...
template<typename T >
	ValHeader (const ValWord< T > &aValWord)
	Constructor to allow you to throw away returned information in a ValWord and just keep reply headers and validity state. More...
template<typename T >
	ValHeader (const ValVector< T > &aValVector)
	Constructor to allow you to throw away returned information in a ValVector and just keep reply headers and validity state. More...
bool	valid ()
	Return whether the Validated memory is marked as valid. More...
void	valid (bool aValid)
	Change the validatity state of the Validated memory. More...

Protected Attributes
boost::shared_ptr< _ValHeader_ >	mMembers
	Return a std::deque containing all the IPbus headers returned during the transaction. More...

Friends
class	ClientInterface
	Make ClientInterface a friend so that it can access the members to get the info associated with the raw data space. More...

Detailed Description

A class which wraps a single word of data and marks whether or not it is valid.

Definition at line 156 of file ValMem.hpp.

Constructor & Destructor Documentation

ValHeader() [1/3]

uhal::ValHeader::ValHeader

(

)

Default constructor.

Definition at line 73 of file ValMem.cpp.

ValHeader() [2/3]

template<typename T >

uhal::ValHeader::ValHeader

(

const ValWord< T > &

aValWord

)

Constructor to allow you to throw away returned information in a ValWord and just keep reply headers and validity state.

Parameters

aValWord

a ValWord whose reply headers and validity state are to be copied

Definition at line 39 of file ValMem.hxx.

ValHeader() [3/3]

template<typename T >

uhal::ValHeader::ValHeader

(

const ValVector< T > &

aValVector

)

Constructor to allow you to throw away returned information in a ValVector and just keep reply headers and validity state.

Parameters

aValVector

a ValVector whose reply headers and validity state are to be copied

Definition at line 48 of file ValMem.hxx.

Member Function Documentation

valid() [1/2]

bool uhal::ValHeader::valid

(

)

Return whether the Validated memory is marked as valid.

Returns

whether the Validated memory is marked as valid

Definition at line 79 of file ValMem.cpp.

References mMembers.

Referenced by uhal::tests::PerfTester::QueuedBlockWrite::check_values().

valid() [2/2]

void uhal::ValHeader::valid

(

bool

aValid

)

Change the validatity state of the Validated memory.

Parameters

aValid

the new validity state of the Validated memory

Definition at line 84 of file ValMem.cpp.

References mMembers.

Friends And Related Function Documentation

ClientInterface

friend class ClientInterface

friend

Make ClientInterface a friend so that it can access the members to get the info associated with the raw data space.

Definition at line 159 of file ValMem.hpp.

Member Data Documentation

mMembers

boost::shared_ptr< _ValHeader_ > uhal::ValHeader::mMembers

protected

Return a std::deque containing all the IPbus headers returned during the transaction.

Returns

a std::deque containing all the IPbus headers returned during the transaction

Note

This is a deque, since a block transaction may be chunked into many smaller block transactionsA shared pointer to a ValWord struct, so that every copy of this ValWord points to the same underlying memory

Definition at line 202 of file ValMem.hpp.

Referenced by uhal::ValVector< uint32_t >::assign(), uhal::ClientInterface::CreateValHeader(), and valid().

---

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

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