Motor |
Provides access to Scanner handling operations.
Inheritance HierarchyNamespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 2.3.4
SyntaxC#
public class MotorAPI : Spice3API
The MotorAPI type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | AreHomed | Indicates if the requested axes have already been homed. |
| AreMoving | Indicates if the requested axes are currently moving. |
| ClearAlarm(MotorAxes) | Clears the alarm of the given axes. The alarm will be raised again if the alarm condition is still present. |
| ClearAlarm(MotorAxis) | Clears the alarm of the given axis. The alarm will be raised again if the alarm condition is still present. |
| ClearHome(MotorAxes) | Clears the 'homed' state of the given axes. |
| ClearHome(MotorAxis) | Clears the 'homed' state of the given axis. |
| GetConfig | Gets the current configuration from the card. |
| GetVariables | Gets the current motor variables from the card. |
| HasAlarm | Indicates if the requested axis is in an 'Alarm' state. |
| HaveAlarm | Indicates if the requested axes are in an 'Alarm' state. |
| Home | Moves the given axis to its home position. |
| InterruptWaitForHomeDone | Interrupts every current blocking call to WaitForHomeDone(Nullable<MotorAxis>, Nullable<Int32>) |
| InterruptWaitForMoveDone | Interrupts every current blocking call to WaitForMoveDone(Nullable<MotorAxis>, Nullable<Int32>) |
| IsHomed | Indicates if the requested axis has already been homed. |
| IsMoving | Indicates if the requested axis is currently moving. |
| IsWithinSoftLimits | Indicates if the requested axis is within the defined limits. |
| LoadConfig | Loads the current configuration from the card's local storage. |
| LoadVariables | Loads the current motor variables from the card's local storage. |
| MoveAbs(Point2D) | Moves M0 and M1 to the given absolute position. |
| MoveAbs(Point3D) | Moves M0, M1 and M2 to the given absolute position. |
| MoveAbs(Point4D) | Moves M0, M1, M2 and M3 to the given absolute position. |
| MoveAbs(MotorAxis, Double) | Moves the axis to the given absolute position. |
| MoveAtVelocity | Moves the axis at the configured Velocity. |
| MoveRel(Point2D) | Moves M0 and M1 to the given position relative from the current position. |
| MoveRel(Point3D) | Moves M0, M1 and M2 to the given position relative from the current position. |
| MoveRel(Point4D) | Moves M0, M1, M2 and M3 to the given position relative from the current position. |
| MoveRel(MotorAxis, Double) | Moves the axis to the given position relative from the current position. |
| MovingDirection | Indicates if the current moving direction of axis. |
| ReadPosition | Retrieves the current position of the axis from the card. |
| RegisterHomeDoneCallback | Register a callback function that is called when a HomeDone event occurs. |
| RegisterMoveDoneCallback | Register a callback function that is called when an MoveDone event occurs. |
| SetConfig | Sets the current configuration on the card. |
| SetVariables | Sets the current motor variables on the card. |
| Stop(MotorAxes) | Stops the moving axes. |
| Stop(MotorAxis) | Stops the moving axis. |
| StoreConfig | Stores the current configuration in the card's local storage for later (re-)loading. |
| StoreVariables | Stores the current motor variables in the card's local storage for later (re-)loading. |
| UnregisterHomeDoneCallback | Unregister a callback previously registered with RegisterHomeDoneCallback(Action<ClientAPI, Int32>). |
| UnregisterMoveDoneCallback | Unregister a callback previously registered with RegisterMoveDoneCallback(Action<ClientAPI, Int32>). |
| WaitForHomeDone | Waits for asynchronous homing of axis to be done. |
| WaitForMoveDone(MotorAxes, Nullable<Int32>) | Waits for move of axes to be done. |
| WaitForMoveDone(Nullable<MotorAxis>, Nullable<Int32>) | Waits for move of axis to be done. |
See Also