indiclient.indi_custom_element

Module indiclient :: Class indi_custom_element_handler

[show private | hide private]

Class indi_custom_element_handler

_blocking_indi_object_handler --+    
                                |    
          gui_indi_object_handler --+
                                    |
       indi_vector_identifier --+   |
                                |   |
          indi_element_identifier --+
                                    |
                                   indi_custom_element_handler

Known Subclasses:: mini_element_handler

A base class for a custom handler that will be called each time a specified INDI element is received. You have to write a class, inheriting from this one and to overload the on_indiobject_changed method in order to add a custom handler.

Method Summary
	`__init__(self, devicename, vectorname, elementname)`
NoneType	`configure(self, vector, element)` This hander method will be called only once.
`indielement`	`get_element(self)` Returns the `indielement` this handler is associated with.
`indivector`	`get_vector(self)` Returns the `indivector` this handler is associated with.
NoneType	`on_indiobject_changed(self, vector, element)` This hander method will be called each time the specified INDI element/vector is received.
Inherited from gui_indi_object_handler
NoneType	`on_blocked(self, *args)` The method `_blocking_on_gui_changed` is called by the GUI, in order to inform us, that a widget has changed.
NoneType	`on_gui_changed(self, args)` Important:* Implement your GUI callback here but link you GUI callback signal to {_blocking_on_gui_changed} (see `on_blocked` if you want to know why)
NoneType	`set_bidirectional(self)` installs callbacks of the GUI that will call the function `_blocking_on_gui_changed` if the user changes the the GUI object associated with this `gui_indi_object_handler` .
NoneType	`unset_bidirectional(self)` uninstalls the GUI callback installed with `set_bidirectional` (see `set_bidirectional` for details)

Instance Variable Summary
StringType	`devicename`: The name of the device this handler is associated with
StringType	`elementname`: The name of the indielement this handler is associated with
`indiclient`	`indi`: The indiclient instance calling this handler (will be set by indiclient automatically)
StringType	`type`: The type of the handler
StringType	`vectorname`: The name of the indivector this handler is associated with

Method Details

init(self, devicename, vectorname, elementname)
(Constructor)

Parameters:: devicename - The name of the device
(type=StringType); vectorname - The name of the Indivector
(type=StringType); elementname - name of the INDI element
(type=StringType)

Overrides:: indiclient._blocking_indi_object_handler.__init__

configure(self, vector, element)

This hander method will be called only once. It will be called before the on_indiobject_changed method is called for the first time. It will be called as soon as vector has been received for the first time. It can be used to do some lengthy calculations in order to set up related data structures that need to be done only once and require information from the associated indivector and indielement objects.

Parameters:: vector - A copy of the indivector that has been received.
(type=indivector); element - A copy of the indielement that has been received
(type=indielement)

Returns:: None
(type=NoneType)

Overrides:: indiclient._blocking_indi_object_handler.configure

get_element(self)

Returns the indielement this handler is associated with.

Returns:: the indielement this handler is associated with
(type=indielement)

get_vector(self)

Returns the indivector this handler is associated with.

Returns:: the indivector this handler is associated with
(type=indivector)

on_indiobject_changed(self, vector, element)

This hander method will be called each time the specified INDI element/vector is received. You have to write a class inheriting from this class and overload this function.

Parameters:: vector - A copy of the indivector that has been received.
(type=indivector); element - A copy of the indielement that has been received
(type=indielement)

Returns:: None
(type=NoneType)

Overrides:: indiclient._blocking_indi_object_handler.on_indiobject_changed

Instance Variable Details

devicename

The name of the device this handler is associated with

Type:: StringType

elementname

The name of the indielement this handler is associated with

Type:: StringType

indi

The indiclient instance calling this handler (will be set by indiclient automatically)

Type:: indiclient

type

The type of the handler

Type:: StringType

vectorname

The name of the indivector this handler is associated with

Type:: StringType

Generated by Epydoc 2.1 on Sat Sep 10 10:26:06 2005

http://epydoc.sf.net