Compensation Class

Function

C++

static WMX3APIFUNC ErrorToString(int errCode, char *pString, unsigned int size);

Python

def ErrorToString(errCode)

Returns

Type

string

Value

error string

Remarks

Function

C++

static WMX3APIFUNC ErrorToString(int errCode, wchar_t *pString, unsigned int size);

Python

Returns

Type

Value

Remarks

Function

C++

static WMX3APIFUNC ApiLogToString(unsigned char *pLogData, unsigned int logDataSize, char *pString, unsigned int size);

Python

def ApiLogToString(pLogData, logDataSize)

Returns

Type

string

Value

API log string

Remarks

Function

C++

static WMX3APIFUNC ApiLogToString(unsigned char *pLogData, unsigned int logDataSize, wchar_t *pString, unsigned int size);

Python

Returns

Type

Value

Remarks

Function

C++

static WMX3APIFUNC GetLibVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion);

Python

def GetLibVersion()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - MajorVersion

  • 2 : int - MinorVersion

  • 3 : int - RevisionVersion

  • 4 : int - FixVersion

Remarks

Function

C++

bool IsDeviceValid();

Python

def IsDeviceValid()

Returns

Type

bool

Value

Whether the device is alive

Remarks

Function

C++

WMX3APIFUNC GetVersion(int *pMajorVersion, int *pMinorVersion, int *pRevisionVersion, int *pFixVersion);

Python

def GetVersion()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - MajorVersion

  • 2 : int - MinorVersion

  • 3 : int - RevisionVersion

  • 4 : int - FixVersion

Remarks

Function

C++

WMX3APIFUNC SetPitchErrorCompensation(int axis, PitchErrorCompensationData *pitchErrCompData);

Python

def SetPitchErrorCompensation(axis, pitchErrCompData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetPitchErrorCompensation(int axis, PitchErrorCompensationFreePositionData *pitchErrCompData);

Python

def SetPitchErrorCompensation_FreePosition(axis, pitchErrCompData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPitchErrorCompensation(int axis, PitchErrorCompensationData *pitchErrCompData);

Python

def GetPitchErrorCompensation(axis)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : PitchErrorCompensationData - pitchErrCompData

Remarks

Function

C++

WMX3APIFUNC GetPitchErrorCompensation(int axis, PitchErrorCompensationFreePositionData *pitchErrCompData);

Python

def GetPitchErrorCompensation_FreePosition(axis)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : PitchErrorCompensationFreePositionData - pitchErrCompData

Remarks

Function

C++

WMX3APIFUNC EnablePitchErrorCompensation(int axis);

Python

def EnablePitchErrorCompensation(axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC DisablePitchErrorCompensation(int axis);

Python

def DisablePitchErrorCompensation(axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPitchErrorCompensationAtPosition(int axis, double pos, double *pCompensation);

Python

def GetPitchErrorCompensationAtPosition(axis, pos)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : double - pCompensation

Remarks

Function

C++

WMX3APIFUNC Set2DPitchErrorCompensation(unsigned int channel, TwoDPitchErrorCompensationData *pitchErrCompData2D);

Python

def Set2DPitchErrorCompensation(channel, pitchErrCompData2D)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Set2DPitchErrorCompensation(unsigned int channel, TwoDPitchErrorCompensationFreePositionData *pitchErrCompData2D);

Python

def Set2DPitchErrorCompensation_FreePosition(channel, pitchErrCompData2D)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Get2DPitchErrorCompensation(unsigned int channel, TwoDPitchErrorCompensationData *pitchErrCompData2D);

Python

def Get2DPitchErrorCompensation(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : TwoDPitchErrorCompensationData - 2D pitch error comp data

Remarks

Function

C++

WMX3APIFUNC Get2DPitchErrorCompensation(unsigned int channel, TwoDPitchErrorCompensationFreePositionData *pitchErrCompData2D);

Python

def Get2DPitchErrorCompensation_FreePosition(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : TwoDPitchErrorCompensationFreePositionData - 2D pitch error comp data

Remarks

Function

C++

WMX3APIFUNC Enable2DPitchErrorCompensation(unsigned int channel);

Python

def Enable2DPitchErrorCompensation(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Disable2DPitchErrorCompensation(unsigned int channel);

Python

def Disable2DPitchErrorCompensation(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Get2DPitchErrorCompensationAtPosition(unsigned int channel, double refPos1, double refPos2, double *pCompensation);

Python

def Get2DPitchErrorCompensationAtPosition(channel, refPos1, refPos2)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : double - pCompensation

Remarks

Function

C++

WMX3APIFUNC SetBacklashCompensation(int axis, BacklashCompensationData *pBacklashCompData);

Python

def SetBacklashCompensation(axis, pBacklashCompData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetBacklashCompensation(int axis, BacklashCompensationData *pBacklashCompData);

Python

def GetBacklashCompensation(axis)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : BacklashCompensationData - backlash comp data

Remarks

Function

C++

WMX3APIFUNC EnableBacklashCompensation(int axis);

Python

def EnableBacklashCompensation(axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC DisableBacklashCompensation(int axis);

Python

def DisableBacklashCompensation(axis)

Returns

Type

int

Value

error code

Remarks