EventControl Class

Function

C++

int GetInputModuleId();

Python

def GetInputModuleId()

Returns

Type

int

Value

ID of the module

Remarks

このPythonメソッドは予約されています。

Function

C++

WMX3APIFUNC GetInputData(unsigned char* buff, int buffSize, int* dataSize, char *initialState);

Python

def GetInputData(buff, buffSize, dataSize, initialState)

Returns

Type

int

Value

error code

Remarks

このPythonメソッドは予約されています。

Function

C++

WMX3APIFUNC SetInputData(int moduleId, unsigned char* data, int dataSize);

Python

def SetInputData(moduleId, data, dataSize)

Returns

Type

int

Value

error code

Remarks

このPythonメソッドは予約されています。

Function

C++

int GetOutputModuleId();

Python

def GetOutputModuleId()

Returns

Type

int

Value

ID of the module

Remarks

このPythonメソッドは予約されています。

Function

C++

WMX3APIFUNC GetOutputData(unsigned char* buff, int buffSize, int* dataSize);

Python

def GetOutputData(buff, buffSize, dataSize)

Returns

Type

int

Value

error code

Remarks

このPythonメソッドは予約されています。

Function

C++

WMX3APIFUNC SetOutputData(int moduleId, unsigned char* data, int dataSize);

Python

def SetOutputData(moduleId, data, dataSize)

Returns

Type

int

Value

error code

Remarks

このPythonメソッドは予約されています。

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 SetEvent(int *pId, EventInput *pEventInput, EventOutput *pEventOutput, EventOption *pOption = NULL);

Python

def SetEvent(pEventInput, pEventOutput)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - event id

Remarks

Function

C++

WMX3APIFUNC SetEvent(int *pId, EventInput *pEventInput, EventOutput *pEventOutput, EventOption *pOption = NULL);

Python

def SetEvent_Option(pEventInput, pEventOutput, pOption)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - event id

Remarks

Function

C++

wmx3Api::EventControl::SetEvent(int <em>pId, EventInput *pEventInput, EventOutput *pEventOutput, int id, EventOption *pOption); “WMX3APIFUNC SetEvent(int *pId, EventInput *pEventInput, EventOutput *pEventOutput, int id, EventOption</em> pOption = NULL);”

Python

