EASY-ROB™ Application Programming Interface  v8.008
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Static Public Member Functions | List of all members
ER_CAPI_SYS_STATUS Class Reference

Method class for unloading objects (work cells, robots, tools, programs, etc.) simulation status. More...

#include <ER_CAPI.H>

Inheritance diagram for ER_CAPI_SYS_STATUS:
ER_CAPI_SYS ER_CAPI

Static Public Member Functions

static ER_DllExport char * EasyRobProduct (void)
 EASY-ROB Product. More...
 
static ER_DllExport char * EasyRobPlatform (void)
 EASY-ROB Platform, x86 or x64. More...
 
static ER_DllExport char * EasyRobVer (void)
 EASY-ROB Product Version. More...
 
static ER_DllExport int check_license (int opt_id)
 Check Licenses for options and modules Parameter opt_id is one of ER_LIC_STD_BASIC .. ER_LIC_STD_COLL .. ER_LIC_STD_ROBMOD .. ER_LIC_API_UDLL. More...
 
static ER_DllExport int get_hardware_id (char *hw_id)
 Supplies unique HardwareID or DongleID. More...
 
static ER_DllExport int Init_ER_DLL_Window (int InitOptions)
 Initialize EASY-ROB DLL Window Parameter InitOptions is currently not used. More...
 
static ER_DllExport char * get_system_folder_file (int request_idx=SYS_SYSTEM_FOLDER_DIRECTORY_UNDEF)
 Supplies requested system path or file. Parameter request_idx is one of SYS_SYSTEM_FOLDER_DIRECTORY_UNDEF, SYS_SYSTEM_FOLDER_DIRECTORY_LIST, SYS_SYSTEM_FOLDER_DIRECTORY_CONIFG_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_LICENSE_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_MONITORING_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_ENVIRONMENT_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_WORKING_PATHES_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_LOADFROMLIB_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_LOADFROMLIB_PREFERRED_FILE, SYS_SYSTEM_FOLDER_DIRECTORY_APPLICATION_DIR, SYS_SYSTEM_FOLDER_DIRECTORY_WORKING_DIR, SYS_SYSTEM_FOLDER_DIRECTORY_USR_DIR, SYS_SYSTEM_FOLDER_DIRECTORY_TMP_DIR, SYS_SYSTEM_FOLDER_DIRECTORY_KERNEL_IO_DIR, SYS_SYSTEM_FOLDER_DIRECTORY_EDIT_PRG
. More...
 
static ER_DllExport int * inq_modified_cell (void)
 Flag if cell file is modified. More...
 
static ER_DllExport int set_commandline (char *cmdline)
 Set the command line
The given command will be executed immediatly
See also EASY-ROB-ShortKeys-eng.pdf
Example "-message". More...
 
static ER_DllExport char * get_commandline (void)
 Get the command line when EASY-ROB was started
See also EASY-ROB-ShortKeys-eng.pdf. More...
 
static ER_DllExport int CloseApplication (int confirm=0)
 Close EASY-ROB application
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int SetWindowPos (void *pWndInsertAfter, int x, int y, int cx, int cy, UINT nFlags)
 Set the position and size of EASY-ROB's OpenGL window. More...
 
static ER_DllExport int GetWindowPos (int *x, int *y, int *cx, int *cy)
 Get the position and size of EASY-ROB's OpenGL window. More...
 
static ER_DllExport int UnloadCell (int confirm=1)
 Unload current loaded work cell
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadRobot (int confirm=1)
 Unload current Robot
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadTool (int confirm=1)
 Unload current Tool
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadProgram (int confirm=1)
 Unload current robot Program
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadMimic (int confirm=1)
 Unload current robot Mimic file
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadBody (int confirm=1)
 Unload Body group
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadTag (int confirm=1)
 Unload current Tag
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadPath (int confirm=1)
 Unload current Path
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int UnloadPathAll (int confirm=1)
 Unload all Pathes
If paramter confirm is set to 1, the user will be prompted to confirm this operation. More...
 
static ER_DllExport int ChkRobotCellLoaded (int confirm=0)
 Check if cell is loaded or at if least one robot is available
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages. More...
 
static ER_DllExport int ChkBodysCellLoaded (int confirm=0)
 Check if Bodies are loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages. More...
 
