Class ErrorCode

Inheritance Relationships

Derived Types

Class Documentation

class ErrorCode

This enumerator class enumerates the WMX3 error codes.

Subclassed by ApiBufferErrorCode, CompensationErrorCode, CoreMotionErrorCode, CyclicBufferErrorCode, EcErrorCode, EventErrorCode, IOErrorCode, LogErrorCode, PMMotionErrorCode, SimuErrorCode, UserMemoryErrorCode

Public Types

enum [anonymous]

Values:

enumerator None

No error.

enumerator StartProcessFailed

Failed to start process.

enumerator StartProcessNull

Null pointer encountered while starting process.

enumerator StartProcessMaxInstance

Maximum number of processes started.

enumerator StartProcessLockError

Failed to obtain lock for starting process.

enumerator StartProcessWaitEventFailed

Failed to create start process wait event.

enumerator StartProcessWaitTimeout

Start process timed out.

enumerator MemoryAllocFailed

Memory allocation failed.

enumerator IMLibIsNotRunning

IM library resources are not operating.

enumerator ControlChannelLockFailed

Failed to acquire lock on control channel.

enumerator ControlChannelEventFailed

Failed to operate event on control channel.

enumerator ControlChannelWaitEventFailed

Failed to register wait event on control channel.

enumerator ControlChannelSharedMemoryFailed

Failed to operate shared memory on control channel.

enumerator ControlChannelLockWaitTimeOut

Failed to register wait lock on control channel.

enumerator APIChannelError

API execution channel error.

enumerator APIChannelTimeOut

API execution channel timed out.

enumerator StatusChannelError

Status memory channel error.

enumerator RtssFileNotFoundError

RTSS file not found.

enumerator RtssStartError

Failed to start RTSS.

enumerator RequestChannelTimeOut

New channel request timed out.

enumerator FreeChannelTimeOut

Free channel request timed out.

enumerator CloseDeviceTimeOut

Close device timed out.

enumerator RequestChannelFailed

New channel request failed.

enumerator ReachMaxChannelNumber

Maximum number of channels reached.

enumerator FreeChannelFailed

Free channel request failed.

enumerator InvalidChannelId

Channel ID is invalid.

enumerator CloseDeviceFailed

Close device failed.

enumerator StatusChannelNull

Status channel is null.

enumerator StatusChannelIdError

Status channel ID is invalid.

enumerator StatusSharedMemoryChannelIndexError

Status channel index is invalid.

enumerator StatusChannelGettingInitialData

Status channel is still reading initial data. Wait a few milliseconds.

enumerator RequestQueueFailed

New queue request failed.

enumerator InvalidQueueId

Queue ID is invalid.

enumerator InvalidQueueSize

Queue size is invalid.

enumerator RequestQueueTimeout

New queue request timed out.

enumerator InvalidQueue

Queue is invalid.

enumerator FreeQueueTimeout

Free queue timed out.

enumerator InvalidQueueControlCommand

Invalid queue control command.

enumerator ControlQueueTimeout

Control queue timed out.

enumerator SetQueueOptionsTimeout

Set queue options timed out.

enumerator FreeQueueFailed

Failed to free queue.

enumerator RequestQueueIDAlreadyUsed

Queue ID is already used.

enumerator CreateDeviceLockError

Failed to obtain lock for creating device.

enumerator CloseDeviceLockError

Failed to obtain lock for closing device.

enumerator SetDeviceNameTimeout

Set device name operation timed out.

enumerator GetActiveDeviceTimeout

Get active device operation timed out.

enumerator DeviceIsNull

Device is null (device must be created).

enumerator InvalidModuleId

Module id is invalid.

enumerator InvalidDeterMode

Device deter mode is invalid.

enumerator NoSupportedFunction

Function is not supported (function is not found).

enumerator CommandInvalidQueueId

Invalid queue ID for command.

enumerator CommandQueueAddFailed

Failed to add command to queue.

enumerator CommandQueueIsFull

Queue is full; command could not be added.

enumerator CommandQueueAddTimeOut

Add command to queue timed out.

enumerator IMVersionMismatch

IM Library version does not match.

enumerator ModuleVersionMismatch

API Library version does not match rtdll version.

enumerator CommandIdLockError

Failed to acquire lock for command ID generation.

enumerator CommandIdGetError

Failed to generate command ID.

enumerator CallbackMallocFailed

Callback function malloc failed.

enumerator CallbackThreadNull

Callback function thread is null.

enumerator CallbackThreadError

Callback function thread error.

enumerator CallbackThreadTimeOut

Callback function thread timed out.

enumerator IMLibNullParam

Null parameter encountered during IM library operation.

enumerator IMLibInvalidParam

Invalid parameter encountered during IM library operation.

enumerator ConflictingErrorCode

Error code that conflicts with another error code was returned.

enumerator UtilDataChnlSizeTooSmall

Data channel size is too small.

enumerator UtilBuffAndDataSizeDiff

Buffer size is different from data size.

enumerator UtilNoEnoughDataChnlSize

Not enough data channel size.

enumerator UtilReachMaxDataChnlSize

Maximum data channel size reached.

enumerator UtilIndexOutOfRange

Index is out of range.

enumerator UtilInitFailed

Function initialization failed.

enumerator UtilLockFailed

Failed to get lock.

enumerator UtilQueueFull

Queue is full.

enumerator UtilQueueEmpty

Queue is empty.

enumerator UtilBufferSizeNotEnough

Buffer size is not enough.

