CDT I-BM API 1.0.0
Loading...
Searching...
No Matches
CdtDream Class Reference
Inheritance diagram for CdtDream:
Collaboration diagram for CdtDream:

Public Member Functions

 CdtDream (RMMAPI *rmmApi, int ring, int node, std::string name)
 Constructor for the CdtDream class.
 
void configFE ()
 
void resetCore ()
 
uint64_t readUid (rmmStatus *status=NULL, uint32_t timeout=100)
 Tries to read UID for some time. If it fails, return rmmError in status.
 
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 Member Functions inherited from CdtCipix
 CdtCipix (std::string name)
 
uint8_t getMaxCipix () 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.
 
- Public Member Functions inherited from CdtBaseBMAPI
 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.
 

Additional Inherited Members

- Public Types inherited from CdtCipix
using CipixMap = std::unordered_map<std::string, uint8_t>
 
using FwMap = std::map<std::string, FwInfo>
 
- Protected Attributes inherited from CdtCipix
uint8_t maxCipix
 

Constructor & Destructor Documentation

◆ CdtDream()

CdtDream::CdtDream ( RMMAPI * rmmApi,
int ring,
int node,
std::string name )

Constructor for the CdtDream class.

Initializes a new instance of the CdtDream class by calling the base classes FrontEndBase and CdtCipix constructors.

Parameters
[in]rmmApiPointer to the RMMAPI instance used for communication and management of the RMM.
[in]ringThe ring number.
[in]nodeThe node number.
[in]nameThe name to identify the front-end instance.

Member Function Documentation

◆ readSimParams()

rmmStatus CdtDream::readSimParams ( SimInfo & simInfo)

Reads registers telling the simulation params.

Parameters
simInfoStruct to be filled with current simulation parameters.
Returns
rmmStatus. If non-zero, then reading failed.

◆ readUid()

uint64_t CdtDream::readUid ( rmmStatus * status = NULL,
uint32_t timeout = 100 )

Tries to read UID for some time. If it fails, return rmmError in status.

Parameters
[in]timeouttimeout in milliseconds to keep trying if status_uid_error returns something different than 0.
Returns
RMMResult.
See also
RMMResult

◆ writeSim()

rmmStatus CdtDream::writeSim ( bool enable,
uint32_t pause_cycles = 0 )

Starts or stops simulated data.

Parameters
[in]enabletrue to activate simulated data. False to stop.
[in]pause_cyclesNumber of pauses cycles.
Returns
rmmStatus An enum indicating the status of the operation.
See also
rmmStatus

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