static ER_DllExport int ChkToolRobotLoaded (int confirm=0)
 Check if robot Tool is loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages. More...
 
static ER_DllExport int ChkTagsLoaded (int confirm=0)
 Check if Tags are loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages. More...
 
static ER_DllExport int ChkPrgLoaded (int confirm=0, int set_prg_dev=0)
 Check if a robot Program file is loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages
If Parameter set_prg_dev is set to 1, the first device with a loaded program will be used.
Otherwise it will be checked if the current device has a program loaded. More...
 
static ER_DllExport int ChkPrgMimicLoaded (int confirm=0)
 Check if a robot Mimic file is loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages. More...
 
static ER_DllExport char * GetCellfile (void)
 Returns name of current loaded cell file. More...
 
static ER_DllExport char * inq_config_workdir (void)
 Returns folder string for current working directory. More...
 
static ER_DllExport char * GetSystemPath (void)
 EasyEdit SystemPath
obsolete. More...
 
static ER_DllExport int * inq_EasyRobDll_Active (void)
 Check if EASY-ROB Application is still active. More...
 
static ER_DllExport int * inq_EasyRobDll_Activ (void)
 Obsolete use inq_EasyRobDll_Active() More...
 
static ER_DllExport void * inq_EasyRobDll_Hwnd (void)
 Get EASY-ROB Handle from CWnd class. More...
 
static ER_DllExport ER_UID inq_EasyRobDll_Hwnd_ex (void)
 Get EASY-ROB Handle from HWND, GetSafeHwnd() More...
 
static ER_DllExport int ShellExecuteOpen (char *prg, char *parameter=NULL, int nShowCmd=SW_SHOWNORMAL)
 Performs an 'open' operation on a specified program file. More...
 
static ER_DllExport int ShellExecuteEdit (char *fln)
 Opens the specified file with the assigned editor
See configuration file config.dat. More...
 

Additional Inherited Members

- Static Public Attributes inherited from ER_CAPI_SYS
static ER_CAPI_SYS_UTILITIES er_capi_sys_utilities
 Method class for helping functions, color conversion, etc. More...
 
static ER_CAPI_SYS_MATHEMATICS er_capi_sys_mathematics
 Method class for mathematical calculations, multiplications of homogeneous matrices, conversion Euler angle, triangle calculations, formula parser, etc. More...
 
static ER_CAPI_SYS_VIEW er_capi_sys_view
 Method class for graphical update of the 3D scene, refreshing dialogs, etc. More...
 
static ER_CAPI_SYS_PREVIEW er_capi_sys_preview
 Method class for the CAD-Preview. More...
 
static ER_CAPI_SYS_STATUS er_capi_sys_status
 Method class for unloading objects (work cells, robots, tools, programs, etc.) simulation status. More...
 
static ER_CAPI_SYS_UNITS er_capi_sys_units
 Method class for setting and calculating units. More...
 
static ER_CAPI_SYS_USERDLL er_capi_sys_userdll
 Method class to access API UserDll. More...
 
static ER_CAPI_SYS_APIDLL er_capi_sys_apidll
 Method class to access API Dll for inverse kinematics, robot trajectory planner and robot dynamics. More...
 
- Static Public Attributes inherited from ER_CAPI
static ER_CAPI_USER_IO er_capi_user_io
 Method class for interaction with EASY-ROB. More...
 
static ER_CAPI_DEVICES er_capi_devices
 Method class to create, attach, update devices, for kinematics calculations and for trajectory planning and -execution. More...
 
static ER_CAPI_SIM er_capi_sim
 Method class for simulation settings. More...
 
static ER_CAPI_TARGETS er_capi_targets
 Method class for paths and tags. More...
 
static ER_CAPI_CAD er_capi_cad
 Method class for for 3D CAD Data import and -export, changing attributes and positions. More...
 
static ER_CAPI_SYS er_capi_sys
 Method class for mathematical calculations, simulation status, units. More...
 

Detailed Description

Method class for unloading objects (work cells, robots, tools, programs, etc.) simulation status.

Member Function Documentation

static ER_DllExport int ER_CAPI_SYS_STATUS::check_license ( int  opt_id)
static

Check Licenses for options and modules Parameter opt_id is one of ER_LIC_STD_BASIC .. ER_LIC_STD_COLL .. ER_LIC_STD_ROBMOD .. ER_LIC_API_UDLL.

