Inherits IDispatch.
Public Member Functions | |
HRESULT | Home (void) |
HRESULT | SetAbsoluteMeasurement (void) |
HRESULT | Power (VARIANT_BOOL value) |
HRESULT | MoveVelocity ([in] DOUBLE velocity, [in] DOUBLE acceleration, [in] DOUBLE deceleration, [in] DOUBLE jerk) |
HRESULT | MoveAbsolute ([in] DOUBLE position, [in] DOUBLE velocity, [in] DOUBLE acceleration, [in] DOUBLE deceleration, [in] DOUBLE jerk) |
HRESULT | MoveRelative ([in] DOUBLE distance, [in] DOUBLE velocity, [in] DOUBLE acceleration, [in] DOUBLE deceleration, [in] DOUBLE jerk) |
HRESULT | MoveAdditive ([in] DOUBLE distance, [in] DOUBLE velocity, [in] DOUBLE acceleration, [in] DOUBLE deceleration, [in] DOUBLE jerk) |
HRESULT | Stop ([in] VARIANT_BOOL stop, [in] DOUBLE deceleration, [in] DOUBLE jerk) |
HRESULT | GearIn ([in] AxisRef *masterAxis, [in] LONG numerator, [in] LONG denominator, [in] DOUBLE fineadjust) |
HRESULT | GearInPos ([in] AxisRef *masterAxis, [in] LONG numerator, [in] LONG denominator, [in] DOUBLE fineadjust, [in] StartMode startMode, [in] SyncDirection syncMode) |
HRESULT | FlexProfile ([in] AxisRef *masterAxis, [in] LONG numerator, [in] LONG denominator, [in] DOUBLE fineadjust, [in] LONG setSelection, [in] VARIANT_BOOL useSwitchingPos, [in] DOUBLE switchingPosition, [in] ProfileStartPoint profileEntry, [in] DOUBLE masterOffset, [in] DOUBLE slaveOffset, [in] SyncType syncMode, [in] DOUBLE syncVelocity, [in] DOUBLE syncAcceleration, [in] ProfileExecutionMode executionMode) |
HRESULT | Status ([out, retval] struct MotionStatus *motionStatus) |
HRESULT | Wait (VARIANT timeoutValue) |
HRESULT | PhasingSlave ([in] DOUBLE phaseShift, [in] DOUBLE velocity, [in] DOUBLE acceleration, [in] DOUBLE deceleration) |
HRESULT | Phasing ([in] DOUBLE phaseShift, [in] DOUBLE velocity, [in] DOUBLE acceleration, [in] DOUBLE deceleration) |
HRESULT | TorqueControl ([in] DOUBLE torque, [in] DOUBLE torqueRamp) |
HRESULT | CamIn ([in] AxisRef *masterAxis, [in] LONG numerator, [in] LONG denominator, [in] DOUBLE fineadjust, [in] DOUBLE camShaftDistance, [in] SyncDirection syncMode, [in] StartMode startMode, [in] CamTableId camId) |
HRESULT | SynchronOut () |
HRESULT | OpenCyclicPositionChannel () |
HRESULT | OpenCyclicVelocityChannel () |
HRESULT | OpenCyclicAnalogChannel () |
HRESULT | OpenCyclicTorqueChannel () |
HRESULT | WriteCyclicPosition ([in] DOUBLE cyclicValue) |
HRESULT | WriteCyclicVelocity ([in] DOUBLE cyclicValue) |
HRESULT | WriteCyclicAnalog ([in] DOUBLE cyclicValue) |
HRESULT | WriteCyclicTorque ([in] DOUBLE cyclicValue) |
Definition of the IMovement interface used to access motion commands to move an axis or drive.
Use the IMovement interface to physically move or control an axis by using various motion commands.
Definition at line 71 of file IMovement.idl.
HRESULT IMovement::Home | ( | void | ) |
This function serves to home an axis. Only an axis with incremental encoders can be homed. If the axis has an absolute encoder, the command "set absolute measurement" must be used.
mlpiMotionHome
, where you can find further documentation. HRESULT IMovement::SetAbsoluteMeasurement | ( | void | ) |
This function serves to "set absolute measurement" of an axis. Only axes with absolute encoders can be used with this function.
mlpiMotionSetAbsoluteMeasurement
, where you can find further documentation. HRESULT IMovement::Power | ( | VARIANT_BOOL | value | ) |
This function commands power to the drive.
[in] | value | Boolean value whether to activate or to deactivate power. |
mlpiMotionPower
, where you can find further documentation. HRESULT IMovement::MoveVelocity | ( | [in] DOUBLE | velocity, |
[in] DOUBLE | acceleration, | ||
[in] DOUBLE | deceleration, | ||
[in] DOUBLE | jerk | ||
) |
This function commands a single axis movement of a single axis.
[in] | velocity | Velocity in drives unit. |
[in] | acceleration | Acceleration in drives unit. |
[in] | deceleration | Deceleration in drives unit. |
[in] | jerk | Jerk in drives unit. |
mlpiMotionMoveVeloctiy
, where you can find further documentation. HRESULT IMovement::MoveAbsolute | ( | [in] DOUBLE | position, |
[in] DOUBLE | velocity, | ||
[in] DOUBLE | acceleration, | ||
[in] DOUBLE | deceleration, | ||
[in] DOUBLE | jerk | ||
) |
This function defines an absolute position movement of a single axis.
[in] | position | Position in drives unit. |
[in] | velocity | Velocity in drives unit. |
[in] | acceleration | Acceleration in drives unit. |
[in] | deceleration | Deceleration in drives unit. |
[in] | jerk | Jerk in drives unit. |
mlpiMotionMoveAbsolute
, where you can find further documentation. HRESULT IMovement::MoveRelative | ( | [in] DOUBLE | distance, |
[in] DOUBLE | velocity, | ||
[in] DOUBLE | acceleration, | ||
[in] DOUBLE | deceleration, | ||
[in] DOUBLE | jerk | ||
) |
This function commands a relative movement. The relative position is added to the current position and is used as new target. The difference to an additive movement is that the offset position is added to the current position, not the target position. So a currently running movement command is interrupted and only the offset position is added to the current position.
[in] | distance | Distance in drives unit. |
[in] | velocity | Velocity in drives unit. |
[in] | acceleration | Acceleration in drives unit. |
[in] | deceleration | Deceleration in drives unit. |
[in] | jerk | Jerk in drives unit. |
mlpiMotionMoveRelative
, where you can find further documentation. HRESULT IMovement::MoveAdditive | ( | [in] DOUBLE | distance, |
[in] DOUBLE | velocity, | ||
[in] DOUBLE | acceleration, | ||
[in] DOUBLE | deceleration, | ||
[in] DOUBLE | jerk | ||
) |
This function commands an additive movement. The additive position is added to the target position and is used as new target. It can be used to add a relative position to the already commanded movement.
[in] | distance | Distance in drives unit. |
[in] | velocity | Velocity in drives unit. |
[in] | acceleration | Acceleration in drives unit. |
[in] | deceleration | Deceleration in drives unit. |
[in] | jerk | Jerk in drives unit. |
mlpiMotionMoveAdditive
, where you can find further documentation. HRESULT IMovement::Stop | ( | [in] VARIANT_BOOL | stop, |
[in] DOUBLE | deceleration, | ||
[in] DOUBLE | jerk | ||
) |
This function stops the axis. The target position is set and the axis will perform a trapezoidal velocity move.
[in] | stop | TRUE: stopping, FALSE: exit Stopping mode. |
[in] | deceleration | Deceleration in drives unit. |
[in] | jerk | Jerk in drives unit. |
mlpiMotionStop
, where you can find further documentation. HRESULT IMovement::GearIn | ( | [in] AxisRef * | masterAxis, |
[in] LONG | numerator, | ||
[in] LONG | denominator, | ||
[in] DOUBLE | fineadjust | ||
) |
This function commands a velocity synchronization to the master.
[in] | masterAxis | Reference to the master axis. |
[in] | numerator | Gear ratio numerator. |
[in] | denominator | Gear ratio denominator. |
[in] | fineadjust | Fine adjust for gear in %. |
mlpiMotionGearIn
, where you can find further documentation. HRESULT IMovement::GearInPos | ( | [in] AxisRef * | masterAxis, |
[in] LONG | numerator, | ||
[in] LONG | denominator, | ||
[in] DOUBLE | fineadjust, | ||
[in] StartMode | startMode, | ||
[in] SyncDirection | syncMode | ||
) |
This function commands a position synchronization to the master.
[in] | masterAxis | Reference to the master axis. |
[in] | numerator | Gear ratio numerator. |
[in] | denominator | Gear ratio denominator. |
[in] | fineadjust | Fine adjust for gear in %. |
[in] | startMode | Start mode. |
[in] | syncMode | Synchronization type. |
mlpiMotionGearInPos
, where you can find further documentation. HRESULT IMovement::FlexProfile | ( | [in] AxisRef * | masterAxis, |
[in] LONG | numerator, | ||
[in] LONG | denominator, | ||
[in] DOUBLE | fineadjust, | ||
[in] LONG | setSelection, | ||
[in] VARIANT_BOOL | useSwitchingPos, | ||
[in] DOUBLE | switchingPosition, | ||
[in] ProfileStartPoint | profileEntry, | ||
[in] DOUBLE | masterOffset, | ||
[in] DOUBLE | slaveOffset, | ||
[in] SyncType | syncMode, | ||
[in] DOUBLE | syncVelocity, | ||
[in] DOUBLE | syncAcceleration, | ||
[in] ProfileExecutionMode | executionMode | ||
) |
This function commands a synchronization movement to an axis.
[in] | masterAxis | Reference to the master axis |
[in] | numerator | Gear ratio numerator. |
[in] | denominator | Gear ratio denominator. |
[in] | fineadjust | Fine adjust for gear in %. |
[in] | setSelection | Selects the active set |
[in] | useSwitchingPos | Determines if switching position will be used. |
[in] | switchingPosition | Switching position. |
[in] | profileEntry | Switching conditions. |
[in] | masterOffset | Master offset. |
[in] | slaveOffset | Slave offset. |
[in] | syncMode | Synchronization type |
[in] | syncVelocity | Synchronization velocity. |
[in] | syncAcceleration | Synchronization acceleration. |
[in] | executionMode | Execution mode. |
mlpiMotionFlexProfile
, where you can find further documentation. HRESULT IMovement::Status | ( | [out, retval] struct MotionStatus * | motionStatus | ) |
This function reads the movement status. It returns information about the last started motion command.
[out] | motionStatus | Returns a struct with information about the last commanded movement. |
mlpiMotionGetStatus
, where you can find further documentation. HRESULT IMovement::Wait | ( | VARIANT | timeoutValue | ) |
This function waits for completion (state DONE or ERROR) of the latest motion command.
[in] | timeoutValue | Timeout in milliseconds. If DONE or ERROR has not been reached within this time, then an exception will be thrown. |
utilMotionWait
, where you can find further documentation. HRESULT IMovement::PhasingSlave | ( | [in] DOUBLE | phaseShift, |
[in] DOUBLE | velocity, | ||
[in] DOUBLE | acceleration, | ||
[in] DOUBLE | deceleration | ||
) |
The function adjusts the slave axis with the specified velocity and acceleration.
[in] | phaseShift | Master axis position additive |
[in] | velocity | Value of the maximum velocity (always positive) (not necessarily reached) [u/s]. |
[in] | acceleration | Value of the acceleration (always positive) (increasing energy of the motor) [u/s2] |
[in] | deceleration | Value of the deceleration (always positive) (decreasing energy of the motor) [u/s2] |
mlpiMotionPhasingSlave
, where you can find further documentation. HRESULT IMovement::Phasing | ( | [in] DOUBLE | phaseShift, |
[in] DOUBLE | velocity, | ||
[in] DOUBLE | acceleration, | ||
[in] DOUBLE | deceleration | ||
) |
The function adjusts the master axis with the specified velocity and acceleration.
[in] | phaseShift | Master axis additive position |
[in] | velocity | Value of the maximum velocity (always positive) (not necessarily reached) [u/s]. |
[in] | acceleration | Value of the acceleration (always positive) (increasing energy of the motor) [u/s2] |
[in] | deceleration | Value of the deceleration (always positive) (decreasing energy of the motor) [u/s2] |
mlpiMotionPhasing
, where you can find further documentation. HRESULT IMovement::TorqueControl | ( | [in] DOUBLE | torque, |
[in] DOUBLE | torqueRamp | ||
) |
The function carries out a specific torque on a axis.
[in] | torque | Value of target torque |
[in] | torqueRamp | Value of torque difference within ramp time |
mlpiMotionTorqueControl
, where you can find further documentation. HRESULT IMovement::CamIn | ( | [in] AxisRef * | masterAxis, |
[in] LONG | numerator, | ||
[in] LONG | denominator, | ||
[in] DOUBLE | fineadjust, | ||
[in] DOUBLE | camShaftDistance, | ||
[in] SyncDirection | syncMode, | ||
[in] StartMode | startMode, | ||
[in] CamTableId | camId | ||
) |
This function commands a synchronization movement to an axis.
[in] | masterAxis | Reference to the master axis |
[in] | numerator | Gear ratio numerator. |
[in] | denominator | Gear ratio denominator. |
[in] | fineadjust | Fine adjust for gear in %. |
[in] | camShaftDistance | Cam shaft distance |
[in] | syncMode | Synchronization type |
[in] | startMode | Synchronization start mode |
[in] | camId | used cam table |
mlpiMotionCamIn
, where you can find further documentation. HRESULT IMovement::SynchronOut | ( | ) |
This function commands a synchronization out to an axis.
mlpiMotionSynchronOut
, where you can find further documentation. HRESULT IMovement::OpenCyclicPositionChannel | ( | ) |
This function opens a cyclic channel to an axis. As soon as the channel is open, you can write cyclic positions by using WriteCyclicPosition.
mlpiMotionOpenCyclicPositionChannel
, where you can find further documentation. HRESULT IMovement::OpenCyclicVelocityChannel | ( | ) |
This function opens a cyclic channel to an axis. As soon as the channel is open, you can write cyclic positions by using WriteCyclicVelocity.
mlpiMotionOpenCyclicVeloctiyChannel
, where you can find further documentation. HRESULT IMovement::OpenCyclicAnalogChannel | ( | ) |
This function opens a cyclic channel to an axis. As soon as the channel is open, you can write cyclic positions by using WriteCyclicAnalog.
mlpiMotionOpenCyclicAnalogChannel
, where you can find further documentation. HRESULT IMovement::OpenCyclicTorqueChannel | ( | ) |
This function opens a cyclic channel to an axis. As soon as the channel is open, you can write cyclic positions by using WriteCyclicTorque.
mlpiMotionOpenCyclicTorqueChannel
, where you can find further documentation. HRESULT IMovement::WriteCyclicPosition | ( | [in] DOUBLE | cyclicValue | ) |
This function commands a cyclic value to an axis.
[in] | cyclicValue | Cyclic value to be written to the channel. |
mlpiMotionWriteCyclicPosition
, where you can find further documentation. HRESULT IMovement::WriteCyclicVelocity | ( | [in] DOUBLE | cyclicValue | ) |
This function commands a cyclic value to an axis.
[in] | cyclicValue | Cyclic value to be written to the channel. |
mlpiMotionWriteCyclicVelocity
, where you can find further documentation. HRESULT IMovement::WriteCyclicAnalog | ( | [in] DOUBLE | cyclicValue | ) |
This function commands a cyclic value to an axis.
[in] | cyclicValue | Cyclic value to be written to the channel. |
mlpiMotionWriteCyclicAnalog
, where you can find further documentation. HRESULT IMovement::WriteCyclicTorque | ( | [in] DOUBLE | cyclicValue | ) |
This function commands a cyclic value to an axis.
[in] | cyclicValue | Cyclic value to be written to the channel. |
mlpiMotionWriteCyclicTorque
, where you can find further documentation.