CdtCascadeAPI Class Reference

CDT Cascade Beam Monitor Main class. More...

#include <CdtCascadeAPI.h>

Inheritance diagram for CdtCascadeAPI:

Collaboration diagram for CdtCascadeAPI:

Public Member Functions
	CdtCascadeAPI (RMMAPI *rmmApi, int ring, int node, std::string name, TiaBoardVersion tia_board_version)
	Constructor for the CdtCascadeAPI class.
RMMResult	readProperty (CascadeProp prop)
	Reads a cascade Property from hardware.
rmmStatus	writeProperty (CascadeProp prop, uint32_t val)
	Writes a cascade Property to hardware.
rmmStatus	writeDefaultProperties (std::initializer_list< CascadeProp > props, bool clearUnmappedBits=false)
rmmStatus	writeDefaultProperty (CascadeProp prop)
	Gets a property from memory, writes it into hardware.
void	configFE ()
Public Member Functions inherited from CdtHv
	CdtHv (std::string name, TiaBoardVersion tia_board_version)
TiaBoardVersion	getTiaBoardVersion () const
const std::string &	getTiaBoardVersionLabel () const
void	setHvTimeout (uint32_t val)
uint32_t	getHvTimeout ()
bool	isHVRampRunning () const
	Checks if the high-voltage (HV) ramp process is currently running.
void	requestHVStop ()
	Requests to stop ongoing operations.
void	resetHVStop ()
	Resets the stop request flag, allowing operations to continue.
double	readHV (rmmStatus *status=NULL)
	Reads the measured voltage from the HV chip via I2C.
void	writeHV (const double voltage, const double voltagePerSec)
	Writes a voltage value to the HV chip, ensuring proper enabling and smooth ramping.
bool	isStopHVRequested () const
	Checks if a stop request has been issued.
Public Member Functions inherited from CdtBaseAPI
	CdtBaseAPI (RMMAPI *rmmApi, int ring, int node, std::string name, FENRegMap additional_reg_map)
	Constructor for the Cdt class.
void	configAcquireTime (uint64_t cycles)
	Sets the acquisition time. Executed inside configFE right before starting the acquisition.
void	measurementEnable (bool enable)
	Enables or disables the measurement process.
bool	isMeasRunning ()
	Checks if the measurement is currently running.
Public Member Functions inherited from CdtCDRE
	CdtCDRE (std::string name)
uint8_t	getMaxCipix () const
std::string	getFwAlias () const
void	fetchFwInfo ()
RMMResult	cipixRegRead (int cipixIdx, std::string reg)
	Reads a value from a cipix register.
RMMResult	cipixRegWrite (int cipixIdx, std::string, uint8_t wdata)
	Writes a value to a cipix register and returns the read value.
rmmStatus	writeSim (bool enable, uint32_t pause_cycles=0)
	Starts or stops simulated data.
rmmStatus	readSimParams (SimInfo &simInfo)
	Reads registers telling the simulation params.

Public Attributes
RMMLog	log

Additional Inherited Members
Public Types inherited from CdtCDRE
using	CipixPair = std::pair<std::string, uint8_t>
using	CipixVector = std::vector<CipixPair>
using	FwMap = std::map<std::string, FwInfo>
Static Public Member Functions inherited from CdtCDRE
static const CipixVector &	getCipixMap ()
Protected Member Functions inherited from CdtHv
uint32_t	calcDacForVoltage (const double voltage)
	Calculates the DAC value for a given voltage.
void	jumpToVoltage (const double voltage)
	Jumps to a specific high voltage value.
bool	isI2cRequestDone ()
	Checks if an I2C request has completed.
rmmStatus	runI2cRequest (I2cRequestAction action, uint32_t dac_value=0xFF)
	Executes an I2C read or write request to the HV module.
Protected Attributes inherited from CdtHv
std::atomic< uint32_t >	previousDacValue {0}
TiaBoardVersion	tiaVersion
std::string	tiaBoardVersionLabel
Protected Attributes inherited from CdtCDRE
uint8_t	maxCipix
std::string	fwAlias = "Undefined"

Detailed Description

CDT Cascade Beam Monitor Main class.

Constructor & Destructor Documentation

CdtCascadeAPI()

CdtCascadeAPI::CdtCascadeAPI	(	RMMAPI *	rmmApi,
		int	ring,
		int	node,
		std::string	name,
		TiaBoardVersion	tia_board_version )

Constructor for the CdtCascadeAPI class.

Initializes a new instance of the CdtCascadeAPI class. Calls base class CdtBm constructor. Function with "set" and "get" in the name deal with class parameters. Function with "read" and "write" deal with the actual registers.

Parameters

[in]	rmmApi	Pointer to the RMMAPI instance used for communication and management of the RMM
[in]	ring	The ring number.
[in]	node	The node number.
[in]	name	The name to identify the front-end instance.
[in]	tia_board_version	version of tiaBoard.

Member Function Documentation

readProperty()

RMMResult CdtCascadeAPI::readProperty

(

CascadeProp

prop

)

Reads a cascade Property from hardware.

Parameters

[in]

prop

property to read

Returns

RMMResult with value and operation status code.

writeDefaultProperty()

rmmStatus CdtCascadeAPI::writeDefaultProperty

(

CascadeProp

prop

)

Gets a property from memory, writes it into hardware.

Parameters

[in]

prop

property to dump

Returns

rmmStatus with operation status code.

writeProperty()

rmmStatus CdtCascadeAPI::writeProperty	(	CascadeProp	prop,
		uint32_t	val )

Writes a cascade Property to hardware.

Parameters

[in]

stat

optional rmmStatus pointer to get operation status.

Returns

rmmStatus with operation status code.

---

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

• include/CdtCascadeAPI.h
• src/CdtCascadeAPI.cpp