Click or drag to resize

KM_Axis Methods

The KM_Axis type exposes the following members.

Methods
 NameDescription
Public methodCheckEnabled Check if the axis is enabled
Public methodDisable Disable the axis
Public methodDoHome Executes a homing sequence based on the settings within the HomingParams variable and waits until the execution is complete
Public methodEnable Bring an axis to an enabled state
Public methodEnableDest Bring an axis to an enabled state and specify the commanded destination for the axis dest is multiplied by CPU and sent to KFLOP
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEStop Stop the current motion and disable the axis
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetActualPosition Querys the axis channel for the actual position in user units
Public methodGetActualPositionCounts Querys the axis channel for the actual position in counts
Public methodGetCommandedPosition Querys the axis channel for the commanded position in user units
Public methodGetCommandedPositionCounts Querys the axis channel for the commanded position in counts
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetHomeFileSource Creates the source code for the .c file with an empty main() method
Public methodGetHomeSequence Creates the lines of code to place in the main() method
Public methodGetMoveToStateAtVel Auto Generates KFLOP C Code to move until an input bit changes
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodJog Jog axis at the commanded preset jogvelocity * jogpercentage
Public methodJog(Double) Jog axis at a given velocity
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodMotionComplete Checks if the commanded axis motion is completed
Public methodMoveTo Calls a move to a given absolute position and blocks the calling thread until the position has been acheived
Public methodRelativeMoveTo Calls a move to a given relative position and blocks the calling thread until the position has been acheived
Public methodSetCommandedDest Sets the axis node's commanded Destination Caution: changing this may result in a sudden jump in the axis position
Public methodSetCurrentPosition Sets the axis node's current position Can be used to "zero" the axis
Public methodStartDoHome Executes a homing sequence based on the settings within the HomingParams variable
Public methodStartMoveTo Calls a non-blocking move to a given absolute position
Public methodStartRelativeMoveTo Calls a non-blocking move to a given relative position
Public methodStop Stop the current motion
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodWaitforMotionComplete Blocks the calling thread until the axis is in position within a specified time limit
Public methodZeroAxis Sets the Axis' current 0.0 point
Top
See Also