Parameters
[in]opt_id
Return values
1- Option or module is licemsed
0- Option or module is NOT available or NOT licemsed
static ER_DllExport int ER_CAPI_SYS_STATUS::ChkBodysCellLoaded ( int  confirm = 0)
static

Check if Bodies are loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Body or Cell loaded
static ER_DllExport int ER_CAPI_SYS_STATUS::ChkPrgLoaded ( int  confirm = 0,
int  set_prg_dev = 0 
)
static

Check if a robot Program file is loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages
If Parameter set_prg_dev is set to 1, the first device with a loaded program will be used.
Otherwise it will be checked if the current device has a program loaded.

Parameters
[in]confirm
[in]set_prg_dev
Return values
0- ER_OK
1- No program loaded
static ER_DllExport int ER_CAPI_SYS_STATUS::ChkPrgMimicLoaded ( int  confirm = 0)
static

Check if a robot Mimic file is loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Mimic loaded
static ER_DllExport int ER_CAPI_SYS_STATUS::ChkRobotCellLoaded ( int  confirm = 0)
static

Check if cell is loaded or at if least one robot is available
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Robot or Cell loaded
static ER_DllExport int ER_CAPI_SYS_STATUS::ChkTagsLoaded ( int  confirm = 0)
static

Check if Tags are loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Tags loaded
static ER_DllExport int ER_CAPI_SYS_STATUS::ChkToolRobotLoaded ( int  confirm = 0)
static

Check if robot Tool is loaded
If paramter confirm is set to 1, the user will be prompted to confirm upcoming messages.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Tool or Robot loaded
static ER_DllExport int ER_CAPI_SYS_STATUS::CloseApplication ( int  confirm = 0)
static

Close EASY-ROB application
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
static ER_DllExport char* ER_CAPI_SYS_STATUS::EasyRobPlatform ( void  )
static

EASY-ROB Platform, x86 or x64.

Return values
versionEASY-ROB Platform
static ER_DllExport char* ER_CAPI_SYS_STATUS::EasyRobProduct ( void  )
static

EASY-ROB Product.

Return values
versionEASY-ROB Product
static ER_DllExport char* ER_CAPI_SYS_STATUS::EasyRobVer ( void  )
static

EASY-ROB Product Version.

Return values
versionEASY-ROB Product version number
static ER_DllExport char* ER_CAPI_SYS_STATUS::get_commandline ( void  )
static

Get the command line when EASY-ROB was started
See also EASY-ROB-ShortKeys-eng.pdf.

Return values
pointerto commandline string MAXSTR
static ER_DllExport int ER_CAPI_SYS_STATUS::get_hardware_id ( char *  hw_id)
static

Supplies unique HardwareID or DongleID.

Parameters
[out]hw_idstring, maximum lengths MAXSTR
Return values
0- OK
1- Error no Hardware ID or Dongle ID available
static ER_DllExport char* ER_CAPI_SYS_STATUS::get_system_folder_file ( int  request_idx = SYS_SYSTEM_FOLDER_DIRECTORY_UNDEF)
static
static ER_DllExport char* ER_CAPI_SYS_STATUS::GetCellfile ( void  )
static

Returns name of current loaded cell file.

Return values
nameof current loaded cell file
static ER_DllExport char* ER_CAPI_SYS_STATUS::GetSystemPath ( void  )
static

EasyEdit SystemPath
obsolete.

Return values
systempath
static ER_DllExport int ER_CAPI_SYS_STATUS::GetWindowPos ( int *  x,
int *  y,
int *  cx,
int *  cy 
)
static

Get the position and size of EASY-ROB's OpenGL window.

Parameters
[out]xposition of the left side of the window
[out]yposition of the top of the window
[out]cxwidth of the window
[out]cyheight of the window
Return values
0- ER_OK
static ER_DllExport int ER_CAPI_SYS_STATUS::Init_ER_DLL_Window ( int  InitOptions)
static

Initialize EASY-ROB DLL Window Parameter InitOptions is currently not used.

Parameters
[in]InitOptions
Return values
1- EASY-ROB DLL Window initialized
0- Error initializing EASY-ROB DLL Window
static ER_DllExport char* ER_CAPI_SYS_STATUS::inq_config_workdir ( void  )
static

Returns folder string for current working directory.

