EASY-ROB™ Kernel
v8.606
|
Method class to administrate this Robotics Simulation Kernel. More...
#include <erk_capi.h>
Static Public Member Functions | |
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_LOCALIf 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_LOCALIf 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_MAXSTRThe Sold_To_ID contains an individual customer identifier, per default = NULLThe 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... | |
Static Private Attributes | |
static ERK_CAPI_CALLBACKS | erk_capi_callback |
Method class for Callback functions. 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... | |
Method class to administrate this Robotics Simulation Kernel.
|
static |
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()
[in] | license_file | string, maximum lengths ER_HS_MAXSTR |
0 | - OK |
1 | - Error file not found or Kernal already initialized |
|
static |
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.
|
static |
Supplies unique HardwareID or DongleID.
[out] | hw_id | string, maximum lengths ER_MAXSTR |
0 | - OK |
1 | - Error no Hardware ID or Dongle ID available |
|
static |
Check license and supplies unique HardwareID or DongleID.
[out] | hw_id | string, maximum lengths ER_MAXSTR |
0 | - Ok, valid license with valid Hardware- or Dongle ID |
1 | - Invalid license, Hardware- or Dongle ID not availabe |
|
static |
Get location and name of license file.
If license_file
is not set the string is empty, see erKernelSetLicenseFile(), erKernelAddLicenseFile()
[out] | license_file | string, maximum lengths ER_HS_MAXSTR |
0 | - OK |
1 | - Error file not found or not set |
|
static |
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()
[out] | license_priority | license priority |
0 | - OK |
1 | - Error, invalid license priority or Kernal already initialized |
|
static |
Supplies option string containing all enabled options.
[out] | opt | Option string, maximum lengths ER_LS_MAXSTR |
0 | - OK |
1 | - Error NOT licensed |
|
static |
Supplies option string containing all disabled options.
[out] | nopt | Option string, maximum lengths ER_LS_MAXSTR |
0 | - OK |
1 | - Error NOT licensed |
|
static |
Robotics Simulation Kernel Version.
version | Kernel version number |
|
static |
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.
[in] | HostApplicationPath | host application path |
[in] | Sold_To_ID | individual customer identifier |
[in] | mode | =0, tbd |
0 | - OK |
1 | - Error, cannot initialize kernel, no valid license for example |
|
static |
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()
[in] | license_file | string, maximum lengths ER_HS_MAXSTR |
0 | - OK |
1 | - Error file not found or Kernal already initialized |
|
static |
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()
[in] | license_priority | license priority |
0 | - OK |
1 | - Error, invalid license priority or Kernal already initialized |
|
staticprivate |
Method class for Callback functions.