def SetEvent_ID(pEventInput, pEventOutput, id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - event id

Remarks

Function

C++

wmx3Api::EventControl::SetEvent(int *pId, EventInput *pEventInput, EventOutput *pEventOutput, int id, EventOption *pOption); “WMX3APIFUNC SetEvent(int <em>pId, EventInput *pEventInput, EventOutput *pEventOutput, int id, EventOption</em> pOption = NULL);”

Python

def SetEvent_ID_Option(pEventInput, pEventOutput, id, pOption)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - event id

Remarks

Function

C++

WMX3APIFUNC GetEventModuleId(int id, int* pInputModuleId, int* pOutputModuleId);

Python

def GetEventModuleId(id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - input module Id

  • 2 : int - output moduleId

Remarks

Function

C++

WMX3APIFUNC GetEvent(int id, EventInput <em>pEventInput, EventOutput *pEventOutput, EventOption</em> pOption = NULL);

Python

def GetEvent_InOut(id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventApiEventInput - event input

  • 2 : EventApiEventOutput - event output

  • 3 : EventOption - event option

Remarks

Function

C++

WMX3APIFUNC GetEventOption(int id, EventOption* pOption);

Python

def GetEventOption(id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventOption - event option

Remarks

Function

C++

WMX3APIFUNC SetEventInput(int id, EventInput *pEventInput);

Python

def SetEventInput(id, pEventInput)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetEventOutput(int id, EventOutput *pEventOutput);

Python

def SetEventOutput(id, pEventOutput)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetEventInput(int id, EventInput* pEventInput);

Python

def GetEventInput(id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventApiEventInput - event input

Remarks

Function

C++

WMX3APIFUNC GetEventOutput(int id, EventOutput* pEventOutput);

Python

def GetEventOutput(id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventApiEventOutput - event output

Remarks

Function

C++

WMX3APIFUNC GetAllEventID (AllEventID *pEventIdData, int filterInputModuleId=-1, int filterOutputModuleId=-1);

Python

def GetAllEventID()

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_AllEventID - event data

Remarks

Function

C++

WMX3APIFUNC GetAllEventID (AllEventID *pEventIdData, int filterInputModuleId=-1, int filterOutputModuleId=-1);

Python

def GetAllEventID_In(filterInputModuleId)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_AllEventID - event data

Remarks

Function

C++

WMX3APIFUNC GetAllEventID(AllEventID *pEventIdData, int filterInputModuleId = -1, int filterOutputModuleId = -1);

Python

def GetAllEventID_InOut(filterInputModuleId, filterOutputModuleId)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_AllEventID - event data

Remarks

Function

C++

WMX3APIFUNC EnableEvent(int id, unsigned char enable);

Python

def EnableEvent(id, enable)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC RemoveEvent(int id);

Python

def RemoveEvent(id)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC ClearAllEvent();

Python

def ClearAllEvent()

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetCustomEvent(int* pId, int inputModuleId, void* pInputData, int inputDataSize, int outputModuleId, void* pOutputData, int outputDataSize, int id, CustomEventOption* pOption = NULL);

Python

Returns

Type

Value

Remarks

このC++メソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC SetCustomEventInput(int id, int moduleId, void* pInputData, int inputDataSize);

Python

Returns

Type

Value

Remarks

このC++メソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC SetCustomEventOutput(int id, int moduleId, void* pOutputData, int outputDataSize);

Python

Returns

Type

Value

Remarks

このC++メソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC GetCustomEventInput(int id, void* pInputDataBuff, int inputDataBuffSize, int* pInputDataSize, int* pModuleId);

Python

Returns

Type

Value

Remarks

このC++メソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC GetCustomEventOutput(int id, void* pOutputDataBuff, int outputDataBuffSize, int* pOutputDataSize, int* pModuleId);

Python

Returns

Type

Value

Remarks

このC++メソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC SetCustomEventConfigureOfModule(int moduleId, void* pSetEventData, int setEventDataSize);

Python

Returns

Type

Value

Remarks

このC++メソッドは予約されており、PythonAPIでは未サポートです。

Function

C++

WMX3APIFUNC SetEvent(int *pId, Event *pEventData);

Python

def SetEvent(pEventData)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - event id

Remarks

Function

C++

WMX3APIFUNC SetEvent(int *pId, Event *pEventData, unsigned int id);

Python

Returns

Type

Value

Remarks

Function

C++

WMX3APIFUNC GetEvent(int id, Event *pEventData);

Python

def GetEvent(id)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_Event - event data

Remarks

Function

C++

WMX3APIFUNC SetSoftwareTouchProbe(unsigned int channel, unsigned char enable, int axis, int byteAddrs, int bitOffset, unsigned char logic, TouchProbeMode::T mode);

Python

def SetSoftwareTouchProbe(channel, enable, axis, byteAddrs, bitOffset, logic, mode)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC EnableSoftwareTouchProbe(unsigned int channel, unsigned char enable);

Python

def EnableSoftwareTouchProbe(channel, enable)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetSoftwareTouchProbe(unsigned int channel, unsigned char *pEnabled, int *pAxis, int *pByteAddrs, int *pBitOffset, unsigned char *pLogic, TouchProbeMode::T *pMode);

Python

def GetSoftwareTouchProbe(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - enabled

  • 2 : int - axis

  • 3 : int - byte address

  • 4 : int - bit offset

  • 5 : unsigned int -logic

  • 6 : int - mode

Remarks

Function

C++

WMX3APIFUNC IsSoftwareTouchProbeLatched(unsigned int channel, unsigned char *pLatched);

Python

def IsSoftwareTouchProbeLatched(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - lached

Remarks

Function

C++

WMX3APIFUNC GetSoftwareTouchProbeCounterValue(unsigned int channel, unsigned char *pLatched, double *pCounterValue);

Python

def GetSoftwareTouchProbeCounterValue(channel, pLatched, pCounterValue)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - lached

  • 2 : double - counter value

Remarks

Function

C++

WMX3APIFUNC SetHardwareTouchProbe(int axis, unsigned char enable, TouchProbeMode::T mode, TouchProbeSource::T triggerSource, unsigned int channel);

Python

def SetHardwareTouchProbe(axis, enable, mode, triggerSource, channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetHardwareTouchProbeStatus(int axis, HardwareTouchProbeStatus *pStatus);

Python

def GetHardwareTouchProbeStatus(axis)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_HardwareTouchProbeStatus - status

Remarks

Function

C++

WMX3APIFUNC EnableHardwareTouchProbe(int axis, unsigned char enable);

Python

def EnableHardwareTouchProbe(axis, enable)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetPSOConfig(unsigned int channel, ComparisonType::T type, ComparatorSource *pSource, PSOOutput *pOutput, double minDurationMilliseconds, PSOOption *pOption = NULL);

Python

def SetPSOConfig(channel, pType, pMinDurationMilliseconds)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetPSOConfig(unsigned int channel, ComparisonType::T type, ComparatorSource *pSource, PSOOutput *pOutput, double minDurationMilliseconds, PSOOption *pOption = NULL);

Python

def SetPSOConfig_Option(channel, pType, pMinDurationMilliseconds, pOption)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPSOConfig(unsigned int channel, ComparisonType::T *pType, ComparatorSource *pSource,PSOOutput *pOutput, double *pMinDurationMilliseconds, PSOOption *pOption = NULL);

Python

def GetPSOConfig(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - type

  • 2 : EventControl_ComparatorSource - source

  • 3 : EventControl_PSOOutput - pso output

  • 4 : double - min duration milliseconds

Remarks

Function

C++

WMX3APIFUNC GetPSOConfig(unsigned int channel, ComparisonType::T *pType, ComparatorSource *pSource,PSOOutput *pOutput, double *pMinDurationMilliseconds, PSOOption *pOption = NULL);

Python

def GetPSOConfig_Option(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - type

  • 2 : EventControl_ComparatorSource - source

  • 3 : EventControl_PSOOutput - pso output

  • 4 : double - min duration milliseconds

  • 5 : EventControl_PSOOption - pso option

Remarks

Function

C++

WMX3APIFUNC SetPSOSingleData(unsigned int channel, double sData);

Python

def SetPSOSingleData(channel, sData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetPSOMultipleData(unsigned int channel, int count, double *pMData);

Python

def SetPSOMultipleData(channel, count, pMData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetPSOIntervalData(unsigned int channel, double rangeStart, double rangeEnd, double interval);

Python

def SetPSOIntervalData(channel, rangeStart, rangeEnd, interval)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPSOData(unsigned int channel, int *pCount, double *pMData, int maxCount);

Python

def GetPSOData(channel, maxCount)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - count

  • 2 : double - mdata

Remarks

Function

C++

WMX3APIFUNC GetPSODataCount(unsigned int channel, int *pCount);

Python

def GetPSODataCount(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - count

Remarks

Function

C++

WMX3APIFUNC GetPSOIntervalData(unsigned int channel, double *pRangeStart, double *pRangeEnd, double *pInterval);

Python

def GetPSOIntervalData(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : double - range start

  • 2 : double - range end

  • 3 : double - interval

Remarks

Function

C++

WMX3APIFUNC StartPSO(unsigned int channel);

Python

def StartPSO(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC StopPSO(unsigned int channel);

Python

def StopPSO(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPSOStatus(unsigned int channel, PSOStatus *pStatus);

Python

def GetPSOStatus(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_PSOStatus - status

Remarks

Function

C++

WMX3APIFUNC SetPlannedVelOverrideConfig(unsigned int channel, ComparisonType::T type, ComparatorSource *pSource, int axis);

Python

def SetPlannedVelOverrideConfig(channel, type, pSource, axis)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPlannedVelOverrideConfig(unsigned int channel, ComparisonType::T *pType, ComparatorSource *pSource, int *pAxis);

Python

def GetPlannedVelOverrideConfig(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - type

  • 2 : EventControl_ComparatorSource - source

  • 3 : int - axis

Remarks

Function

C++

WMX3APIFUNC SetPlannedVelOverrideSingleData(unsigned int channel, PlannedVelocityData sData);

Python

def SetPlannedVelOverrideSingleData(channel, sData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC SetPlannedVelOverrideMultipleData(unsigned int channel, int count, PlannedVelocityData *pMData);

Python

def SetPlannedVelOverrideMultipleData(channel, count, pMData)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPlannedVelOverrideData(unsigned int channel, int *pCount, PlannedVelocityData *pMData, int maxCount);

Python

def GetPlannedVelOverrideData(channel, maxCount)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - count

  • 2 : EventControl_PlannedVelocityData - mdata

Remarks

Function

C++

WMX3APIFUNC GetPlannedVelOverrideDataCount(unsigned int channel, int *pCount);

Python

def GetPlannedVelOverrideDataCount(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : int - count

Remarks

Function

C++

WMX3APIFUNC StartPlannedVelOverride(unsigned int channel);

Python

def StartPlannedVelOverride(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC StopPlannedVelOverride(unsigned int channel);

Python

def StopPlannedVelOverride(channel)

Returns

Type

int

Value

error code

Remarks

Function

C++

WMX3APIFUNC GetPlannedVelOverrideStatus(unsigned int channel, PlannedVelocityStatus *pStatus);

Python

def GetPlannedVelOverrideStatus(channel)

Returns

Type

tuple

Value

  • 0 : int - error code

  • 1 : EventControl_PlannedVelocityStatus - status

Remarks