Rcuxx::RcuTRCFG1 Struct Reference
[RCU interface classes]

#include <rcuxx/Rcu.h>

Inheritance diagram for Rcuxx::RcuTRCFG1:

Collaboration diagram for Rcuxx::RcuTRCFG1:

List of all members.

---

Detailed Description

Interface to the TRigger ConFiG register.

This provide the interface that concrete implementations should implement.

Public Types
enum	BMD_t { k4Buffers, k8Buffers }
enum	Mode_t { kInternal = 0, kDerivedL2 = 2, kExternal = 3 }
Public Member Functions
	RcuTRCFG1 (RcuMemory &mem, size_t offset, RcuCommand *clear)
virtual void	Decode (unsigned int dat)
virtual unsigned int	Encode ()
virtual void	Print () const
bool	IsOpt () const
void	SetOpt (bool on=true)
bool	IsPop () const
void	SetPop (bool on=true)
BMD_t	BMD () const
void	SetBMD (BMD_t bmd)
Mode_t	Mode () const
void	SetMode (Mode_t mode)
unsigned int	Twv () const
void	SetTwv (unsigned int val)
unsigned int	Wptr () const
unsigned int	Rptr () const
unsigned int	Remb () const
bool	IsEmpty () const
bool	IsFull () const
Protected Attributes
bool	fOpt
bool	fPop
BMD_t	fBMD
Mode_t	fMode
unsigned int	fTwv
unsigned int	fWptr
unsigned int	fRptr
unsigned int	fRemb
bool	fEmpty
bool	fFull

---

Member Enumeration Documentation

enum Rcuxx::RcuTRCFG1::BMD_t

Buffer size.

Enumerator:

k4Buffers	4 Buffers
k8Buffers	8 Buffers

enum Rcuxx::RcuTRCFG1::Mode_t

Mode buttons.

Enumerator:

kInternal	Software trigger.
kDerivedL2	Ext. L1, internal L2
kExternal	Ext. L1 and L2

---

Constructor & Destructor Documentation

Rcuxx::RcuTRCFG1::RcuTRCFG1	(	RcuMemory &	mem,
		size_t	offset,
		RcuCommand *	clear
	)			[inline]

Constructor.

Parameters:

	mem	reference to memory
	offset	Offset in memory
	clear	Clear command

---

Member Function Documentation

void Rcuxx::RcuTRCFG1::Decode

(

unsigned int

dat

)

[inline, virtual]

Decode dat as.

Reimplemented from Rcuxx::RcuRegister.

References fBMD, fEmpty, fFull, fMode, fOpt, fPop, fRemb, fRptr, fTwv, fWptr, k4Buffers, k8Buffers, kDerivedL2, kExternal, and kInternal.

unsigned int Rcuxx::RcuTRCFG1::Encode

(

)

[inline, virtual]

Encode set values and return hardware register value.

Reimplemented from Rcuxx::RcuRegister.

References fBMD, fMode, fOpt, fPop, fTwv, k8Buffers, kDerivedL2, kExternal, and kInternal.

void Rcuxx::RcuTRCFG1::Print

(

)

const [inline, virtual]

Print to standard output.

Reimplemented from Rcuxx::RcuRegister.

References fBMD, fEmpty, fFull, fMode, fOpt, fPop, fRemb, fRptr, fTwv, fWptr, k4Buffers, kDerivedL2, kInternal, and Rcuxx::RcuRegister::Print().

bool Rcuxx::RcuTRCFG1::IsOpt

(

)

const [inline]

Returns:

BC to optimize readout

References fOpt.

void Rcuxx::RcuTRCFG1::SetOpt

(

bool

on = true

)

[inline]

Use BC to optimize readout.

References fOpt.

bool Rcuxx::RcuTRCFG1::IsPop

(

)

const [inline]

Returns:

Popped readout e.g., via U2F

References fPop.

void Rcuxx::RcuTRCFG1::SetPop

(

bool

on = true

)

[inline]

Popped readout e.g., via U2F.

References fPop.

BMD_t Rcuxx::RcuTRCFG1::BMD

(

)

const [inline]

Buffer MoDe input/output.

References fBMD.

void Rcuxx::RcuTRCFG1::SetBMD

(

BMD_t

bmd

)

[inline]

Buffer MoDe input/output.

References fBMD.

Mode_t Rcuxx::RcuTRCFG1::Mode

(

)

const [inline]

Mode buttons.

References fMode.

void Rcuxx::RcuTRCFG1::SetMode

(

Mode_t

mode

)

[inline]

Mode buttons.

References fMode.

unsigned int Rcuxx::RcuTRCFG1::Twv

(

)

const [inline]

Returns:

# clock cycles between L1 and L2

References fTwv.

void Rcuxx::RcuTRCFG1::SetTwv

(

unsigned int

val

)

[inline]

Set # clock cycles between L1 and L2.

References fTwv.

unsigned int Rcuxx::RcuTRCFG1::Wptr

(

)

const [inline]

Write pointer.

References fWptr.

unsigned int Rcuxx::RcuTRCFG1::Rptr

(

)

const [inline]

Read pointer.

References fRptr.

unsigned int Rcuxx::RcuTRCFG1::Remb

(

)

const [inline]

Free buffers.

References fRemb.

bool Rcuxx::RcuTRCFG1::IsEmpty

(

)

const [inline]

Returns:

is empty?

References fEmpty.

bool Rcuxx::RcuTRCFG1::IsFull

(

)

const [inline]

Returns:

is Full?

References fFull.

---

Member Data Documentation

bool Rcuxx::RcuTRCFG1::fOpt [protected]

Use BC to optimize readout.

Referenced by Decode(), Encode(), IsOpt(), Print(), and SetOpt().

bool Rcuxx::RcuTRCFG1::fPop [protected]

Popped readout e.g., via U2F.

Referenced by Decode(), Encode(), IsPop(), Print(), and SetPop().

BMD_t Rcuxx::RcuTRCFG1::fBMD [protected]

Buffer MoDe input/output.

Referenced by BMD(), Decode(), Encode(), Print(), and SetBMD().

Mode_t Rcuxx::RcuTRCFG1::fMode [protected]

Mode buttons.

Referenced by Decode(), Encode(), Mode(), Print(), and SetMode().

unsigned int Rcuxx::RcuTRCFG1::fTwv [protected]

# clock cycles between L1 and L2

Referenced by Decode(), Encode(), Print(), SetTwv(), and Twv().

unsigned int Rcuxx::RcuTRCFG1::fWptr [protected]

Write pointer.

Referenced by Decode(), Print(), and Wptr().

unsigned int Rcuxx::RcuTRCFG1::fRptr [protected]

Read pointer.

Referenced by Decode(), Print(), and Rptr().

unsigned int Rcuxx::RcuTRCFG1::fRemb [protected]

Free buffers.

Referenced by Decode(), Print(), and Remb().

bool Rcuxx::RcuTRCFG1::fEmpty [protected]

Wether buffers are empty.

Referenced by Decode(), IsEmpty(), and Print().

bool Rcuxx::RcuTRCFG1::fFull [protected]

Whether buffers are full.

Referenced by Decode(), IsFull(), and Print().

---

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

• RcuTRCFG1.h