CdtBaseBMAPI Class Reference

Base class for managing the CDT Beam Monitor API. Derived classes should inherit from this. More...

#include <CdtBaseBmAPI.h>

Inheritance diagram for CdtBaseBMAPI:

Collaboration diagram for CdtBaseBMAPI:

Public Member Functions
	CdtBaseBMAPI (RMMAPI *rmmApi, int ring, int node, std::string name, FENRegMap additional_reg_map)
	Constructor for the CdtBm 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.

Detailed Description

Base class for managing the CDT Beam Monitor API. Derived classes should inherit from this.

The CdtBaseBMAPI manages all basic parameters that all CDT equipment should inherit.

Constructor & Destructor Documentation

CdtBaseBMAPI()

CdtBaseBMAPI::CdtBaseBMAPI	(	RMMAPI *	rmmApi,
		int	ring,
		int	node,
		std::string	name,
		FENRegMap	additional_reg_map )

Constructor for the CdtBm class.

Initializes a new instance of the CdtBm class. Calls base class FrontEndBase constructor.

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]	additional_reg_map	map to add from derived classes. Can also be empty.
[in]	name	The name to identify the front-end instance.

Member Function Documentation

configAcquireTime()

void CdtBaseBMAPI::configAcquireTime

(

uint64_t

cycles

)

Sets the acquisition time. Executed inside configFE right before starting the acquisition.

Parameters

[in]

cycles

number of cycles for measurement to last. If 0, measure indefinitely.

isMeasRunning()

bool CdtBaseBMAPI::isMeasRunning

(

)

Checks if the measurement is currently running.

Returns

True if measurement is active, false otherwise.

measurementEnable()

void CdtBaseBMAPI::measurementEnable

(

bool

enable

)

Enables or disables the measurement process.

Parameters

[in]

enable

Set to true to start measurement, false to stop it.

---

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

• include/CdtBaseBmAPI.h
• src/CdtBaseBmAPI.cpp