MPIGeometricPathMessage

Definition

typedef enum MPIGeometricPathMessage {
	MPIGeometricPathMessageFIRST = mpiMessageID(MPIModuleIdPATH, 0),

	MPIGeometricPathMessageILLEGAL_DIMENSION,
	MPIGeometricPathMessageILLEGAL_ELEMENT,
	MPIGeometricPathMessageARC_ILLEGAL_DIMENSION,
	MPIGeometricPathMessageILLEGAL_RADIUS,
	MPIGeometricPathMessagePATH_TOO_LONG,
	MPIGeometricPathMessageUNSUPPORTED_TYPE,
	MPIGeometricPathMessageILLEGAL_VELOCITY,
	MPIGeometricPathMessageILLEGAL_ACCELERATION,
	MPIGeometricPathMessageILLEGAL_TIMESLICE,
     MPIGeometricPathMessageILLEGAL_PLAN_TYPE,
    MPIGeometricPathMessageVEL_ACCEL_TOO_LONG,
    MPIGeometricPathMessageZERO_PATH_LENGTH,
    MPIGeometricPathMessageVEL_CORNER_RADIUS,
	MPIGeometricPathMessageILLEGAL_TOLERANCE,
	MPIGeometricPathMessageILLEGAL_SAMPLE_PERIOD,

	MPIGeometricPathMessageEND,
	MPIGeometricPathMessageCOUNT = MPIGeometricPathMessageEND - MPIGeometricPathMessageFIRST
} MPIGeometricPathMessage;

Description

MPIGeometricPathMessage is an enumeration of the Path error messages that can be returned by the MPI library.

MPIGeometricPathMessageILLEGAL_DIMENSION
The path dimensions are not valid. This message code is returned by mpiGeometricPathParamsSet(...) if the path dimension is less than one or greater than or equal to MPIGeometricPathPointDIMENSION_MAX. Also, this message code is returned if specific path element types have dimension restrictions. For example, the ARC type is limited to 2 dimensions and the ARC_END_POINT type is limited to 3 dimensions. To correct this problem, select an appropriate dimension for the path element type.
MPIGeometricPathMessageILLEGAL_ELEMENT
The path element type is not valid. This message code is returned by mpiGeometricPathAppend(...) if the specified path element type is not a member of the MPIGeometricPathElementType enumeration.
MPIGeometricPathMessageARC_ILLEGAL_DIMENSION
The path element arc dimension is not valid. This message code is returned by mpiGeometricPathAppend(...) if the ARC or ARC_CENTER element is not 2 dimensions. To correct this problem, set the path dimension to 2.
MPIGeometricPathMessageILLEGAL_RADIUS
The path element arc radius is not valid. This message code is returned by mpiGeometricPathAppend(...) if the ARC element radius is less than or equal to zero. To correct this problem, set the arc radius to a value greater than zero. This message code is also returned for arcs where the starting and ending radii do not match. See MPIGeometricPathElementAttributes for more information.
MPIGeometricPathMessagePATH_TOO_LONG
The path length is not valid. This message code is returned if the path length is too large to be stored in memory. To reduce the size of the path, increase the timeSlice parameter.
MPIGeometricPathMessageILLEGAL_VELOCITY
The path element velocity is not valid. This message code is returned by mpiGeometricPathAppend(...) or mpiGeometricPathParamsSet(...) if the specified velocity is less than or equal to zero. To correct this problem, set the element velocity to a value greater than zero.
MPIGeometricPathMessageILLEGAL_ACCELERATION
The path element velocity is not valid. This message code is returned by mpiGeometricPathAppend(...) or mpiGeometricPathParamsSet(...) if the specified velocity is less than or equal to zero. To correct this problem, set the element velocity to a value greater than zero.
MPIGeometricPathMessageILLEGAL_TIMESLICE
The path element time slice is not valid. This message code is returned by mpiGeometricPathAppend(...) or mpiGeometricPathParamsSet(...) if the specified time slice is less than or equal to zero. To correct this problem, set the element time slice to a value greater than zero.
MPIGeometricPathMessageILLEGAL_PLAN_TYPE
The path parameter plan is not valid. This message is returned by mpiGeometricPathParamsSet(...) if the parameter is not MPIGeometricPathPlanTypeTRAP or MPIGeometricPathPlanTypeSCURVE.
MPIGeometricPathMessageVEL_ACCEL_TOO_LONG
The path element length is too short or the accelleration time is too long to allow blending. See the Geometric Path Motion topic page for more information.
MPIGeometricPathMessageZERO_PATH_LENGTH
No elements have been added to the path.
MPIGeometricPathMessageVEL_CORNER_RADIUS
The velocity of a PVT move is too high to turn an arc of this radius without exceeding the specified maximum accelleration. Decrease the speed, increase the maximum accelleration, or increase the radius to correct this problem. See the Geometric Path Motion topic page for more information.
MPIGeometricPathMessageILLEGAL_TOLERANCE
The path element radiusTolerance is not valid. This message code is returned by mpiGeometricPathAppend(...) if the specified radiusTolerance is less than or equal to zero. To correct this problem, set the element radiusTolerance to a value greater than zero.
MPIGeometricPathMessageILLEGAL_SAMPLE_PERIOD
The path parameter is not valid. This message is returned by mpiGeometricPathParamsSet(...) if the parameter is not greater than zero.