itom
1.0.13
|
class summing up the functionality of itom - hardware python plugins More...
#include <pythonPlugins.h>
Classes | |
struct | PyActuatorAxis |
struct | PyActuatorPlugin |
struct | PyAlgoPlugin |
struct | PyDataIOPlugin |
Static Public Member Functions | |
static void | PyActuatorPlugin_dealloc (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_new (PyTypeObject *type, PyObject *args, PyObject *kwds) |
static int | PyActuatorPlugin_init (PyActuatorPlugin *self, PyObject *args, PyObject *kwds) |
static PyObject * | PyActuatorPlugin_repr (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_name (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_getParamList (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_getParamListInfo (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_getExecFuncsInfo (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_getParam (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_setParam (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_getType (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_execFunc (PyActuatorPlugin *self, PyObject *args, PyObject *kwds) |
static PyObject * | PyActuatorPlugin_showConfiguration (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_showToolbox (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_hideToolbox (PyActuatorPlugin *self) |
static PyObject * | PyActuatorPlugin_calib (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_setOrigin (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_getStatus (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_getPos (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_setPosAbs (PyActuatorPlugin *self, PyObject *args) |
static PyObject * | PyActuatorPlugin_setPosRel (PyActuatorPlugin *self, PyObject *args) |
static void | PyDataIOPlugin_dealloc (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_new (PyTypeObject *type, PyObject *args, PyObject *kwds) |
static int | PyDataIOPlugin_init (PyDataIOPlugin *self, PyObject *args, PyObject *kwds) |
static PyObject * | PyDataIOPlugin_repr (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_name (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_getParamList (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_getParamListInfo (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_getExecFuncsInfo (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_getParam (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_setParam (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_getType (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_execFunc (PyDataIOPlugin *self, PyObject *args, PyObject *kwds) |
static PyObject * | PyDataIOPlugin_showConfiguration (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_showToolbox (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_hideToolbox (PyDataIOPlugin *self) |
static PyObject * | PyDataIOPlugin_startDevice (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_stopDevice (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_acquire (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_getVal (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_copyVal (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_setVal (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_enableAutoGrabbing (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_disableAutoGrabbing (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_setAutoGrabbing (PyDataIOPlugin *self, PyObject *args) |
static PyObject * | PyDataIOPlugin_getAutoGrabbing (PyDataIOPlugin *self, PyObject *args) |
static void | PyDataIOPlugin_addTpDict (PyObject *tp_dict) |
static void | PyAlgoPlugin_dealloc (PyAlgoPlugin *self) |
static PyObject * | PyAlgoPlugin_new (PyTypeObject *type, PyObject *args, PyObject *kwds) |
static int | PyAlgoPlugin_init (PyAlgoPlugin *self, PyObject *args, PyObject *kwds) |
static PyObject * | PyAlgoPlugin_name (PyAlgoPlugin *self) |
static PyObject * | PyAlgoPlugin_getParamList (PyAlgoPlugin *self) |
static PyObject * | PyAlgoPlugin_getParamListInfo (PyAlgoPlugin *self, PyObject *args) |
static PyObject * | PyAlgoPlugin_getExecFuncsInfo (PyAlgoPlugin *self, PyObject *args) |
static PyObject * | PyAlgoPlugin_getParam (PyAlgoPlugin *self, PyObject *args) |
static PyObject * | PyAlgoPlugin_setParam (PyAlgoPlugin *self, PyObject *args) |
static PyObject * | PyAlgoPlugin_getType (PyAlgoPlugin *self) |
Static Public Attributes | |
static PyMemberDef | PyActuatorPlugin_members [] |
static PyMethodDef | PyActuatorPlugin_methods [] |
static PyTypeObject | PyActuatorPluginType |
static PyModuleDef | PyActuatorPluginModule |
static PyMemberDef | PyDataIOPlugin_members [] |
static PyMethodDef | PyDataIOPlugin_methods [] |
static PyTypeObject | PyDataIOPluginType |
static PyModuleDef | PyDataIOPluginModule |
static PyMemberDef | PyAlgoPlugin_members [] |
static PyMethodDef | PyAlgoPlugin_methods [] |
static PyTypeObject | PyAlgoPluginType |
static PyModuleDef | PyAlgoPluginModule |
class summing up the functionality of itom - hardware python plugins
There exist three different types of plugins for the itom program:
The python interfaces for these plugins are declared in this class. For a more detailed description about the plugin interface their handling and so on see the documentation of the according classes AddInInterfaceBase, AddInBase, AddInActuator, AddInDataIO, AddInAlgo and AddInManager.
PyObject * ito::PythonPlugins::PyActuatorPlugin_calib | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
calibrate actuator axi(e)s
[in] | self | the actuator object (python) |
[in] | args | the axi(e)s numbers |
Invokes the calibrate method on an actuator object with the numbers of the axis passed. The status is of the calibration is returned or an error.
void ito::PythonPlugins::PyActuatorPlugin_dealloc | ( | PyActuatorPlugin * | self | ) | [static] |
desctructor for actuator object in python
[in] | self | Destructs an actuator object (plugin), i.e. deletes the according python variable and invokes the closeAddIn function. The object itself is only deleted if the object's reference counter is zero. |
PyObject * ito::PythonPlugins::PyActuatorPlugin_getExecFuncsInfo | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
returns the list of available parameters and additional information about the plugin ExecFunctions
[in] | self | the actuator object (python) |
All ExecFunctions of the plugin are shown or one specific ExecFunctions with additional information as min, max and infostring is shown. This can be useful as there are only few standard parameters for an actuator. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyActuatorPlugin_getParam | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
gets a parameter value
[in] | self | the actuator object (python) |
[in] | args | the parameter name |
The getParam method of the plugin is invoked and the actual parameter value is returned. If the parameter doesn't exist an error is returned.
PyObject * ito::PythonPlugins::PyActuatorPlugin_getParamList | ( | PyActuatorPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the actuator object (python) |
All parameters of the plugin are shown. This can be useful as there are only few standard parameters for an actuator. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyActuatorPlugin_getParamListInfo | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
returns the list of available parameters and additional information about the plugin
[in] | self | the actuator object (python) |
All parameters of the plugin are shown with additional information as min, max and infostring. This can be useful as there are only few standard parameters for an actuator. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyActuatorPlugin_getPos | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
get the current position of axi(e)S
[in] | self | the actuator object (python) |
[in] | args | the axi(e)s numbers |
Reads the position of the axi(e)s passed as parameter.
PyObject * ito::PythonPlugins::PyActuatorPlugin_getStatus | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
get the status of an actuator
[in] | self | the actuator object (python) |
[in] | args | the axi(e)s numbers |
Returns the status of the axi(e)s passed as parameter.
PyObject * ito::PythonPlugins::PyActuatorPlugin_getType | ( | PyActuatorPlugin * | self | ) | [static] |
returns the type of the actuator object
[in] | self | the actuator object (python) |
This method simply returns the type of the actuator object
PyObject * ito::PythonPlugins::PyActuatorPlugin_hideToolbox | ( | PyActuatorPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the actuator object (python) |
This method simply close the widget
int ito::PythonPlugins::PyActuatorPlugin_init | ( | PyActuatorPlugin * | self, |
PyObject * | args, | ||
PyObject * | kwds | ||
) | [static] |
constructor for actuator object (plugin) accessible from python
[in] | self | the according pythonActuator object |
[in] | args | unnamed arguments passed to the constructor in python |
[in] | kwds | keyword parameters passed to the constructor in pyhton |
At first the list of available plugins is searched whether the plugin can be found (by name). If it was found the plugin's manadtory ans optional initialization parameters are retrieved and a parameter check is done. In case everything went right a new instance of a plugin is created with the parameters passed to the constructor.
< copy constructor or name only
PyObject * ito::PythonPlugins::PyActuatorPlugin_name | ( | PyActuatorPlugin * | self | ) | [static] |
Returns the plugin's name
[in] | self | the plugin object |
Queries the name of a plugin by invoking a getParam on the plugin for the name parameter
PyObject * ito::PythonPlugins::PyActuatorPlugin_new | ( | PyTypeObject * | type, |
PyObject * | args, | ||
PyObject * | kwds | ||
) | [static] |
constructor for actuator object in python
[in] | type |
Creates a new pythonActuator object. The actual actuator object (itom) is only created later.
PyObject * ito::PythonPlugins::PyActuatorPlugin_setOrigin | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
set the origin of axi(e)s
[in] | self | the actuator object (python) |
[in] | args | the axi(e)s |
The axi(e)s current position is set as new origin of the axi(e)s.
PyObject * ito::PythonPlugins::PyActuatorPlugin_setParam | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
set a parameter to a new value
[in] | self | the actuator object (python) |
[in] | args | the parameter name and new value |
The setParam method of the plugin is invoked and the parameter is set to the new value in case the passed value is within the limits.
PyObject * ito::PythonPlugins::PyActuatorPlugin_setPosAbs | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
set actuator axi(e)s to new absolute position(s)
[in] | self | the actuator object (python) |
[in] | args | the axi(e)s numbers |
The passed parameters are parsed using the helper function parsePosParams and in case a meaningful number of axi(e)s and position(s) are found the setPosAbs method of the actuator object is invoked.
PyObject * ito::PythonPlugins::PyActuatorPlugin_setPosRel | ( | PyActuatorPlugin * | self, |
PyObject * | args | ||
) | [static] |
set actuator axi(e)s to new relative position(s)
[in] | self | the actuator object (python) |
[in] | args | the axi(e)s numbers |
The passed parameters are parsed using the helper function parsePosParams and in case a meaningful number of axi(e)s and position(s) are found the setPosRel method of the actuator object is invoked.
PyObject * ito::PythonPlugins::PyActuatorPlugin_showConfiguration | ( | PyActuatorPlugin * | self | ) | [static] |
open configuration dialog
[in] | self | the actuator object (python) |
This method simply open the configuration dialog
PyObject * ito::PythonPlugins::PyActuatorPlugin_showToolbox | ( | PyActuatorPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the actuator object (python) |
This method simply open the widget
void ito::PythonPlugins::PyAlgoPlugin_dealloc | ( | PyAlgoPlugin * | self | ) | [static] |
desctructor for algo object in python
[in] | self | Destructs an algo object (plugin), i.e. deletes the according python variable and invokes the closeAddIn function. The object itself is only deleted if the object's reference counter is zero. |
PyObject * ito::PythonPlugins::PyAlgoPlugin_getExecFuncsInfo | ( | PyAlgoPlugin * | self, |
PyObject * | args | ||
) | [static] |
returns the list of available parameters and additional information about the plugin ExecFunctions
[in] | self | the algorithm object (python) |
All ExecFunctions of the plugin are shown or one specific ExecFunctions with additional information as min, max and infostring is shown. This can be useful as there are only few standard parameters for an dataIO. The majority is depending on the actual hardware and accordingly is different for each plugin.
This function os obsolet because currently no algo has an living instance in python
PyObject * ito::PythonPlugins::PyAlgoPlugin_getParam | ( | PyAlgoPlugin * | self, |
PyObject * | args | ||
) | [static] |
return a parameter value
[in] | self | the addIn whoes parameter is requested |
[in] | args | the parameter name |
The function tries to retrieve the value of the parameter with the name given in args. If the parameter does not exist NULL is returned. To actually retrieve the value the getParam function of the plugin is invoked.
PyObject * ito::PythonPlugins::PyAlgoPlugin_getParamList | ( | PyAlgoPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the algo object (python) |
All parameters of the plugin are shown. This can be useful as there are only few standard parameters for an algorithm. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyAlgoPlugin_getParamListInfo | ( | PyAlgoPlugin * | self, |
PyObject * | args | ||
) | [static] |
returns the list of available parameters and additional information about the plugin
[in] | self | the algo object (python) |
All parameters of the plugin are shown with additional information as min, max and infostring. This can be useful as there are only few standard parameters for an actuator. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyAlgoPlugin_getType | ( | PyAlgoPlugin * | self | ) | [static] |
returns the type of the Algo object
[in] | self | the Algo object (python) |
This method simply returns the type of the Algo object
int ito::PythonPlugins::PyAlgoPlugin_init | ( | PyAlgoPlugin * | self, |
PyObject * | args, | ||
PyObject * | kwds | ||
) | [static] |
constructor for algo object
[in] | self | the according algo object |
[in] | args | unnamed arguments passed to the constructor in python |
The algo passed must be a valid algo object.
< copy constructor or name only
PyObject * ito::PythonPlugins::PyAlgoPlugin_name | ( | PyAlgoPlugin * | self | ) | [static] |
Returns the plugin's name
[in] | self | the plugin object |
Queries the name of a plugin by invoking a getParam on the plugin for the name parameter
PyObject * ito::PythonPlugins::PyAlgoPlugin_new | ( | PyTypeObject * | type, |
PyObject * | args, | ||
PyObject * | kwds | ||
) | [static] |
constructor for algo object in python
[in] | type |
Creates a new pythonAlgo object. The actual algo object (itom) is only created later.
PyObject * ito::PythonPlugins::PyAlgoPlugin_setParam | ( | PyAlgoPlugin * | self, |
PyObject * | args | ||
) | [static] |
set a parameter to a new value
[in] | self | the algo object (python) |
[in] | args | the parameter name and new value |
The setParam method of the plugin is invoked and the parameter is set to the new value in case the passed value is within the limits. This method effects only parameters of a "whole" algo plugin - not single parameters of a destinct filter.
PyObject * ito::PythonPlugins::PyDataIOPlugin_acquire | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
acquire data with a dataIO device
[in] | self | the dataIO object (python) |
[in] | args | number of acquisitions |
After the device has been initialized and started this method can be used to trigger the acquisition of a data set. The data is then recorded depending on the actually set parameters of the device and can be afterwards retrieved from the device using the getVal method.
PyObject * ito::PythonPlugins::PyDataIOPlugin_copyVal | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
copy values from a dataIO device to an existing dataObject
[in] | self | the dataIO object (python) |
[in] | args | input buffer |
After a device has been started and an acquisition was triggered the result can be retrieved from the device with the getVal method. As argument the input buffer is passed.
void ito::PythonPlugins::PyDataIOPlugin_dealloc | ( | PyDataIOPlugin * | self | ) | [static] |
desctructor for axis object in python
[in] | self | Destructs an actuator object (plugin), i.e. deletes the according python variable and invokes the closeAddIn function. The object itself is only deleted if the object's reference counter is zero. constructor for actuatorAxis object in python |
[in] | type |
Creates a new pythonActuatorAxis object. The actual actuatorAxis object (itom) is only created later. constructor for actuator axis object
[in] | self | the according actuatorAxis object |
[in] | args | unnamed arguments passed to the constructor in python |
The actuator passed must be a valid actuator object and the axis number must exist. get the status of an axis
[in] | self | the axis object (python) |
Returns the status of the axis passed as parameter. get the position of the axis
[in] | self | the axis object (python) |
Reads the position of the axis set axis to new absolute position
[in] | self | the axis object (python) |
[in] | args | the new position |
The setPosAbs method of the axis object is invoked and their return value returned set axis to new relative position
[in] | self | the axis object (python) |
[in] | args | new position |
The setPosRel method of the actuator object is invoked and their return value is returned. desctructor for dataIO object in python
[in] | self | Destructs an instance of a dataIO object (plugin), i.e. deletes the according python variable and invokes the closeAddIn function. The object itself is only deleted if the object's <<<erence counter is zero. |
PyObject * ito::PythonPlugins::PyDataIOPlugin_disableAutoGrabbing | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
disable timer triggered autograbbing of a dataIO device
[in] | self | the dataIO object (python) |
[in] | args | empty |
When the autograbbing is stopped the device will no longer periodically acquire data triggered by an internal timer event. Anyway if the connected live view is still present it will receive data recorded by manual acquisitions. This may be usful when a sort of live view is desired within a measurement loop where a timer based autograbbing would disturbe the measurement process.
PyObject * ito::PythonPlugins::PyDataIOPlugin_enableAutoGrabbing | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
enable timer triggered autograbbing of a dataIO device
[in] | self | the dataIO object (python) |
[in] | args | empty |
For live viewing of data incoming from a dataIO device the autograbbing must be enabled. It starts a timer which triggers periodically the data acquisition and pushes the new buffer to the output graph(s).
PyObject * ito::PythonPlugins::PyDataIOPlugin_getAutoGrabbing | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
return the status of the autograbbing
[in] | self | the dataIO object (python) |
[in] | args | empty |
This method simply returns the status of the autograbbing.
PyObject * ito::PythonPlugins::PyDataIOPlugin_getExecFuncsInfo | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
returns the list of available parameters and additional information about the plugin ExecFunctions
[in] | self | the actuator object (python) |
All ExecFunctions of the plugin are shown or one specific ExecFunctions with additional information as min, max and infostring is shown. This can be useful as there are only few standard parameters for an dataIO. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyDataIOPlugin_getParam | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
return a parameter value
[in] | self | the addIn whoes parameter is requested |
[in] | args | the parameter name |
The function tries to retrieve the value of the parameter with the name given in args. If the parameter does not exist NULL is returned. To actually retrieve the value the getParam function of the plugin is invoked.
PyObject * ito::PythonPlugins::PyDataIOPlugin_getParamList | ( | PyDataIOPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the dataIO object (python) |
All parameters of the plugin are shown. This can be useful as there are only few standard parameters for an dataIO. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyDataIOPlugin_getParamListInfo | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
returns the list of available parameters and additional information about the plugin
[in] | self | the dataIO object (python) |
All parameters of the plugin are shown with additional information as min, max and infostring. This can be useful as there are only few standard parameters for an dataIO. The majority is depending on the actual hardware and accordingly is different for each plugin.
PyObject * ito::PythonPlugins::PyDataIOPlugin_getType | ( | PyDataIOPlugin * | self | ) | [static] |
returns the type of the dataIO object
[in] | self | the dataIO object (python) |
This method simply returns the type of the dataIO object
PyObject * ito::PythonPlugins::PyDataIOPlugin_getVal | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
get values from a dataIO device
[in] | self | the dataIO object (python) |
[in] | args | input buffer |
After a device has been started and an acquisition was triggered the result can be retrieved from the device with the getVal method. As argument the input buffer is passed.
PyObject * ito::PythonPlugins::PyDataIOPlugin_hideToolbox | ( | PyDataIOPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the actuator object (python) |
This method simply close the widget
int ito::PythonPlugins::PyDataIOPlugin_init | ( | PyDataIOPlugin * | self, |
PyObject * | args, | ||
PyObject * | kwds | ||
) | [static] |
constructor for dataIO object
[in] | self | the according dataIO object |
[in] | args | unnamed arguments passed to the constructor in python |
The dataIO passed must be a valid dataIO object. In case the autoloading of parameters is activated for this plugin the default parameters are loaded.
< copy constructor or name only
PyObject * ito::PythonPlugins::PyDataIOPlugin_name | ( | PyDataIOPlugin * | self | ) | [static] |
Returns the plugin's name
[in] | self | the plugin object |
Queries the name of a plugin by invoking a getParam on the plugin for the name parameter
PyObject * ito::PythonPlugins::PyDataIOPlugin_new | ( | PyTypeObject * | type, |
PyObject * | args, | ||
PyObject * | kwds | ||
) | [static] |
constructor for dataIO object in python
[in] | type |
Creates a new pythonDataIO object. The actual dataIO object (itom) is only created later.
PyObject * ito::PythonPlugins::PyDataIOPlugin_setParam | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
set a parameter to a new value
[in] | self | the actuator object (python) |
[in] | args | the parameter name and new value |
The setParam method of the plugin is invoked and the parameter is set to the new value in case the passed value is within the limits.
PyObject * ito::PythonPlugins::PyDataIOPlugin_setVal | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
write values to a dataIO device
[in] | self | the dataIO object (python) |
[in] | args | output buffer |
Analog to the getVal method this method writes data to a dataIO device (e.g. a DA converter or serial port).The data passed in the output buffer is written to the device according to its current parameters.
PyObject * ito::PythonPlugins::PyDataIOPlugin_showConfiguration | ( | PyDataIOPlugin * | self | ) | [static] |
open configuration dialog
[in] | self | the actuator object (python) |
This method simply open the configuration dialog
PyObject * ito::PythonPlugins::PyDataIOPlugin_showToolbox | ( | PyDataIOPlugin * | self | ) | [static] |
returns the list of available parameters
[in] | self | the actuator object (python) |
This method simply open the widget
PyObject * ito::PythonPlugins::PyDataIOPlugin_startDevice | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
start a dataIO device, i.e. prepare it for recording data
[in] | self | the dataIO object (python) |
[in] | args | should be empty |
Start a dataIO device, i.e. prepare it for the acquisition of data. Usually the device is first initialized, then then it is started using this function afterwards a number of acquisitions is done (using PyDataIOPlugin_acquire and PyDataIOPlugin_getVal) and only after the last data set is recorded it is stopped again.
PyObject * ito::PythonPlugins::PyDataIOPlugin_stopDevice | ( | PyDataIOPlugin * | self, |
PyObject * | args | ||
) | [static] |
stop a dataIO device
[in] | self | the dataIO object (python)QString |
[in] | args | should be empty |
Stop a dataIO device, i.e. it is no longer possible to acquire data with it. See also PyDataIOPlugin_startDevice
PyMemberDef ito::PythonPlugins::PyActuatorPlugin_members [static] |
{ {NULL} }
PyMethodDef ito::PythonPlugins::PyActuatorPlugin_methods [static] |
{ {"getParamList", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParamList, METH_NOARGS, pyActuatorGetParamList_doc}, {"getParamListInfo", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParamListInfo, METH_VARARGS, pyActuatorGetParamListInfo_doc}, {"getExecFuncsInfo", (PyCFunction)PythonPlugins::PyActuatorPlugin_getExecFuncsInfo, METH_VARARGS, pyPlugInGetExecFuncsInfo_doc}, {"name", (PyCFunction)PythonPlugins::PyActuatorPlugin_name, METH_NOARGS, pyActuatorName_doc}, {"getParam", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParam, METH_VARARGS, pyActuatorGetParam_doc}, {"setParam", (PyCFunction)PythonPlugins::PyActuatorPlugin_setParam, METH_VARARGS, pyActuatorSetParam_doc}, {"calib", (PyCFunction)PythonPlugins::PyActuatorPlugin_calib, METH_VARARGS, pyActuatorCalib_doc}, {"setOrigin", (PyCFunction)PythonPlugins::PyActuatorPlugin_setOrigin, METH_VARARGS, pyActuatorSetOrigin_doc}, {"getStatus", (PyCFunction)PythonPlugins::PyActuatorPlugin_getStatus, METH_VARARGS, pyActuatorGetStatus_doc}, {"getPos", (PyCFunction)PythonPlugins::PyActuatorPlugin_getPos, METH_VARARGS, pyActuatorGetPos_doc}, {"setPosAbs", (PyCFunction)PythonPlugins::PyActuatorPlugin_setPosAbs, METH_VARARGS, pyActuatorSetPosAbs_doc}, {"setPosRel", (PyCFunction)PythonPlugins::PyActuatorPlugin_setPosRel, METH_VARARGS, pyActuatorSetPosRel_doc}, {"getType", (PyCFunction)PythonPlugins::PyActuatorPlugin_getType, METH_NOARGS, PyActuatorPlugin_getType_doc}, {"exec", (PyCFunction)PythonPlugins::PyActuatorPlugin_execFunc, METH_KEYWORDS | METH_VARARGS, PyActuatorPlugin_execFunc_doc}, {"showConfiguration", (PyCFunction)PythonPlugins::PyActuatorPlugin_showConfiguration, METH_NOARGS, pyActuatorShowConfiguration_doc}, {"showToolbox", (PyCFunction)PythonPlugins::PyActuatorPlugin_showToolbox, METH_NOARGS, pyActuatorShowToolbox_doc}, {"hideToolbox", (PyCFunction)PythonPlugins::PyActuatorPlugin_hideToolbox, METH_NOARGS, pyActuatorHideToolbox_doc}, {NULL} }
PyModuleDef ito::PythonPlugins::PyActuatorPluginModule [static] |
{ PyModuleDef_HEAD_INIT, "actuatorPlugin", QObject::tr("Itom ActuatorPlugin type in python").toAscii().data(), -1, NULL, NULL, NULL, NULL, NULL }
PyMemberDef ito::PythonPlugins::PyAlgoPlugin_members [static] |
{ {NULL} }
PyMethodDef ito::PythonPlugins::PyAlgoPlugin_methods [static] |
{ {"getParamList", (PyCFunction)PythonPlugins::PyAlgoPlugin_getParamList, METH_NOARGS, PyAlgoPlugin_getParamList_doc}, {"getParamListInfo", (PyCFunction)PythonPlugins::PyAlgoPlugin_getParamListInfo, METH_VARARGS, PyAlgoPlugin_getParamListInfo_doc}, {"getExecFuncsInfo", (PyCFunction)PythonPlugins::PyAlgoPlugin_getExecFuncsInfo, METH_VARARGS, pyPlugInGetExecFuncsInfo_doc}, {"name", (PyCFunction)PythonPlugins::PyAlgoPlugin_name, METH_NOARGS, "name() -> returns name of algorithm plugin"}, {"getParam", (PyCFunction)PythonPlugins::PyAlgoPlugin_getParam, METH_VARARGS, "getParam(name) -> returns value of given parameter"}, {"setParam", (PyCFunction)PythonPlugins::PyAlgoPlugin_setParam, METH_VARARGS, "setParam(name,value) -> sets value of given parameter"}, {"getType", (PyCFunction)PythonPlugins::PyAlgoPlugin_getType, METH_NOARGS, PyAlgoPlugin_getType_doc}, {NULL} }
PyModuleDef ito::PythonPlugins::PyAlgoPluginModule [static] |
{ PyModuleDef_HEAD_INIT, "algorithmPlugin", QObject::tr("Itom AlgorithmPlugin type in python").toAscii().data(), -1, NULL, NULL, NULL, NULL, NULL }
PyMemberDef ito::PythonPlugins::PyDataIOPlugin_members [static] |
{ {NULL} }
PyMethodDef ito::PythonPlugins::PyDataIOPlugin_methods [static] |
{ {"getParamList", (PyCFunction)PythonPlugins::PyDataIOPlugin_getParamList, METH_NOARGS, PyDataIOPlugin_getParamList_doc}, {"getParamListInfo", (PyCFunction)PythonPlugins::PyDataIOPlugin_getParamListInfo, METH_VARARGS, PyDataIOPlugin_getParamListInfo_doc}, {"getExecFuncsInfo", (PyCFunction)PythonPlugins::PyDataIOPlugin_getExecFuncsInfo, METH_VARARGS, pyPlugInGetExecFuncsInfo_doc}, {"name", (PyCFunction)PythonPlugins::PyDataIOPlugin_name, METH_NOARGS, PyDataIOPlugin_name_doc}, {"getParam", (PyCFunction)PythonPlugins::PyDataIOPlugin_getParam, METH_VARARGS, PyDataIOPlugin_getParam_doc}, {"setParam", (PyCFunction)PythonPlugins::PyDataIOPlugin_setParam, METH_VARARGS, PyDataIOPlugin_setParam_doc}, {"startDevice", (PyCFunction)PythonPlugins::PyDataIOPlugin_startDevice, METH_VARARGS, PyDataIOPlugin_startDevice_doc}, {"stopDevice", (PyCFunction)PythonPlugins::PyDataIOPlugin_stopDevice, METH_VARARGS, PyDataIOPlugin_stopDevice_doc}, {"acquire", (PyCFunction)PythonPlugins::PyDataIOPlugin_acquire, METH_VARARGS, PyDataIOPlugin_acquire_doc}, {"getVal", (PyCFunction)PythonPlugins::PyDataIOPlugin_getVal, METH_VARARGS, PyDataIOPlugin_getVal_doc}, {"copyVal", (PyCFunction)PythonPlugins::PyDataIOPlugin_copyVal, METH_VARARGS, PyDataIOPlugin_copyVal_doc}, {"setVal", (PyCFunction)PythonPlugins::PyDataIOPlugin_setVal, METH_VARARGS, PyDataIOPlugin_setVal_doc}, {"enableAutoGrabbing", (PyCFunction)PythonPlugins::PyDataIOPlugin_enableAutoGrabbing, METH_NOARGS, PyDataIOPlugin_enableAutoGrabbing_doc}, {"disableAutoGrabbing", (PyCFunction)PythonPlugins::PyDataIOPlugin_disableAutoGrabbing, METH_NOARGS, PyDataIOPlugin_disableAutoGrabbing_doc}, {"setAutoGrabbing", (PyCFunction)PythonPlugins::PyDataIOPlugin_setAutoGrabbing, METH_VARARGS, PyDataIOPlugin_setAutoGrabbing_doc}, {"getAutoGrabbing", (PyCFunction)PythonPlugins::PyDataIOPlugin_getAutoGrabbing, METH_NOARGS, PyDataIOPlugin_getAutoGrabbing_doc}, {"getType", (PyCFunction)PythonPlugins::PyDataIOPlugin_getType, METH_NOARGS, PyDataIOPlugin_getType_doc}, {"exec", (PyCFunction)PythonPlugins::PyDataIOPlugin_execFunc, METH_KEYWORDS | METH_VARARGS, PyDataIOPlugin_execFunc_doc}, {"showConfiguration", (PyCFunction)PythonPlugins::PyDataIOPlugin_showConfiguration, METH_NOARGS, pyDataIOShowConfiguration_doc}, {"showToolbox", (PyCFunction)PythonPlugins::PyDataIOPlugin_showToolbox, METH_NOARGS, pyDataIOShowToolbox_doc}, {"hideToolbox", (PyCFunction)PythonPlugins::PyDataIOPlugin_hideToolbox, METH_NOARGS, pyDataIOHideToolbox_doc}, {NULL} }
PyModuleDef ito::PythonPlugins::PyDataIOPluginModule [static] |
{ PyModuleDef_HEAD_INIT, "dataIOPlugin", QObject::tr("Itom DataIOPlugin type in python").toAscii().data(), -1, NULL, NULL, NULL, NULL, NULL }