indiclient.indixmltag

Module indiclient :: Class indixmltag

[show private | hide private]

Class indixmltag

_indinameconventions --+
                       |
                      indixmltag

Classifys a received INDI object by its tag. Provides functions to generate different versions of the tag for different ways of sending it (see inditransfertype).

Method Summary
	`__init__(self, is_vector, is_element, is_message, index, transfertype)`
IntType	`get_index(self)` Return the index of the basename of the object, in the `basenames` list
StringType	`get_initial_tag(self)` Return a sting representing the tag specified by the parameters given to the initialiser
`inditransfertype`	`get_transfertype(self)` Return the way the object has been transferred
StringType	`get_type(self)` Returns a string representing the type of the object denoted by this tag (like `TextVector` or `Number`).
StringType	`get_xml(self, transfertype)` Returns the string the be used in the tags in the XML representation of the object (like `defTextVector` or `oneSwitch` or `newLightVector`).
BooleanType	`is_element(self)` Return `True`, if it denotes an element, `False` otherwise
BooleanType	`is_message(self)` Return `True`, if it denotes a message, `False` otherwise
BooleanType	`is_vector(self)` Return `True`, if it denotes vector, `False` otherwise

Method Details

init(self, is_vector, is_element, is_message, index, transfertype)
(Constructor)

Parameters:: is_vector - True if the tag shall denote an indivector, False otherwise
(type=BooleanType); is_element - True if the tag shall denote an indielement, False otherwise
(type=BooleanType); is_message - True if the tag shall denote an indimessage, False otherwise
(type=BooleanType); index - The index of the basename of the object, in the basenames list
(type=IntType); transfertype - the way the object has been transferred (see inditransfertype).
(type=inditransfertype)

Overrides:: indiclient._indinameconventions.__init__

get_index(self)

Returns:: The index of the basename of the object, in the basenames list
(type=IntType)

get_initial_tag(self)

Returns:: A sting representing the tag specified by the parameters given to the initialiser
(type=StringType)

get_transfertype(self)

Returns:: The way the object has been transferred
(type=inditransfertype)

get_type(self)

Returns a string representing the type of the object denoted by this tag (like TextVector or Number).

Returns:: a string representing the type of the object denoted by this tag (like TextVector or Number).
(type=StringType)

get_xml(self, transfertype)

Returns the string the be used in the tags in the XML representation of the object (like defTextVector or oneSwitch or newLightVector).

Parameters:: transfertype - An object describing the way the generated XML data is going to be sent (see inditransfertype).
(type=inditransfertype)

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

is_element(self)

Returns:: True, if it denotes an element, False otherwise
(type=BooleanType)

is_message(self)

Returns:: True, if it denotes a message, False otherwise
(type=BooleanType)

is_vector(self)

Returns:: True, if it denotes vector, False otherwise
(type=BooleanType)

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

http://epydoc.sf.net