WPILibC++  2019.1.1-beta-1-26-g8be693f
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Simulator Extensions

HAL Simulator Extensions. More...

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...
 

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

int HAL_LoadExtensions ( void  )

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

Returns
the succes state of the initialization
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