indiclient.indiswitch

Module indiclient :: Class indiswitch

[show private | hide private]

Class indiswitch

 indiobject --+        
              |        
indinamedobject --+    
                  |    
        indielement --+
                      |
                     indiswitch

a switch that can be either On or Off

Method Summary
BooleanType	`get_active(self)` Return a Boolean representing the state of the switch:
NoneType	`set_active(self, bool)` Return None
Inherited from indielement
	`__init__(self, attrs, tag)`
StringType	`get_text(self)` Return a string representation of it value
StringType	`get_xml(self, transfertype)` Returns an XML representation of the object
NoneType	`set_float(self, num)` Return None
NoneType	`set_text(self, text)` Return None
NoneType	`tell(self)` Prints all parameters of the object
BooleanType	`_get_changed(self)` Return `True` if the objects XML data was changed since the last `_get_changed` was called, `False` otherwise.
NoneType	`_set_value(self, value)` Sets the value variable of this object.
Inherited from indiobject
BooleanType	`is_valid(self)` Checks whether the object is valid.
NoneType	`update(self, attrs, tag)` Update this element with data received form the XML Parser.
NoneType	`_check_writeable(self)` Raises an exception if the object is not writable

Instance Variable Summary
Inherited from indielement
StringType	`_old_value`: The old value of the object, the value it had when `_get_changed` was called last time.
StringType	`_value`: The value of the INDI object.
Inherited from indinamedobject
StringType	`label`: label of the INDI object as given in the "label" XML attribute
StringType	`name`: name of the INDI object as given in the "name" XML attribute
Inherited from indiobject
`indixmltag`	`tag`: The XML tag of the INDI object (see `indixmltag`).

Method Details

get_active(self)

Returns:

a Boolean representing the state of the switch:

True (Python) = "On" (INDI)
False (Python) = "Off" (INDI)

(type=BooleanType)

set_active(self, bool)

Parameters:

bool - The boolean representation of the new state of the switch.

True (Python) = "On" (INDI)
False (Python) = "Off" (INDI)

(type=BooleanType:)

Returns:: None
(type=NoneType)

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

http://epydoc.sf.net