ito::PythonPlugins Class Reference

class summing up the functionality of itom - hardware python plugins More...

#include <pythonPlugins.h>

Classes
struct	PyActuatorPlugin
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_getExecFuncsList (PyActuatorPlugin *self)
static PyObject *	PyActuatorPlugin_getExecFuncsInfo (PyActuatorPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyActuatorPlugin_getParam (PyActuatorPlugin *self, PyObject *args)
static PyObject *	PyActuatorPlugin_getParamInfo (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_connect (PyActuatorPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyActuatorPlugin_disconnect (PyActuatorPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyActuatorPlugin_info (PyActuatorPlugin *self, PyObject *args)
static PyObject *	PyActuatorPlugin_setInterrupt (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 PyObject *	PyActuatorPlugin_userMutex_tryLock (PyActuatorPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyActuatorPlugin_userMutex_unlock (PyActuatorPlugin *self)
static PyObject *	PyActuatorPlugin_getCurrentStatus (PyActuatorPlugin *self, void *closure)
static PyObject *	PyActuatorPlugin_getCurrentPositions (PyActuatorPlugin *self, void *closure)
static PyObject *	PyActuatorPlugin_getTargetPositions (PyActuatorPlugin *self, void *closure)
static void	paramBaseVectorDeleter (QVector< ito::ParamBase > *obj)
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_getExecFuncsList (PyActuatorPlugin *self)
static PyObject *	PyDataIOPlugin_getExecFuncsInfo (PyDataIOPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyDataIOPlugin_getParam (PyDataIOPlugin *self, PyObject *args)
static PyObject *	PyDataIOPlugin_getParamInfo (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_stop (PyDataIOPlugin *self)
static PyObject *	PyDataIOPlugin_getVal (PyDataIOPlugin *self, PyObject *args)
static PyObject *	PyDataIOPlugin_copyVal (PyDataIOPlugin *self, PyObject *args)
static PyObject *	PyDataIOPlugin_setVal (PyDataIOPlugin *self, PyObject *args, PyObject *kwds)
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 PyObject *	PyDataIOPlugin_setAutoGrabbingInterval (PyDataIOPlugin *self, PyObject *args)
static PyObject *	PyDataIOPlugin_getAutoGrabbingInterval (PyDataIOPlugin *self)
static PyObject *	PyDataIOPlugin_connect (PyDataIOPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyDataIOPlugin_disconnect (PyDataIOPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyDataIOPlugin_info (PyDataIOPlugin *self, PyObject *args)
static PyObject *	PyDataIOPlugin_userMutex_tryLock (PyDataIOPlugin *self, PyObject *args, PyObject *kwds)
static PyObject *	PyDataIOPlugin_userMutex_unlock (PyDataIOPlugin *self)
static void	PyDataIOPlugin_addTpDict (PyObject *tp_dict)
static void	PyActuatorPlugin_addTpDict (PyObject *tp_dict)

Static Public Attributes
static PyMemberDef	PyActuatorPlugin_members []
static PyMethodDef	PyActuatorPlugin_methods []
static PyGetSetDef	PyActuatorPlugin_getseters []
static PyTypeObject	PyActuatorPluginType
static PyModuleDef	PyActuatorPluginModule
static PyMemberDef	PyDataIOPlugin_members []
static PyMethodDef	PyDataIOPlugin_methods []
static PyTypeObject	PyDataIOPluginType
static PyModuleDef	PyDataIOPluginModule

Detailed Description

class summing up the functionality of itom - hardware python plugins

There exist three different types of plugins for the itom program:

• actuator plugins (everything that moves)
• dataIO plugins (in- and output of data, e.g. ADDA cards, frame grabber, cameras, spectrometers, ...)
• algo plugins (pure software evaluations / calculations)

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.

Member Function Documentation

PyActuatorPlugin_calib()

PyObject * ito::PythonPlugins::PyActuatorPlugin_calib ( PyActuatorPlugin * self, PyObject * args )

static

calibrate actuator axi(e)s

Parameters

[in]	self	the actuator object (python)
[in]	args	the axi(e)s numbers

Returns

status of calibration

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.

PyActuatorPlugin_dealloc()

void ito::PythonPlugins::PyActuatorPlugin_dealloc ( PyActuatorPlugin * self )

static

destructor for actuator object in python

Parameters

[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.

PyActuatorPlugin_getExecFuncsInfo()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getExecFuncsInfo ( PyActuatorPlugin * self, PyObject * args, PyObject * kwds )

static

returns the list of available parameters and additional information about the plugin ExecFunctions

Parameters

[in]

self

the actuator object (python)

Returns

a dictionary with all available parameters for this actuator

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.

PyActuatorPlugin_getExecFuncsList()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getExecFuncsList ( PyActuatorPlugin * self )

static

returns the list of available ExecFunctions' names

Parameters

[in]

self

the actuator object (python)

Returns

a list with all available parameters for this actuator

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.

PyActuatorPlugin_getParam()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getParam ( PyActuatorPlugin * self, PyObject * args )

static

gets a parameter value

Parameters

[in]	self	the actuator object (python)
[in]	args	the parameter name

Returns

the parameter value

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.

PyActuatorPlugin_getParamInfo()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getParamInfo ( PyActuatorPlugin * self, PyObject * args )

static

returns dictionary with meta information about desired parameter

Parameters

[in]	self	the actuator object (python)
[in]	args	the parameter name

Returns

an error if the parameter wasn't found

The getParamInfo method of the plugin is invoked

PyActuatorPlugin_getParamList()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getParamList ( PyActuatorPlugin * self )

static

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

Returns

a string with all available parameters for this actuator

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.

PyActuatorPlugin_getParamListInfo()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getParamListInfo ( PyActuatorPlugin * self, PyObject * args )

static

returns the list of available parameters and additional information about the plugin

Parameters

[in]

self

the actuator object (python)

Returns

a string with all available parameters for this actuator

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.

PyActuatorPlugin_getPos()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getPos ( PyActuatorPlugin * self, PyObject * args )

static

get the current position of axi(e)S

Parameters

[in]	self	the actuator object (python)
[in]	args	the axi(e)s numbers

Returns

the axi(e)s position(s)

Reads the position of the axi(e)s passed as parameter.

PyActuatorPlugin_getStatus()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getStatus ( PyActuatorPlugin * self, PyObject * args )

static

get the status of an actuator

Parameters

[in]	self	the actuator object (python)
[in]	args	the axi(e)s numbers

Returns

an error if the parameter wasn't found or the passed value is out of the limits

Returns the status of the axi(e)s passed as parameter.

PyActuatorPlugin_getType()

PyObject * ito::PythonPlugins::PyActuatorPlugin_getType ( PyActuatorPlugin * self )

static

returns the type of the actuator object

Parameters

[in]

self

the actuator object (python)

Returns

a string with the type

This method simply returns the type of the actuator object

PyActuatorPlugin_hideToolbox()

PyObject * ito::PythonPlugins::PyActuatorPlugin_hideToolbox ( PyActuatorPlugin * self )

static

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

This method simply close the widget

PyActuatorPlugin_init()

int ito::PythonPlugins::PyActuatorPlugin_init ( PyActuatorPlugin * self, PyObject * args, PyObject * kwds )

static

constructor for actuator object (plugin) accessible from python

Parameters

[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 python

Returns

-1 in case an error occurred, else 0

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 and 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

PyActuatorPlugin_name()

PyObject * ito::PythonPlugins::PyActuatorPlugin_name ( PyActuatorPlugin * self )

static

Returns the plugin's name

Parameters

[in]

self

the plugin object

Returns

the name of the plugin

                Queries the name of a plugin by invoking a getParam on the plugin for the name parameter

PyActuatorPlugin_new()

PyObject * ito::PythonPlugins::PyActuatorPlugin_new ( PyTypeObject * type, PyObject * args, PyObject * kwds )

static

constructor for actuator object in python

Parameters

[in]

type

Returns

new python actuator object

Creates a new pythonActuator object. The actual actuator object (itom) is only created later.

PyActuatorPlugin_setInterrupt()

PyObject * ito::PythonPlugins::PyActuatorPlugin_setInterrupt ( PyActuatorPlugin * self )

static

sets the interrupt flag of the actuator in order to interrupt a movement

PyActuatorPlugin_setOrigin()

PyObject * ito::PythonPlugins::PyActuatorPlugin_setOrigin ( PyActuatorPlugin * self, PyObject * args )

static

set the origin of axi(e)s

Parameters

[in]	self	the actuator object (python)
[in]	args	the axi(e)s

Returns

status of setOrigin

The axi(e)s current position is set as new origin of the axi(e)s.

PyActuatorPlugin_setParam()

PyObject * ito::PythonPlugins::PyActuatorPlugin_setParam ( PyActuatorPlugin * self, PyObject * args )

static

set a parameter to a new value

Parameters

[in]	self	the actuator object (python)
[in]	args	the parameter name and new value

Returns

an error if the parameter wasn't found or the passed value is out of the limits

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.

PyActuatorPlugin_setPosAbs()

PyObject * ito::PythonPlugins::PyActuatorPlugin_setPosAbs ( PyActuatorPlugin * self, PyObject * args )

static

set actuator axi(e)s to new absolute position(s)

Parameters

[in]	self	the actuator object (python)
[in]	args	the axi(e)s numbers

Returns

status of positioning command

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.

PyActuatorPlugin_setPosRel()

PyObject * ito::PythonPlugins::PyActuatorPlugin_setPosRel ( PyActuatorPlugin * self, PyObject * args )

static

set actuator axi(e)s to new relative position(s)

Parameters

[in]	self	the actuator object (python)
[in]	args	the axi(e)s numbers

Returns

status of positioning command

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.

PyActuatorPlugin_showConfiguration()

PyObject * ito::PythonPlugins::PyActuatorPlugin_showConfiguration ( PyActuatorPlugin * self )

static

open configuration dialog

Parameters

[in]

self

the actuator object (python)

This method simply open the configuration dialog

PyActuatorPlugin_showToolbox()

PyObject * ito::PythonPlugins::PyActuatorPlugin_showToolbox ( PyActuatorPlugin * self )

static

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

This method simply open the widget

PyDataIOPlugin_acquire()

PyObject * ito::PythonPlugins::PyDataIOPlugin_acquire ( PyDataIOPlugin * self, PyObject * args )

static

acquire data with a dataIO device

Parameters

[in]	self	the dataIO object (python)
[in]	args	number of acquisitions

Returns

an error if no data could be acquired

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.

PyDataIOPlugin_copyVal()

PyObject * ito::PythonPlugins::PyDataIOPlugin_copyVal ( PyDataIOPlugin * self, PyObject * args )

static

copy values from a dataIO device to an existing dataObject

Parameters

[in]	self	the dataIO object (python)
[in]	args	input buffer

Returns

an error if no data could be retrieved

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.

PyDataIOPlugin_dealloc()

void ito::PythonPlugins::PyDataIOPlugin_dealloc ( PyDataIOPlugin * self )

static

destructor for dataIO object in python

Parameters

[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.

PyDataIOPlugin_disableAutoGrabbing()

PyObject * ito::PythonPlugins::PyDataIOPlugin_disableAutoGrabbing ( PyDataIOPlugin * self, PyObject * args )

static

disable timer triggered autograbbing of a dataIO device

Parameters

[in]	self	the dataIO object (python)
[in]	args	empty

Returns

an error if autograbbing could not be stopped

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.

PyDataIOPlugin_enableAutoGrabbing()

PyObject * ito::PythonPlugins::PyDataIOPlugin_enableAutoGrabbing ( PyDataIOPlugin * self, PyObject * args )

static

enable timer triggered autograbbing of a dataIO device

Parameters

[in]	self	the dataIO object (python)
[in]	args	empty

Returns

an error if autograbbing is not possible

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).

PyDataIOPlugin_getAutoGrabbing()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getAutoGrabbing ( PyDataIOPlugin * self, PyObject * args )

static

return the status of the autograbbing

Parameters

[in]	self	the dataIO object (python)
[in]	args	empty

Returns

the status of the autograbbing

This method simply returns the status of the autograbbing.

PyDataIOPlugin_getExecFuncsInfo()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getExecFuncsInfo ( PyDataIOPlugin * self, PyObject * args, PyObject * kwds )

static

returns the list of available parameters and additional information about the plugin ExecFunctions

Parameters

[in]

self

the actuator object (python)

Returns

a dictionary with all available parameters for this actuator

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.

PyDataIOPlugin_getExecFuncsList()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getExecFuncsList ( PyActuatorPlugin * self )

static

returns the list of available ExecFunctions' names

Parameters

[in]

self

the actuator object (python)

Returns

a List with all available parameters for this actuator

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.

PyDataIOPlugin_getParam()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getParam ( PyDataIOPlugin * self, PyObject * args )

static

return a parameter value

Parameters

[in]	self	the addIn whose parameter is requested
[in]	args	the parameter name

Returns

python object with the parameter value on success (parameter exists), NULL otherwise

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.

PyDataIOPlugin_getParamInfo()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getParamInfo ( PyDataIOPlugin * self, PyObject * args )

static

returns dictionary with meta information about desired parameter

Parameters

[in]	self	the actuator object (python)
[in]	args	the parameter name

Returns

an error if the parameter wasn't found

The getParamInfo method of the plugin is invoked

PyDataIOPlugin_getParamList()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getParamList ( PyDataIOPlugin * self )

static

returns the list of available parameters

Parameters

[in]

self

the dataIO object (python)

Returns

a string with all available parameters for this dataIO

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.

PyDataIOPlugin_getParamListInfo()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getParamListInfo ( PyDataIOPlugin * self, PyObject * args )

static

returns the list of available parameters and additional information about the plugin

Parameters

[in]

self

the dataIO object (python)

Returns

a string with all available parameters for this dataIO

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.

PyDataIOPlugin_getType()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getType ( PyDataIOPlugin * self )

static

returns the type of the dataIO object

Parameters

[in]

self

the dataIO object (python)

Returns

a string with the type

This method simply returns the type of the dataIO object

PyDataIOPlugin_getVal()

PyObject * ito::PythonPlugins::PyDataIOPlugin_getVal ( PyDataIOPlugin * self, PyObject * args )

static

get values from a dataIO device

Parameters

[in]	self	the dataIO object (python)
[in]	args	input buffer

Returns

an error if no data could be retrieved

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.

PyDataIOPlugin_hideToolbox()

PyObject * ito::PythonPlugins::PyDataIOPlugin_hideToolbox ( PyDataIOPlugin * self )

static

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

This method simply close the widget

PyDataIOPlugin_init()

int ito::PythonPlugins::PyDataIOPlugin_init ( PyDataIOPlugin * self, PyObject * args, PyObject * kwds )

static

constructor for dataIO object

Parameters

[in]	self	the according dataIO object
[in]	args	unnamed arguments passed to the constructor in python

Returns

-1 in case an error occurred, else 0

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

PyDataIOPlugin_name()

PyObject * ito::PythonPlugins::PyDataIOPlugin_name ( PyDataIOPlugin * self )

static

Returns the plugin's name

Parameters

[in]

self

the plugin object

Returns

the name of the plugin

                Queries the name of a plugin by invoking a getParam on the plugin for the name parameter

PyDataIOPlugin_new()

PyObject * ito::PythonPlugins::PyDataIOPlugin_new ( PyTypeObject * type, PyObject * args, PyObject * kwds )

static

constructor for dataIO object in python

Parameters

[in]

type

Returns

new python dataIO object

Creates a new pythonDataIO object. The actual dataIO object (itom) is only created later.

PyDataIOPlugin_setParam()

PyObject * ito::PythonPlugins::PyDataIOPlugin_setParam ( PyDataIOPlugin * self, PyObject * args )

static

set a parameter to a new value

Parameters

[in]	self	the actuator object (python)
[in]	args	the parameter name and new value

Returns

an error if the parameter wasn't found or the passed value is out of the limits

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.

PyDataIOPlugin_setVal()

PyObject * ito::PythonPlugins::PyDataIOPlugin_setVal ( PyDataIOPlugin * self, PyObject * args, PyObject * kwds )

static

write values to a dataIO device

Parameters

[in]	self	the dataIO object (python)
[in]	args	output buffer

Returns

an error if no data could be retrieved

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.

PyDataIOPlugin_showConfiguration()

PyObject * ito::PythonPlugins::PyDataIOPlugin_showConfiguration ( PyDataIOPlugin * self )

static

open configuration dialog

Parameters

[in]

self

the actuator object (python)

This method simply open the configuration dialog

PyDataIOPlugin_showToolbox()

PyObject * ito::PythonPlugins::PyDataIOPlugin_showToolbox ( PyDataIOPlugin * self )

static

returns the list of available parameters

Parameters

[in]

self

the actuator object (python)

This method simply open the widget

PyDataIOPlugin_startDevice()

PyObject * ito::PythonPlugins::PyDataIOPlugin_startDevice ( PyDataIOPlugin * self, PyObject * args )

static

start a dataIO device, i.e. prepare it for recording data

Parameters

[in]	self	the dataIO object (python)
[in]	args	should be empty

Returns

an error if the device could not be started

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.

PyDataIOPlugin_stop()

PyObject * ito::PythonPlugins::PyDataIOPlugin_stop ( PyDataIOPlugin * self )

static

stop continuous acquisiiton with a dataIO device

Parameters

[in]

self

the dataIO object (python)

Returns

an error if no data could be acquired

PyDataIOPlugin_stopDevice()

PyObject * ito::PythonPlugins::PyDataIOPlugin_stopDevice ( PyDataIOPlugin * self, PyObject * args )

static

stop a dataIO device

Parameters

[in]	self	the dataIO object (python)QString
[in]	args	should be empty

Returns

an error if the device could not be stopped

Stop a dataIO device, i.e. it is no longer possible to acquire data with it. See also PyDataIOPlugin_startDevice

Member Data Documentation

PyActuatorPlugin_getseters

PyGetSetDef ito::PythonPlugins::PyActuatorPlugin_getseters

static

Initial value:

= {
    {"currentStatus",   (getter)PyActuatorPlugin_getCurrentStatus,    (setter)NULL, pyActuatorGetCurrentStatus_doc, NULL },
    {"currentPositions", (getter)PyActuatorPlugin_getCurrentPositions,  (setter)NULL, pyActuatorGetCurrentPositions_doc, NULL },
    {"targetPositions",  (getter)PyActuatorPlugin_getTargetPositions,   (setter)NULL, pyActuatorGetTargetPositions_doc, NULL},
    {NULL}  
}

PyActuatorPlugin_members

PyMemberDef ito::PythonPlugins::PyActuatorPlugin_members

static

Initial value:

= {
    {NULL}  
}

PyActuatorPlugin_methods

PyMethodDef ito::PythonPlugins::PyActuatorPlugin_methods

static

Initial value:

= {
   {"getParamList", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParamList, METH_NOARGS, pyPluginGetParamList_doc},
   {"getParamInfo", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParamInfo, METH_VARARGS, pyPluginGetParamInfo_doc},
   {"getParamListInfo", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParamListInfo, METH_VARARGS, pyPluginGetParamListInfo_doc},
   {"getExecFuncsList", (PyCFunction)PythonPlugins::PyActuatorPlugin_getExecFuncsList, METH_NOARGS, pyPluginGetExecFuncsList_doc},
   {"getExecFuncsInfo", (PyCFunction)PythonPlugins::PyActuatorPlugin_getExecFuncsInfo, METH_VARARGS | METH_KEYWORDS, pyPlugInGetExecFuncsInfo_doc},
   {"name", (PyCFunction)PythonPlugins::PyActuatorPlugin_name, METH_NOARGS, pyPluginName_doc},
   {"getParam", (PyCFunction)PythonPlugins::PyActuatorPlugin_getParam, METH_VARARGS, pyPluginGetParam_doc},
   {"setParam", (PyCFunction)PythonPlugins::PyActuatorPlugin_setParam, METH_VARARGS, pyPluginSetParam_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, PyPlugin_execFunc_doc},
   {"showConfiguration", (PyCFunction)PythonPlugins::PyActuatorPlugin_showConfiguration, METH_NOARGS, pyPluginShowConfiguration_doc},
   {"showToolbox", (PyCFunction)PythonPlugins::PyActuatorPlugin_showToolbox, METH_NOARGS, pyPluginShowToolbox_doc},
   {"hideToolbox", (PyCFunction)PythonPlugins::PyActuatorPlugin_hideToolbox, METH_NOARGS, pyPluginHideToolbox_doc},
   {"setInterrupt", (PyCFunction)PythonPlugins::PyActuatorPlugin_setInterrupt, METH_NOARGS, pyActuatorSetInterrupt_doc},
   {"connect", (PyCFunction)PythonPlugins::PyActuatorPlugin_connect, METH_VARARGS | METH_KEYWORDS, pyActuatorConnect_doc},
   {"disconnect", (PyCFunction)PythonPlugins::PyActuatorPlugin_disconnect, METH_VARARGS | METH_KEYWORDS, pyActuatorDisconnect_doc},
   {"info",(PyCFunction)PythonPlugins::PyActuatorPlugin_info, METH_VARARGS, pyActuatorInfo_doc},
   {"userMutexTryLock", (PyCFunction)PythonPlugins::PyActuatorPlugin_userMutex_tryLock, METH_VARARGS | METH_KEYWORDS, PyPlugin_userMutex_tryLock_doc },
   {"userMutexUnlock", (PyCFunction)PythonPlugins::PyActuatorPlugin_userMutex_unlock, METH_NOARGS, PyPlugin_userMutex_unlock_doc },
   {NULL}  
}

PyActuatorPluginModule

PyModuleDef ito::PythonPlugins::PyActuatorPluginModule

static

Initial value:

= {
   PyModuleDef_HEAD_INIT,
   "actuator",
   QObject::tr("Itom actuator plugin object").toLatin1().data(),
   -1,
   NULL, NULL, NULL, NULL, NULL
}

PyDataIOPlugin_members

PyMemberDef ito::PythonPlugins::PyDataIOPlugin_members

static

Initial value:

= {
    {NULL}  
}

PyDataIOPluginModule

PyModuleDef ito::PythonPlugins::PyDataIOPluginModule

static

Initial value:

= {
   PyModuleDef_HEAD_INIT,
   "dataIO",
   QObject::tr("Itom dataIO plugin object").toLatin1().data(),
   -1,
   NULL, NULL, NULL, NULL, NULL
}

---

The documentation for this class was generated from the following files:

• C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/Qitom/python/pythonPlugins.h
• C:/Workspace/itom_development_VS2019_Qt5.15.2_x64/itomProject/itom/Qitom/python/pythonPlugins.cpp