MPIControlGateState

Definition

typedef enum MPIControlGateState {
	MPIControlGateStateINVALID = -1,

	MPIControlGateStateCLOSED,
	MPIControlGateStateOPEN,

	MPIControlGateStateEND,
	MPIControlGateStateFIRST = MPIControlFileTypeINVALID + 1
} MPIControlGateState;

 

Required Header: stdmpi.h
Change History: Added in 04.00.

Description

MPIControlGateState is an enumeration of possible states for control gates. This enumeration is used to specify what state a gate is in by mpiControlGateStateGet() and what state to set it to by mpiControlGateStateSet(). These states are used by MPIMotionHoldGate and MPIUserLimitConditionGate to control their behavior.

MPIControlGateStateCLOSED Closed state.
MPIControlGateStateOPEN Open state.

Sample Code

returnValue = mpiControlGateStateSet(control, 0, MPIControlGateStateOPEN);

See Also

mpiControlGateStateGet | mpiControlGateStateSet | MPIMotionHoldGate | MPIUserLimitConditionGate