Group cuvis_general

General Configuration Options of the SDK. More...

Public Functions

Type	Name
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_get_userplugin_engine_version (CUVIS_CHAR * o_pVersion) Get the Userplugin processing engine version number.
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_init (CUVIS_CHAR const * i_settings_path, CUVIS_INT i_global_loglevel, CUVIS_CHAR const * i_logfile_name)
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_shutdown ()
SDK_CAPI CUVIS_STATUS SDK_CCALL	cuvis_version (CUVIS_CHAR * o_pVersion) Get the SDK version.

Detailed Description

The cuvis_init function set the reference to a settings directory. It should be the first call in a program that uses the cuvis SDK, and is only possible once. In the settings directory there can be multiple settings file present. Settings files are identified by a .settings extension. Each Settings file is a xml file that contains a collection of property nodes. All the settings files get merged into one collection of property nodes. Therefore no property nodes is allowed to be present multiple times.

Public Functions Documentation

function cuvis_get_userplugin_engine_version

Get the Userplugin processing engine version number.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_get_userplugin_engine_version (
    CUVIS_CHAR * o_pVersion
)

Parameters:

o_pVersion The output version string. The provided array must have the length of CUVIS_MAXBUF

function cuvis_init

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_init (
    CUVIS_CHAR const * i_settings_path,
    CUVIS_INT i_global_loglevel,
    CUVIS_CHAR const * i_logfile_name
)

The init function set the settings path.

Parameters:

i_settings_path The path to the settings directory.
i_global_loglevel The log level that will be used for the backend logging system
i_logfile_name The name of the logfile that is going to be written

function cuvis_shutdown

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_shutdown ()

Function for shutting down Cuvis safely. Gently stops all threads.

function cuvis_version

Get the SDK version.

SDK_CAPI  CUVIS_STATUS  SDK_CCALL cuvis_version (
    CUVIS_CHAR * o_pVersion
)

Parameters:

o_pVersion The output version string. The provided array must have the length of CUVIS_MAXBUF