Base class for managing the CDT Frontend nodes API. Derived classes should inherit from this. More...

#include <CdtBaseAPI.h>

Inheritance diagram for CdtBaseAPI:

[legend]

Collaboration diagram for CdtBaseAPI:

Public Member Functions
	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.

Detailed Description

Base class for managing the CDT Frontend nodes API. Derived classes should inherit from this.

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

Constructor & Destructor Documentation

Constructor for the Cdt class.

Initializes a new instance of the Cdt 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.

void CdtBaseAPI::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.

bool CdtBaseAPI::isMeasRunning ( )

Checks if the measurement is currently running.

void CdtBaseAPI::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: