Inheritance diagram for indiclient.indixmltag:
Collaboration diagram for indiclient.indixmltag:
Public Member Functions | |
| def | __init__ (self, is_vector, is_element, is_message, index, transfertype) |
| def | get_transfertype (self) |
| def | get_index (self) |
| def | is_vector (self) |
| def | is_element (self) |
| def | is_message (self) |
| def | get_initial_tag (self) |
| def | get_xml (self, transfertype) |
| def | get_type (self) |
 Public Member Functions inherited from indiclient._indinameconventions | |
| def | __init__ (self) |
Private Attributes | |
| _is_vector | |
| _is_element | |
| _is_message | |
| _transfertype | |
| _index | |
| _basename | |
| _initial_tag | |
Additional Inherited Members | |
| Public Attributes inherited from indiclient._indinameconventions | |
| basenames | |
Detailed Description
Classifys a received INDI object by its tag. Provides functions to generate different versions of the tag for different
ways of sending it (see L{inditransfertype}).
@ivar _is_vector : C{True} if the tag denotes an L{indivector}, C{False} otherwise
@type _is_vector : BooleanType
@ivar _is_element : C{True} if the tag denotes an L{indielement}, C{False} otherwise
@type _is_element : BooleanType
@ivar _is_message : C{True} if the tag denotes an L{indimessage}, C{False} otherwise
@type _is_message : BooleanType
@ivar _transfertype : the way the object has been transferred (see L{inditransfertype}).
@type _transfertype : L{inditransfertype}
@ivar _index : The index of the basename of the object, in the L{basenames} list
@type _index : IntType
Constructor & Destructor Documentation
◆ __init__()
| def indiclient.indixmltag.__init__ | ( | self, | |
| is_vector, | |||
| is_element, | |||
| is_message, | |||
| index, | |||
| transfertype | |||
| ) |
@param is_vector : C{True} if the tag shall denote an L{indivector}, C{False} otherwise
@type is_vector : BooleanType
@param is_element : C{True} if the tag shall denote an L{indielement}, C{False} otherwise
@type is_element : BooleanType
@param is_message : C{True} if the tag shall denote an L{indimessage}, C{False} otherwise
@type is_message : BooleanType
@param transfertype : the way the object has been transferred (see L{inditransfertype}).
@type transfertype : L{inditransfertype}
@param index : The index of the basename of the object, in the L{basenames} list
@type index : IntType
Member Function Documentation
◆ get_index()
| def indiclient.indixmltag.get_index | ( | self | ) |
@return: The index of the basename of the object, in the L{basenames} list
@rtype: IntType
◆ get_initial_tag()
| def indiclient.indixmltag.get_initial_tag | ( | self | ) |
@return: A sting representing the tag specified by the parameters given to the initialiser @rtype: StringType
◆ get_transfertype()
| def indiclient.indixmltag.get_transfertype | ( | self | ) |
@return: The way the object has been transferred
@rtype: L{inditransfertype}
◆ get_type()
| def indiclient.indixmltag.get_type | ( | self | ) |
Returns a string representing the type of the object denoted by this tag (like C{TextVector} or C{Number}).
@return: a string representing the type of the object denoted by this tag (like C{TextVector} or C{Number}).
@rtype: StringType
◆ get_xml()
| def indiclient.indixmltag.get_xml | ( | self, | |
| transfertype | |||
| ) |
Returns the string the be used in the tags in the XML representation of the object
(like C{defTextVector} or C{oneSwitch} or C{newLightVector}).
@param transfertype : An object describing the way the generated XML data is going to be sent (see L{inditransfertype}).
@type transfertype : L{inditransfertype}
@return: An XML representation of the object
@rtype: StringType
◆ is_element()
| def indiclient.indixmltag.is_element | ( | self | ) |
@return: C{True}, if it denotes an element, C{False} otherwise
@rtype: BooleanType
◆ is_message()
| def indiclient.indixmltag.is_message | ( | self | ) |
@return: C{True}, if it denotes a message, C{False} otherwise
@rtype: BooleanType
◆ is_vector()
| def indiclient.indixmltag.is_vector | ( | self | ) |
@return: C{True}, if it denotes vector, C{False} otherwise
@rtype: BooleanType
Member Data Documentation
◆ _basename
|
private |
◆ _index
|
private |
◆ _initial_tag
|
private |
◆ _is_element
|
private |
◆ _is_message
|
private |
◆ _is_vector
|
private |
◆ _transfertype
|
private |
The documentation for this class was generated from the following file:
- ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/indi-duino/add-on/meteostationWEB/indiclient.py
