WPILibC++ 2024.3.2
SimDeviceData.h File Reference
#include "hal/Types.h"
#include "hal/Value.h"

Go to the source code of this file.

Typedefs

typedef void(* HALSIM_SimDeviceCallback) (const char *name, void *param, HAL_SimDeviceHandle handle)
 
typedef void(* HALSIM_SimValueCallback) (const char *name, void *param, HAL_SimValueHandle handle, int32_t direction, const struct HAL_Value *value)
 

Functions

void HALSIM_SetSimDeviceEnabled (const char *prefix, HAL_Bool enabled)
 
HAL_Bool HALSIM_IsSimDeviceEnabled (const char *name)
 
int32_t HALSIM_RegisterSimDeviceCreatedCallback (const char *prefix, void *param, HALSIM_SimDeviceCallback callback, HAL_Bool initialNotify)
 
void HALSIM_CancelSimDeviceCreatedCallback (int32_t uid)
 
int32_t HALSIM_RegisterSimDeviceFreedCallback (const char *prefix, void *param, HALSIM_SimDeviceCallback callback, HAL_Bool initialNotify)
 
void HALSIM_CancelSimDeviceFreedCallback (int32_t uid)
 
HAL_SimDeviceHandle HALSIM_GetSimDeviceHandle (const char *name)
 
const char * HALSIM_GetSimDeviceName (HAL_SimDeviceHandle handle)
 
HAL_SimDeviceHandle HALSIM_GetSimValueDeviceHandle (HAL_SimValueHandle handle)
 
void HALSIM_EnumerateSimDevices (const char *prefix, void *param, HALSIM_SimDeviceCallback callback)
 
int32_t HALSIM_RegisterSimValueCreatedCallback (HAL_SimDeviceHandle device, void *param, HALSIM_SimValueCallback callback, HAL_Bool initialNotify)
 
void HALSIM_CancelSimValueCreatedCallback (int32_t uid)
 
int32_t HALSIM_RegisterSimValueChangedCallback (HAL_SimValueHandle handle, void *param, HALSIM_SimValueCallback callback, HAL_Bool initialNotify)
 
void HALSIM_CancelSimValueChangedCallback (int32_t uid)
 
int32_t HALSIM_RegisterSimValueResetCallback (HAL_SimValueHandle handle, void *param, HALSIM_SimValueCallback callback, HAL_Bool initialNotify)
 Register a callback for HAL_SimValueReset(). More...
 
void HALSIM_CancelSimValueResetCallback (int32_t uid)
 
HAL_SimValueHandle HALSIM_GetSimValueHandle (HAL_SimDeviceHandle device, const char *name)
 
void HALSIM_EnumerateSimValues (HAL_SimDeviceHandle device, void *param, HALSIM_SimValueCallback callback)
 
const char ** HALSIM_GetSimValueEnumOptions (HAL_SimValueHandle handle, int32_t *numOptions)
 
const double * HALSIM_GetSimValueEnumDoubleValues (HAL_SimValueHandle handle, int32_t *numOptions)
 
void HALSIM_ResetSimDeviceData (void)
 

Typedef Documentation

◆ HALSIM_SimDeviceCallback

typedef void(* HALSIM_SimDeviceCallback) (const char *name, void *param, HAL_SimDeviceHandle handle)

◆ HALSIM_SimValueCallback

typedef void(* HALSIM_SimValueCallback) (const char *name, void *param, HAL_SimValueHandle handle, int32_t direction, const struct HAL_Value *value)

Function Documentation

◆ HALSIM_CancelSimDeviceCreatedCallback()

void HALSIM_CancelSimDeviceCreatedCallback ( int32_t  uid)

◆ HALSIM_CancelSimDeviceFreedCallback()

void HALSIM_CancelSimDeviceFreedCallback ( int32_t  uid)

◆ HALSIM_CancelSimValueChangedCallback()

void HALSIM_CancelSimValueChangedCallback ( int32_t  uid)

◆ HALSIM_CancelSimValueCreatedCallback()

void HALSIM_CancelSimValueCreatedCallback ( int32_t  uid)

◆ HALSIM_CancelSimValueResetCallback()

void HALSIM_CancelSimValueResetCallback ( int32_t  uid)

◆ HALSIM_EnumerateSimDevices()

void HALSIM_EnumerateSimDevices ( const char *  prefix,
void *  param,
HALSIM_SimDeviceCallback  callback 
)

◆ HALSIM_EnumerateSimValues()

void HALSIM_EnumerateSimValues ( HAL_SimDeviceHandle  device,
void *  param,
HALSIM_SimValueCallback  callback 
)

◆ HALSIM_GetSimDeviceHandle()

HAL_SimDeviceHandle HALSIM_GetSimDeviceHandle ( const char *  name)

◆ HALSIM_GetSimDeviceName()

const char * HALSIM_GetSimDeviceName ( HAL_SimDeviceHandle  handle)

◆ HALSIM_GetSimValueDeviceHandle()

HAL_SimDeviceHandle HALSIM_GetSimValueDeviceHandle ( HAL_SimValueHandle  handle)

◆ HALSIM_GetSimValueEnumDoubleValues()

const double * HALSIM_GetSimValueEnumDoubleValues ( HAL_SimValueHandle  handle,
int32_t *  numOptions 
)

◆ HALSIM_GetSimValueEnumOptions()

const char ** HALSIM_GetSimValueEnumOptions ( HAL_SimValueHandle  handle,
int32_t *  numOptions 
)

◆ HALSIM_GetSimValueHandle()

HAL_SimValueHandle HALSIM_GetSimValueHandle ( HAL_SimDeviceHandle  device,
const char *  name 
)

◆ HALSIM_IsSimDeviceEnabled()

HAL_Bool HALSIM_IsSimDeviceEnabled ( const char *  name)

◆ HALSIM_RegisterSimDeviceCreatedCallback()

int32_t HALSIM_RegisterSimDeviceCreatedCallback ( const char *  prefix,
void *  param,
HALSIM_SimDeviceCallback  callback,
HAL_Bool  initialNotify 
)

◆ HALSIM_RegisterSimDeviceFreedCallback()

int32_t HALSIM_RegisterSimDeviceFreedCallback ( const char *  prefix,
void *  param,
HALSIM_SimDeviceCallback  callback,
HAL_Bool  initialNotify 
)

◆ HALSIM_RegisterSimValueChangedCallback()

int32_t HALSIM_RegisterSimValueChangedCallback ( HAL_SimValueHandle  handle,
void *  param,
HALSIM_SimValueCallback  callback,
HAL_Bool  initialNotify 
)

◆ HALSIM_RegisterSimValueCreatedCallback()

int32_t HALSIM_RegisterSimValueCreatedCallback ( HAL_SimDeviceHandle  device,
void *  param,
HALSIM_SimValueCallback  callback,
HAL_Bool  initialNotify 
)

◆ HALSIM_RegisterSimValueResetCallback()

int32_t HALSIM_RegisterSimValueResetCallback ( HAL_SimValueHandle  handle,
void *  param,
HALSIM_SimValueCallback  callback,
HAL_Bool  initialNotify 
)

Register a callback for HAL_SimValueReset().

The callback is called with the old value.

Parameters
handlesimulated value handle
paramparameter for callback
callbackcallback
initialNotifyignored (present for consistency)

◆ HALSIM_ResetSimDeviceData()

void HALSIM_ResetSimDeviceData ( void  )

◆ HALSIM_SetSimDeviceEnabled()

void HALSIM_SetSimDeviceEnabled ( const char *  prefix,
HAL_Bool  enabled 
)