GmiInterface.h File Reference

#include <gmi/iface/AxesCoord.h>
#include <gmi/iface/GmiTypes.h>
#include <gmi/iface/global.h>
#include <misc/gen/TVector.h>
#include <misc/gen/Value.h>

Include dependency graph for GmiInterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	sf::gmi::ParamState
	Structure to hold a single state. More...
struct	sf::gmi::ParamInfo
	Structure to hold parameter information. More...
struct	sf::gmi::ResultInfo
	Structure to hold parameter information. More...
struct	sf::gmi::BufferInfo
	Structure to hold data update information. More...

Namespaces
namespace	sf
namespace	sf::gmi

Typedefs
typedef void(*	sf::gmi::NotifyProc) (void *data, IdType id)
	Function type for the function type which is called when a parameter changes as a result of changes in the interface itself.
typedef void(*	sf::gmi::ControllerEvent) (Controller *ctrl, EControllerEvent event)
	Handler type for motion event handling.

Enumerations
enum	sf::gmi::EParamFlag {   sf::gmi::pfREADONLY = 1 << 0 , sf::gmi::pfEFFECTPARAM = 1 << 1 , sf::gmi::pfEFFECTRESULT = 1 << 2 , sf::gmi::pfAXIS = 1 << 3 ,   sf::gmi::pfMOVE = 1 << 4 , sf::gmi::pfMOVEPOS = 1 << 5 , sf::gmi::pfMOVEVEL = 1 << 6 , sf::gmi::pfEXPORT = 1 << 7 ,   sf::gmi::pfSYSTEM = 1 << 8 , sf::gmi::pfWRITEABLE = 1 << 9 , sf::gmi::pfALIAS = 1 << 10 , sf::gmi::pfARCHIVE = 1 << 11 ,   sf::gmi::pfMOVECON = 1 << 12 }
	Parameter flags for defining parameter behaviour. More...
enum	sf::gmi::EResultFlag { sf::gmi::rfINDEX = 1 << 0 , sf::gmi::rfASYNC = 1 << 1 , sf::gmi::rfASYNCINDEX = 1 << 2 , sf::gmi::rfHUGE = 1 << 3 }
	Result flags for defining result behaviour. More...
enum	sf::gmi::EParam {   sf::gmi::mpNONE = 0x0000 , sf::gmi::mpVERSION = 0x0001 , sf::gmi::mpAXISCOUNT = 0x0002 , sf::gmi::mpMOVEPOS = 0x0003 ,   sf::gmi::mpMOVEVEL = 0x0004 , sf::gmi::mpJOYSTICK = 0x0005 , sf::gmi::mpTRIGGER_AXIS = 0x0006 , sf::gmi::mpTRIGGER_DENSITY = 0x0007 ,   sf::gmi::mpTRIGGER_MODE = 0x0008 , sf::gmi::mpJOYSTICK_AXIS = 0x0009 , sf::gmi::mpPOP_AXIS = 0x000A , sf::gmi::mpTRIGGER_ENABLE = 0x000B ,   sf::gmi::mpMOVECON = 0x000C , sf::gmi::mpCHUCKJAW = 0x000D , sf::gmi::mpERROR = 0x000E , sf::gmi::mpERROR_MESSAGE = 0x000F ,   sf::gmi::mpTRIGGER_FREQ = 0x0010 , sf::gmi::mpTIMEUNIT = 0x0011 , sf::gmi::mpLAST = 0x0200 , sf::gmi::mpAXIS_MASK = 0x8000 ,   sf::gmi::mpAXIS_NAME = 0x8001 , sf::gmi::mpAXIS_IDX_POS = 0x8002 , sf::gmi::mpAXIS_MODE = 0x8003 , sf::gmi::mpAXIS_ACCURACY = 0x8004 ,   sf::gmi::mpAXIS_RESOLUTION = 0x8005 , sf::gmi::mpAXIS_MIN_POS = 0x8010 , sf::gmi::mpAXIS_MAX_POS = 0x8011 , sf::gmi::mpAXIS_MAX_VEL = 0x8012 ,   sf::gmi::mpAXIS_MAX_ACC = 0x8013 , sf::gmi::mpAXIS_OFS_POS = 0x8014 , sf::gmi::mpAXIS_CUR_POS = 0x8020 , sf::gmi::mpAXIS_CUR_VEL = 0x8021 ,   sf::gmi::mpAXIS_TRG_POS = 0x8030 , sf::gmi::mpAXIS_TRG_VEL = 0x8031 , sf::gmi::mpAXIS_TRG_ACC = 0x8032 , sf::gmi::mpAXIS_HOME_OFS = 0x8033 ,   sf::gmi::mpAXIS_MOVEMENT = 0x8034 , sf::gmi::mpAXIS_LAST = 0x8200 }
	Motion default parameters. List of ids which must always be implemented for each motion implementation. More...
enum	sf::gmi::EResult { sf::gmi::mrLAST = 0x0200 , sf::gmi::mrAXIS_INDEX_POS = 0x8000 , sf::gmi::mrAXIS_LAST = 0x8200 }
	Motion default results. More...
enum	sf::gmi::EMovePosCmd {   sf::gmi::mpcCOMPLETE = 0 , sf::gmi::mpcABORT = 1 , sf::gmi::mpcSTOP = 2 , sf::gmi::mpcPOSITION = 3 ,   sf::gmi::mpcCURVE = 4 }
	Enumerate for controller position movement command. More...
enum	sf::gmi::EMoveVelCmd { sf::gmi::mvcCOMPLETE = 0 , sf::gmi::mvcABORT = 1 , sf::gmi::mvcSTOP = 2 , sf::gmi::mvcON = 3 }
	Enumerate for controller velocity movement command. More...
enum	sf::gmi::EMoveConCmd { sf::gmi::mccCOMPLETE = 0 , sf::gmi::mccABORT = 1 , sf::gmi::mccSTOP = 2 , sf::gmi::mccON = 3 }
	Enumerate for controller continuous movement command. More...
enum	sf::gmi::EJoystickCmd { sf::gmi::jscINHIBIT = -1 , sf::gmi::jscOFF = 0 , sf::gmi::jscSTOP = 1 , sf::gmi::jscON = 2 }
	Enumerate for controller Joy movement command. More...
enum	sf::gmi::EAxisMode {   sf::gmi::amDISABLED = 0 , sf::gmi::amPOSITION = 1 , sf::gmi::amVELOCITY = 2 , sf::gmi::amHOME = 3 ,   sf::gmi::amCONTINUE = 4 }
	Enumerate for controller mode of operation. More...
enum	sf::gmi::EAxisMinMax : unsigned int { sf::gmi::ammMIN_POS = 0 , sf::gmi::ammMAX_POS = 1 , sf::gmi::ammMAX_VEL = 2 , sf::gmi::ammMAX_ACC = 3 }
	Enumerate for retrieving axis extremes. More...
enum	sf::gmi::EChuckJaw { sf::gmi::cjOFF = 0 , sf::gmi::cjOPEN = 1 , sf::gmi::cjCLOSE = 2 }
enum	sf::gmi::EControllerEvent {   sf::gmi::ceSTATUS = 0x0000 , sf::gmi::ceHOOKED = 0x1001 , sf::gmi::ceUNHOOKED = 0x1002 , sf::gmi::ceCOMPLETE = 0x2001 ,   sf::gmi::cePOPEVENT = 0x3001 }
	Enumerate for controller events. More...

Variables
class _GMI_CLASS	sf::gmi::Controller
	Forward declarations of Controller.