MPIPathMessage

Definition

typedef enum {
   MPIPathMessagePATH_INVALID,
   MPIPathMessageILLEGAL_DIMENSION,
   MPIPathMessageILLEGAL_ELEMENT,
   MPIPathMessageARC_ILLEGAL_DIMENSION,
   MPIPathMessageHELIX_ILLEGAL_DIMENSION,
   MPIPathMessageILLEGAL_RADIUS,
   MPIPathMessagePATH_TOO_LONG,
   MPIPathMessageILLEGAL_VELOCITY,
   MPIPathMessageILLEGAL_ACCELERATION,
   MPIPathMessageILLEGAL_TIMESLICE,
   MPIPathMessageINVALID_BLENDING,
} MPIPathMessage;

Description

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

MPIPathMessagePATH_INVALID
	The path object is not valid. This message code is returned by a path method if the path object handle is not valid. This problem can be caused by a failed mpiPathCreate(...). To prevent this problem, check your path objects after creation by using mpiPathValidate(...).
MPIPathMessageILLEGAL_DIMENSION
	The path dimensions are not valid. This message code is returned by mpiPathParamsSet(...) or mpiPathMotionParamsGenerate(...) if the path dimension is less than one or greater than or equal to MPIPathPointDIMENSION_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.
MPIPathMessageILLEGAL_ELEMENT
	The path element type is not valid. This message code is returned by mpiPathAppend(...) if the specified path element type is not a member of the MPIPathElementType enumeration.
MPIPathMessageARC_ILLEGAL_DIMENSION
	The path element arc dimension is not valid. This message code is returned by mpiPathAppend(...) if the ARC or ARC_CENTER element is not 2 dimensions. To correct this problem, set the path dimension to 2.
MPIPathMessageHELIX_ILLEGAL_DIMENSION
	Not supported.
MPIPathMessageILLEGAL_RADIUS
	The path element arc radius is not valid. This message code is returned by mpiPathAppend(...) 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.
MPIPathMessagePATH_TOO_LONG
	The path length is not valid. This message code is returned by mpiPathMotionParamsGenerate(...) if the path length is greater than MAX_PATH_POINTS. To correct the problem, specify a path with fewer points than MAX_PATH_POINTS.
MPIPathMessageILLEGAL_VELOCITY
	The path element velocity is not valid. This message code is returned by mpiPathAppend(...) 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.
MPIPathMessageILLEGAL_ACCELERATION
	The path element velocity is not valid. This message code is returned by mpiPathAppend(...) 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.
MPIPathMessageILLEGAL_TIMESLICE
	The path element time slice is not valid. This message code is returned by mpiPathAppend(...) 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.
MPIPathMessageINVALID_BLENDING
	The path element blending is not valid. This message code is returned by mpiPathMotionParamsGenerate(...) if the element blending is set to TRUE and the motion type does not support blending. To correct this problem, either set the element blending to FALSE or select a different motion type.