MPIMotionPointToPointBehaviorType

Declaration

typedef enum MPIMotionPointToPointBehaviorType {
         MPIMotionPointToPointBehaviorTypeINVALID = -1,
         MPIMotionPointToPointBehaviorTypeSTART_ERROR_IF_MOVING,
         MPIMotionPointToPointBehaviorTypeMODIFY,
         MPIMotionPointToPointBehaviorTypeMODIFY_ERROR_IF_NOT_MOVING,
         MPIMotionPointToPointBehaviorTypeAPPEND_WITHOUT_MOTION_DONE,
         MPIMotionPointToPointBehaviorTypeEND,
         MPIMotionPointToPointBehaviorTypeFIRST = MPIMotionPointToPointBehaviorTypeINVALID + 1
} MPIMotionPointToPointBehaviorType;

Required Header: stdmpi.h

Change History: Added in 04.00.

Description

MPIMotionPointToPointBehaviorType is used to specify the type of modify to perform when calling a point-to-point motion start function with the MPIMotionPointToPointAttrMaskBEHAVIOR attribute. By default, calling a motion start function while not moving will start a new move. Calling it while moving will append a new move and generate a Motion Done event between the moves.

START_ERROR_IF_MOVING	Start a new move. If already moving, generate an error.
MODIFY	Interrupt current move and replace parameters. If not moving, start a new motion.
MODIFY_ERROR_IF_NOT_MOVING	Interrupt current move and replace parameters. If not moving, generate an error.
APPEND_WITHOUT_MOTION_DONE	Start a new move after current move finishes. Do not settle and generate a MOTION_DONE event between the moves. If not moving, MPI returns the message MPIMotionMessageIDLE, but completes the action.