Go to the source code of this file.
Classes | |
| class | YMultiAxisController |
Macros | |
| #define | _Y_GLOBALSTATE_ENUM |
| #define | Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
| #define | Y_NAXIS_INVALID (YAPI_INVALID_UINT) |
Typedefs | |
| typedef void(* | YMultiAxisControllerValueCallback) (YMultiAxisController *func, const string &functionValue) |
Enumerations | |
| enum | Y_GLOBALSTATE_enum { Y_GLOBALSTATE_ABSENT = 0, Y_GLOBALSTATE_ALERT = 1, Y_GLOBALSTATE_HI_Z = 2, Y_GLOBALSTATE_STOP = 3, Y_GLOBALSTATE_RUN = 4, Y_GLOBALSTATE_BATCH = 5, Y_GLOBALSTATE_INVALID = -1 } |
Functions | |
| YMultiAxisController * | yFindMultiAxisController (const string &func) |
| YMultiAxisController * | yFirstMultiAxisController (void) |
Macro Definition Documentation
| #define _Y_GLOBALSTATE_ENUM |
Definition at line 56 of file yocto_multiaxiscontroller.h.
| #define Y_COMMAND_INVALID (YAPI_INVALID_STRING) |
Definition at line 68 of file yocto_multiaxiscontroller.h.
| #define Y_NAXIS_INVALID (YAPI_INVALID_UINT) |
Definition at line 67 of file yocto_multiaxiscontroller.h.
Typedef Documentation
| typedef void(* YMultiAxisControllerValueCallback) (YMultiAxisController *func, const string &functionValue) |
Definition at line 54 of file yocto_multiaxiscontroller.h.
Enumeration Type Documentation
| enum Y_GLOBALSTATE_enum |
| Enumerator | |
|---|---|
| Y_GLOBALSTATE_ABSENT | |
| Y_GLOBALSTATE_ALERT | |
| Y_GLOBALSTATE_HI_Z | |
| Y_GLOBALSTATE_STOP | |
| Y_GLOBALSTATE_RUN | |
| Y_GLOBALSTATE_BATCH | |
| Y_GLOBALSTATE_INVALID | |
Definition at line 57 of file yocto_multiaxiscontroller.h.
Function Documentation
|
inline |
Retrieves a multi-axis controller for a given identifier. The identifier can be specified using several formats:
- FunctionLogicalName
- ModuleSerialNumber.FunctionIdentifier
- ModuleSerialNumber.FunctionLogicalName
- ModuleLogicalName.FunctionIdentifier
- ModuleLogicalName.FunctionLogicalName
This function does not require that the multi-axis controller is online at the time it is invoked. The returned object is nevertheless valid. Use the method YMultiAxisController.isOnline() to test if the multi-axis controller is indeed online at a given time. In case of ambiguity when looking for a multi-axis controller by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
- Parameters
-
func : a string that uniquely characterizes the multi-axis controller
- Returns
- a YMultiAxisController object allowing you to drive the multi-axis controller.
Definition at line 349 of file yocto_multiaxiscontroller.h.
|
inline |
Starts the enumeration of multi-axis controllers currently accessible. Use the method YMultiAxisController.nextMultiAxisController() to iterate on next multi-axis controllers.
- Returns
- a pointer to a YMultiAxisController object, corresponding to the first multi-axis controller currently online, or a NULL pointer if there are none.
Definition at line 360 of file yocto_multiaxiscontroller.h.