SimDeviceData.h

Go to the documentation of this file.

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
#pragma once
 
#include "hal/Types.h"
#include "hal/Value.h"
 
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);
 
#ifdef __cplusplus
extern "C" {
#endif
 
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);
 
/**
 * Register a callback for HAL_SimValueReset(). The callback is called with the
 * old value.
 *
 * @param handle simulated value handle
 * @param param parameter for callback
 * @param callback callback
 * @param initialNotify ignored (present for consistency)
 */
int32_t HALSIM_RegisterSimValueResetCallback(HAL_SimValueHandle handle,
                                             void* param,
                                             HALSIM_SimValueCallback callback,
                                             HAL_Bool initialNotify);
 
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);
 
#ifdef __cplusplus
}  // extern "C"
#endif