indiclient.indielement

Module indiclient :: Class indielement

[show private | hide private]

Class indielement

 indiobject --+    
              |    
indinamedobject --+
                  |
                 indielement

Known Subclasses:: indiblob, indilight, indinumber, indiswitch, inditext

The Base Class of any element of an INDI Vector

Method Summary
	`__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
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

init(self, attrs, tag)
(Constructor)

Parameters:: attrs - The attributes of the XML version of the INDI object.
(type=DictType); tag - The XML tag of the object (see indixmltag).
(type=indixmltag)

Overrides:: indiclient.indinamedobject.__init__ (inherited documentation)

get_text(self)

Returns:: a string representation of it value
(type=StringType)

get_xml(self, transfertype)

Returns an XML representation of the object

Parameters:: transfertype - The inditransfertype for which the XML code shall be generated
(type={inditransfertype})

Returns:: an XML representation of the object
(type=StringType)

Overrides:: indiclient.indiobject.get_xml (inherited documentation)

set_float(self, num)

Parameters:: num - The new value to be set.
(type=FloatType)

Returns:: None
(type=NoneType)

set_text(self, text)

Parameters:: text - A string representation of the data to be written into the object.
(type=StringType)

Returns:: None
(type=NoneType)

tell(self)

Prints all parameters of the object

Returns:: None
(type=NoneType)

_get_changed(self)

Returns:: True if the objects XML data was changed since the last _get_changed was called, False otherwise.
(type=BooleanType)

_set_value(self, value)

Sets the value variable of this object.

Parameters:: value - A string to be copied into the _value.
(type=DictType)

Returns:: None
(type=NoneType)

Instance Variable Details

_old_value

The old value of the object, the value it had when _get_changed was called last time.

Type:: StringType

_value

The value of the INDI object. Meaning character contained between the end of the StartElement and the beginning of the EndElement in XML version. This may be coded in another format or compressed and thus require some manipulation before it can be used.

Type:: StringType

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

http://epydoc.sf.net