enumerator WaitForDeviceEventTimeout

Wait for device event timeout.

enumerator DeviceEventProcessFailed

Process device wait event failed.

enumerator ImCommandNotMatched

IM commands and response are not matched.

enumerator ApiLogCreateQueueFailed

Failed to create queue for API Log.

enumerator ApiLogIsNotSet

API Log is not set yet.

enumerator ApiLogIsRunning

API Log is still running.

enumerator ApiLogIsNotRunning

API Log is not running.

enumerator ApiLogQueueError

API Log queue error.

enumerator ApiLogOpenFileFailed

Failed open file for API Log.

enumerator ApiLogWriteFileFailed

Failed write file for API Log.

enumerator ApiLogReadFileFailed

Failed read file for API Log.

enumerator ApiLogFolderNotExist

API Log folder doesn’t exist.

enumerator ApiLogGetStatusError

Get API Log status error.

enumerator SystemError

System error.

enumerator SystemIsNoRunning

System is not running.

enumerator SystemInitializationNotDone

Device is created successfully but initialization of system is not done in specified time.

enumerator EngineNotStartedInSpecifiedTime

Engine is not started in specified time.

enumerator EngineNotStoppedInSpecifiedTime

Engine is not stopped in specified time.

enumerator CommNotStartedInSpecifiedTime

Communication is not started in specified time.

enumerator CommNotStoppedInSpecifiedTime

Communication is not stopped in specified time.

enumerator ModuleIsNotLoaded

Module is not loaded.

enumerator StartCommunicationError

Start communication failed. Please check the connection of the slave.

enumerator DeviceIsNotInUse

Specified device is not in use.

enumerator SetDeviceEventFailed

Failed to set device wait event.

enumerator ResetDeviceEventFailed

Failed to reset device wait event.

enumerator WaitForDeviceEventFailed

Failed to wait device event.

enumerator Reserved

Reserved.

enumerator CommNotStarted

Communication is not started.

enumerator CommNotStopped

Communication is not stopped.

enumerator VersionCheckError

Version check error (incompatible version).

enumerator CallbackFuncError

Callback function error.

enumerator CallbackFuncTimeOut

Callback function timed out.

enumerator CallbackFuncInvalidState

Callback function state invalid.

enumerator CallbackFuncInvalidMode

Callback function mode invalid.

enumerator MissingRequiredRtdll

One or more required RTDLLs are missing.

enumerator BusyReceivingAnotherAPICommand

Failed to execute API in time due to the engine executing other APIs.

enumerator NotIdleState

One or more axes are not in Idle operation state.

enumerator AxisOutOfRange

Axis is out of range.

enumerator AxisCountOutOfRange

Axis count is out of range.

enumerator DuplicateAxis

Same axis specified more than once.

enumerator IOAddressOutOfRange

I/O address is out of range.

enumerator IOSizeOutOfRange

I/O size is out of range.

enumerator ChannelOutOfRange

Channel is out of range.

enumerator ChannelUninitialized

Channel has not been initialized.

enumerator ChannelInUse

Channel is already in use.

enumerator ArgumentOutOfRange

One or more arguments out of range.

enumerator ArgumentIsNull

One or more arguments are null.

enumerator PrevSettingsBeingApplied

Previous setting changes are still being applied. Wait one communication cycle before changing the settings again.

enumerator ParamOutOfRange

One or more parameters out of range.

enumerator IDOutOfRange

ID is out of range.

enumerator IDNotDefined

ID is not defined.

enumerator ResourceInUse

Timed out while trying to obtain resource. Another API may be accessing the required resources.

enumerator FileOperationFailed

File operation failed.

enumerator StartingPreviousCommand

The axis is still starting the previous command. Wait until the next communication cycle.

enumerator StringConversionError

Error converting string types.

enumerator NoMotion

No motion occurs as a result of this command.

enumerator ServoOffline

The servos of one or more commanded axes are offline.

enumerator ServoOff

The servos of one or more commanded axes are off.

enumerator AxisAmpAlarm

Amplifier alarm detected in the servos of one or more commanded axes.

enumerator AxisSoftLimit

Software limit detected in one or more commanded axes.

enumerator AxisNearLimit

Near limit detected in one or more commanded axes.

enumerator AxisExternalLimit

External limit detected in one or more commanded axes.

enumerator AxisHardLimit

Hardware limit detected in one or more commanded axes.

enumerator UserMemoryAddressOutOfRange

User memory address is out of range.

enumerator UserMemorySizeOutOfRange

User memory size is out of range.

enumerator InvalidCommandProcessingMode

The current command processing mode does not support this function.

enumerator InterruptMismatch

The commanded axes have mismatched interrupts.

enumerator ErrorCodeNotDefined

Error code is not defined in this library.

enumerator BufferTooSmall

The buffer is too small for the specified size.

enumerator RequestedBufferTooLarge

The requested buffer size is too large.

enumerator RequestedBufferTooSmall

The requested buffer size is too small.

enumerator ModuleIDOutOfRange

Module ID is out of range.

enumerator UpdatesListUninitialized

Updates list file is not initialized.

enumerator UpdatesListDoesNotMatchInstalledUpdates

Updates list file does not match currently installed updates.

enumerator UpdatesListTimeout

Timed out while processing updates list.

enumerator ChannelCountOutOfRange

Channel count is out of range.

enumerator UnknownError

Unknown error.

Public Static Functions

static int convertErrorCode(int errCode)

Reserved.

Reserved.