Method class for Callback functions. More...

#include <erk_capi.h>

Inheritance diagram for ERK_CAPI_CALLBACKS:

Static Public Member Functions
static DLLAPI void ER_STDCALL	erSetCallBack_LogProc (TerLogProc Handler)
	Define Callback function for Log Messages. More...

static DLLAPI void ER_STDCALL	erEnableCallBack_LogProc (long onoff)
	Enable/Disable Log messages. This function enables or disables Log Messages used with callback function TerLogProc This function can be called before kernel initialization erKernelInitialize() More...

static DLLAPI void ER_STDCALL	erSetCallBack_LoadGeometryProc (TerLoadGeometryProc Handler)
	Define Callback function to load a geometry The Host application is prompted to load a geometry. More...

static DLLAPI void ER_STDCALL	erSetCallBack_UpdateGeometryProc (TerUpdateGeometryProc Handler)
	Define Callback function to update geometries The Host application is prompted to update a geometry. More...

static DLLAPI void ER_STDCALL	erSetCallBack_FreeGeometryProc (TerFreeGeometryProc Handler)
	Define Callback function to free Geometry The Host application is prompted to free a geometry. More...

static DLLAPI void ER_STDCALL	erSetCallBack_GetActualTravelRangesProc (TerGetActualTravelRangesProc Handler)
	Define Callback function to calculate travel ranges by host application The Host application takes care to calculate the travel ranges. More...

static DLLAPI void ER_STDCALL	erSetCallBack_NotifyProc (TerNotifyProc Handler)
	Define Callback function for notify messages The Kernel informs the host application about internel status messages. More...

static DLLAPI void ER_STDCALL	erSetCallBack_GrpSyncProc (TerGrpSyncProc Handler)
	Define Callback function for group synchonization. More...

Static Public Member Functions inherited from ERK_CAPI_ADMIN
static DLLAPI int ER_STDCALL	erKernelGetVersion (void)
	Robotics Simulation Kernel Version. More...

static DLLAPI int ER_STDCALL	erKernelSetLicensePriority (int license_priority)
	Set license priority. Call this function before initializing the Kernel erKernelInitialize() Parameter `license_priority` is one of ER_LICENSE_PRIORITY_LMNGR, ER_LICENSE_PRIORITY_LOCAL If `license_priority` is not set, ER_LICENSE_PRIORITY_LMNGR is default setting, see erKernelGetLicensePriority() More...

static DLLAPI int ER_STDCALL	erKernelGetLicensePriority (int *license_priority)
	Get license priority. Parameter `license_priority` is one of ER_LICENSE_PRIORITY_LMNGR, ER_LICENSE_PRIORITY_LOCAL If `license_priority` is not set, ER_LICENSE_PRIORITY_LMNGR is default setting, see erKernelSetLicensePriority() More...

static DLLAPI int ER_STDCALL	erKernelSetLicenseFile (char *license_file)
	Set location and name of license file. Call this function before initializing the Kernel erKernelInitialize() If `license_file` is not set, it is supposed that the license file resides in the current folder, see erKernelGetLicenseFile(), erKernelAddLicenseFile() More...

static DLLAPI int ER_STDCALL	erKernelAddLicenseFile (char *license_file)
	Set an additional location and name of license file. Call this function before initializing the Kernel erKernelInitialize() If `license_file` is not set, it is supposed that the license file resides in the current folder, see erKernelGetLicenseFile(), erKernelSetLicenseFile() More...

static DLLAPI int ER_STDCALL	erKernelGetLicenseFile (char *license_file)
	Get location and name of license file. If `license_file` is not set the string is empty, see erKernelSetLicenseFile(), erKernelAddLicenseFile() More...

static DLLAPI int ER_STDCALL	erKernelInitialize (char HostApplicationPath, char Sold_To_ID, long mode=0)
	Initializes the Kernel. After calling this initial functions all other kernel functions are available. Before calling this initial functions all callback functions should be defined and initialized, thus they can be used when calling this function. The `HostApplicationPath` must contain the path where the host application is running. The maximum string lenght is ER_HS_MAXSTR The `Sold_To_ID` contains an individual customer identifier, per default = NULL The `mode` is not implemented yet, per default = 0. More...

static DLLAPI void ER_STDCALL	erKernelFree (void)
	Free all internal Kernel data. Calling this function will delete all internal Kernel data After calling this functions not any kernel functions is available Even callback functions are not available. More...

static DLLAPI int ER_STDCALL	erKernelGetLicense (char *hw_id)
	Check license and supplies unique HardwareID or DongleID. More...