Return values
folderstring for current working directory
static ER_DllExport int* ER_CAPI_SYS_STATUS::inq_EasyRobDll_Activ ( void  )
static

Obsolete use inq_EasyRobDll_Active()

Return values
0- EASY-ROB Application not available
1- EASY-ROB available
static ER_DllExport int* ER_CAPI_SYS_STATUS::inq_EasyRobDll_Active ( void  )
static

Check if EASY-ROB Application is still active.

Return values
0- EASY-ROB Application not available
1- EASY-ROB available
static ER_DllExport void* ER_CAPI_SYS_STATUS::inq_EasyRobDll_Hwnd ( void  )
static

Get EASY-ROB Handle from CWnd class.

Return values
Handlefrom CWnd class
static ER_DllExport ER_UID ER_CAPI_SYS_STATUS::inq_EasyRobDll_Hwnd_ex ( void  )
static

Get EASY-ROB Handle from HWND, GetSafeHwnd()

Return values
Handlefrom CWnd class
static ER_DllExport int* ER_CAPI_SYS_STATUS::inq_modified_cell ( void  )
static

Flag if cell file is modified.

Return values
0- cell file modified
1- cell file modified
static ER_DllExport int ER_CAPI_SYS_STATUS::set_commandline ( char *  cmdline)
static

Set the command line
The given command will be executed immediatly
See also EASY-ROB-ShortKeys-eng.pdf
Example "-message".

Parameters
[in]cmdline
Return values
0- ER_OK
static ER_DllExport int ER_CAPI_SYS_STATUS::SetWindowPos ( void *  pWndInsertAfter,
int  x,
int  y,
int  cx,
int  cy,
UINT  nFlags 
)
static

Set the position and size of EASY-ROB's OpenGL window.

// Example:
void *pWndInsertAfter;
pWndInsertAfter = NULL;
pWndInsertAfter = (void *)&wndTop; // wndBottom wndTop wndNoTopMost wndTopMost
int x = 10; // left
int y = x; // top
int cx = 800; // width
int cy = (int)(cx*3.0f/4.0f); // height ... ratio 3:4
UINT nFlags = SWP_SHOWWINDOW; // Displays the window
er_sys_status.SetWindowPos(pWndInsertAfter,x,y,cx,cy,nFlags);
...
Parameters
[in]pWndInsertAfter
[in]xposition of the left side of the window
[in]yposition of the top of the window
[in]cxwidth of the window
[in]cyheight of the window
[in]nFlagsspecifies size and position options. For more information, see CWnd::SetWindowPos
Return values
Nonzeroif the function is successful; otherwise, 0
static ER_DllExport int ER_CAPI_SYS_STATUS::ShellExecuteEdit ( char *  fln)
static

Opens the specified file with the assigned editor
See configuration file config.dat.

Parameters
[in]flnfile to open with assigned editor
Return values
0- ER_OK
1- ER_ERROR
static ER_DllExport int ER_CAPI_SYS_STATUS::ShellExecuteOpen ( char *  prg,
char *  parameter = NULL,
int  nShowCmd = SW_SHOWNORMAL 
)
static

Performs an 'open' operation on a specified program file.

Parameters
[in]prgprogram to execute
[in]parameterto be passed to the application
[in]nShowCmda flag that specify how an application is to be displayed
Return values
0- ER_OK
1- ER_ERROR
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadBody ( int  confirm = 1)
static

Unload Body group
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Bodies unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadCell ( int  confirm = 1)
static

Unload current loaded work cell
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Cell unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadMimic ( int  confirm = 1)
static

Unload current robot Mimic file
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Mimic unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadPath ( int  confirm = 1)
static

Unload current Path
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Path unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadPathAll ( int  confirm = 1)
static

Unload all Pathes
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- Cannot unloed all Pathes
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadProgram ( int  confirm = 1)
static

Unload current robot Program
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Program unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadRobot ( int  confirm = 1)
static

Unload current Robot
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Robot unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadTag ( int  confirm = 1)
static

Unload current Tag
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Tag unloaded
static ER_DllExport int ER_CAPI_SYS_STATUS::UnloadTool ( int  confirm = 1)
static

Unload current Tool
If paramter confirm is set to 1, the user will be prompted to confirm this operation.

Parameters
[in]confirm
Return values
0- ER_OK
1- No Tool unloaded

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