AKELA OpenVNA
 All Data Structures Functions Variables Typedefs Groups
TaskState-Py

Proxy values for underlying C values from TaskState. More...

Variables

 TaskState = ct.c_int
 
tuple TASK_UNINITIALIZED = TaskState.in_dll(dll, "TASK_UNINITIALIZED")
 Task state of uninitialized.
 
tuple TASK_STOPPED = TaskState.in_dll(dll, "TASK_STOPPED")
 Task state of stopped.
 
tuple TASK_STARTED = TaskState.in_dll(dll, "TASK_STARTED")
 Task state of started.
 
dictionary TaskStateBOOK
 Dictionary for mapping task-rates values to human-readable string representations of the value. More...
 

Detailed Description

Proxy values for underlying C values from TaskState.

Values should be treated as immutable, and only used as parameters to pass into DLL cals.

While the underlying type is numeric, no assumptions can or should be made about the actual integer value, as it may change with DLL updates. Only equality operations should be assumed to be valid for any comparisons or value checks.

Note that Doxygen incorrectly identifies the type of these values as tuple, as the ctypes library does some runtime type munging that doxygen doesn't understand.

Variable Documentation

dictionary TaskStateBOOK
Initial value:
1 = {
2  TASK_UNINITIALIZED : 'TASK_UNINITIALIZED',
3  TASK_STOPPED : 'TASK_STOPPED',
4  TASK_STARTED : 'TASK_STARTED'
5  }

Dictionary for mapping task-rates values to human-readable string representations of the value.