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,

	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.
MPIGeometricPathMessagePATH_TOO_LONG
The path length is not valid. This message code is returned if the path length is greater than MAX_PATH_POINTS. To correct the problem, specify a path with fewer points than MAX_PATH_POINTS.
MPIGeometricPathMessageILLEGAL_VELOCITY
The path element velocity is not valid. This message code is returned by mpiGeometricPathAppend(...) 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(...) 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(...) 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.