static DLLAPI int ER_STDCALL	erKernelGetHardwareID (char *hw_id)
	Supplies unique HardwareID or DongleID. More...

static DLLAPI int ER_STDCALL	erKernelGetOptions (char *opt)
	Supplies option string containing all enabled options. More...

static DLLAPI int ER_STDCALL	erKernelGetOptionsDisabled (char *nopt)
	Supplies option string containing all disabled options. More...

Additional Inherited Members
Static Public Attributes inherited from ERK_CAPI
static ERK_CAPI_ADMIN	erk_capi_admin
	Method class to administrate this Robotics Simulation Kernel. More...

static ERK_CAPI_DEVICES	erk_capi_devices
	Method class to create, attach, update devices, for kinematics calculations and for motion planning and -execution. More...

static ERK_CAPI_SIM	erk_capi_sim
	Method class for simulation settings. More...

static ERK_CAPI_AUTOPATH	erk_capi_autopath
	Method class for collision free path planning. More...

static ERK_CAPI_TARGETS	erk_capi_targets
	Method class for paths and tags. More...

static ERK_CAPI_GEO	erk_capi_geo
	Method class to handle 3D Geometry Data. More...

static ERK_CAPI_SYS	erk_capi_sys
	Method class for mathematical calculations, simulation status, units. More...

Detailed Description

Method class for Callback functions.

Member Function Documentation

◆ erEnableCallBack_LogProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erEnableCallBack_LogProc ( long onoff )

static

Enable/Disable Log messages.
This function enables or disables Log Messages used with callback function TerLogProc This function can be called before kernel initialization erKernelInitialize()

// Example:
long m_LogProc;         // 1-enable Log Messages for Callback Function, see erSetCallBack_LogProc(); 0-disable
m_LogProc = 1;          // enable log messages before kernel initialization
erEnableCallBack_LogProc(m_LogProc);
...
char HostPath[LS_MAXSTR];       // HostApplictaionPathPath
getcwd(HostPath,LS_MAXSTR);     // get current workinbg directory
char *Sold_To_ID = NULL;        // individual customer identifier
erKernelInitialize(HostPath,Sold_To_ID);
...

Parameters

[in] onoff =1 enable, =0 disable

Return values

void

◆ erSetCallBack_FreeGeometryProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_FreeGeometryProc ( TerFreeGeometryProc Handler )

static

Define Callback function to free Geometry The Host application is prompted to free a geometry.

Parameters

[in] Handler TerFreeGeometryProc function pointer

Return values

void

◆ erSetCallBack_GetActualTravelRangesProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_GetActualTravelRangesProc ( TerGetActualTravelRangesProc Handler )

static

Define Callback function to calculate travel ranges by host application The Host application takes care to calculate the travel ranges.

Parameters

[in] Handler TerGetActualTravelRangesProc function pointer

Return values

void

◆ erSetCallBack_GrpSyncProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_GrpSyncProc ( TerGrpSyncProc Handler )

static

Define Callback function for group synchonization.

Parameters

[in] Handler TerGrpSyncProc function pointer

Return values

void

◆ erSetCallBack_LoadGeometryProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_LoadGeometryProc ( TerLoadGeometryProc Handler )

static

Define Callback function to load a geometry The Host application is prompted to load a geometry.

Parameters

[in] Handler TerLoadGeometryProc function pointer

Return values

void

◆ erSetCallBack_LogProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_LogProc ( TerLogProc Handler )

static

Define Callback function for Log Messages.

Parameters

[in] Handler TerLogProc function pointer

Return values

void

◆ erSetCallBack_NotifyProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_NotifyProc ( TerNotifyProc Handler )

static

Define Callback function for notify messages The Kernel informs the host application about internel status messages.

Parameters

[in] Handler TerNotifyProc function pointer

Return values

void

◆ erSetCallBack_UpdateGeometryProc()

static DLLAPI void ER_STDCALL ERK_CAPI_CALLBACKS::erSetCallBack_UpdateGeometryProc ( TerUpdateGeometryProc Handler )

static

Define Callback function to update geometries The Host application is prompted to update a geometry.

Parameters

[in] Handler TerUpdateGeometryProc function pointer

Return values

void

The documentation for this class was generated from the following file:

erk_capi.h

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ erEnableCallBack_LogProc()

◆ erSetCallBack_FreeGeometryProc()

◆ erSetCallBack_GetActualTravelRangesProc()

◆ erSetCallBack_GrpSyncProc()

◆ erSetCallBack_LoadGeometryProc()

◆ erSetCallBack_LogProc()

◆ erSetCallBack_NotifyProc()

◆ erSetCallBack_UpdateGeometryProc()