CyclicBuffer 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 OpenCyclicBuffer(int axis, unsigned int buffSize);

Python

def OpenCyclicBuffer(axis, buffSize)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC OpenCyclicBuffer(AxisSelection *pAxisSelection, unsigned int buffSize);

Python

def OpenCyclicBuffer_AxisSel(pAxisSelection, buffSize)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC OpenCyclicBuffer(int axis, unsigned int buffSize, SizeUnit::T sizeUnit);

Python

def OpenCyclicBuffer(axis, buffSize, sizeUnit)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC OpenCyclicBuffer(AxisSelection *pAxisSelection, unsigned int buffSize, SizeUnit::T sizeUnit);

Python

def OpenCyclicBuffer_AxisSel(pAxisSelection, buffSize, sizeUnit)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC CloseCyclicBuffer(int axis);

Python

def CloseCyclicBuffer(axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC CloseCyclicBuffer(AxisSelection *pAxisSelection);

Python

def CloseCyclicBuffer_AxisSel(pAxisSelection)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC AddCommand(int axis, CyclicBufferSingleAxisCommand *pCmd);

Python

def AddCommand(axis, pCmd)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC AddCommand(int axis, CyclicBufferSingleAxisCommand *pCmd, int count);

Python

def AddCommand(axis, pCmd, count)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC AddCommand(AxisSelection *pAxisSelection, CyclicBufferMultiAxisCommands *pCmds);

Python

def AddCommand_AxisSel(pAxisSelection, pCmds)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC AddCommand(AxisSelection *pAxisSelection, CyclicBufferMultiAxisCommands *pCmds, int count);

Python

def AddCommand_AxisSel(pAxisSelection, pCmds, count)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Execute(int axis, CyclicBufferSingleAxisOption *pOption = NULL);

Python

  • def Execute(axis)

  • def Execute(axis, pOption)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Execute(AxisSelection *pAxisSelection, CyclicBufferMultiAxisOption *pOption = NULL);

Python

  • def Execute_AxisSel(pAxisSelection)

  • def Execute_AxisSel(pAxisSelection, pOption)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Abort(int axis);

Python

def Abort(axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC Abort(AxisSelection *pAxisSelection);

Python

def Abort_AxisSel(pAxisSelection)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetStatus(int axis, CyclicBufferSingleAxisStatus *pStatus);

Python

def GetStatus(axis)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : CyclicBufferSingleAxisStatus - status

Remarks

Function

C++

WMX3APIFUNC GetStatus(AxisSelection *pAxisSelection, CyclicBufferMultiAxisStatus *pStatus);

Python

def GetStatus_AxisSel(pAxisSelection)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : CyclicBufferMultiAxisStatus - status

Remarks