WPILibC++  2020.2.2-33-g65eab93
Simulator Extensions

Typedefs

typedef int halsim_extension_init_func_t(void)
 

Functions

int HAL_LoadOneExtension (const char *library)
 Loads a single extension from a direct path. More...
 
int HAL_LoadExtensions (void)
 Loads any extra halsim libraries provided in the HALSIM_EXTENSIONS environment variable. More...
 
void HAL_SetShowExtensionsNotFoundMessages (HAL_Bool showMessage)
 Enables or disables the message saying no HAL extensions were found. More...
 

Detailed Description

HAL Simulator Extensions. These are libraries that provide additional simulator functionality, such as a Gazebo interface, or a more light weight simulation.

An extension must expose the HALSIM_InitExtension entry point which is invoked after the library is loaded.

The entry point is expected to return < 0 for errors that should stop the HAL completely, 0 for success, and > 0 for a non fatal error.

Function Documentation

◆ HAL_LoadExtensions()

int HAL_LoadExtensions ( void  )

Loads any extra halsim libraries provided in the HALSIM_EXTENSIONS environment variable.

Returns
the succes state of the initialization

◆ HAL_LoadOneExtension()

int HAL_LoadOneExtension ( const char *  library)

Loads a single extension from a direct path.

Expected to be called internally, not by users.

Parameters
librarythe library path
Returns
the succes state of the initialization

◆ HAL_SetShowExtensionsNotFoundMessages()

void HAL_SetShowExtensionsNotFoundMessages ( HAL_Bool  showMessage)

Enables or disables the message saying no HAL extensions were found.

Some apps don't care, and the message create clutter. For general team code, we want it.

This must be called before HAL_Initialize is called.

This defaults to true.

Parameters
showMessagetrue to show message, false to not.