Module indiclient :: Class indiobject
[show private | hide private]
[frames | no frames]

Class indiobject

Known Subclasses:
indimessage, indinamedobject

The Base Class for INDI objects (so anything that INDI can send or receive )
Method Summary
  __init__(self, attrs, tag)
StringType get_xml(self, transfertype)
Returns an XML representation of the object
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
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 vector (see indixmltag).
           (type=indixmltag)

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)

is_valid(self)

Checks whether the object is valid.
Returns:
True if the object is valid, False otherwise.
           (type=BooleanType)

update(self, attrs, tag)

Update this element with data received form the XML Parser.
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)
Returns:
None
           (type=NoneType)

_check_writeable(self)

Raises an exception if the object is not writable
Returns:
None
           (type=NoneType)

Instance Variable Details

tag

The XML tag of the INDI object (see indixmltag).
Type:
indixmltag

Generated by Epydoc 2.1 on Sat Sep 10 10:26:03 2005 http://epydoc.sf.net