Inheritance diagram for indiclient.indiswitchvector:
Collaboration diagram for indiclient.indiswitchvector:
Public Member Functions | |
| def | __init__ (self, attrs, tag) |
| def | tell (self) |
| def | set_by_elementlabel (self, elementlabel) |
| def | set_by_elementname (self, elementname) |
| def | get_active_element (self) |
| def | set_active_index (self, index) |
| def | get_active_index (self) |
 Public Member Functions inherited from indiclient.indivector | |
| def | __init__ (self, attrs, tag) |
| def | get_message (self) |
| def | tell (self) |
| def | get_light (self) |
| def | get_permissions (self) |
| def | get_element (self, elementname) |
| def | get_first_element (self) |
| def | wait_for_ok_timeout (self, timeout) |
| def | wait_for_ok (self) |
| def | update (self, attrs, tag) |
| def | get_xml (self, transfertype) |
| def | updateByVector (self, vector) |
| def | getDevice (self) |
| Public Member Functions inherited from indiclient.indinamedobject | |
| def | __init__ (self, attrs, tag) |
| def | getName (self) |
| Public Member Functions inherited from indiclient.indiobject | |
| def | __init__ (self, attrs, tag) |
| def | is_valid (self) |
| def | get_xml (self, transfertype) |
| def | update (self, attrs, tag) |
Public Attributes | |
| rule | |
| Public Attributes inherited from indiclient.indivector | |
| device | |
| timestamp | |
| timeout | |
| group | |
| elements | |
| port | |
| host | |
| Public Attributes inherited from indiclient.indinamedobject | |
| name | |
| label | |
| Public Attributes inherited from indiclient.indiobject | |
| tag | |
Detailed Description
a vector of switches \n
@ivar rule: A rule defining which states of switches of the vector are allowed. possible values are:
- C{OneOfMany} Exactly one of the switches in the vector has to be C{On} all others have to be C{Off}
- C{AtMostOne} At most one of the switches in the vector can to be C{On} all others have to be C{Off}
- C{AnyOfMany} Any switch in the vector may have any state
@type rule: StringType
Constructor & Destructor Documentation
◆ __init__()
| def indiclient.indiswitchvector.__init__ | ( | self, | |
| attrs, | |||
| tag | |||
| ) |
Member Function Documentation
◆ get_active_element()
| def indiclient.indiswitchvector.get_active_element | ( | self | ) |
@return: The first active (C{On}) element, B{None} if there is none
@rtype: L{indiswitch}
◆ get_active_index()
| def indiclient.indiswitchvector.get_active_index | ( | self | ) |
@return: the index of the first switch in the Vector that is C{On}
@rtype: IntType
◆ set_active_index()
| def indiclient.indiswitchvector.set_active_index | ( | self, | |
| index | |||
| ) |
Turns the switch with index L{index} to C{On} and all other switches of this vector to C{Off}.
@param index: the index of the switch to turned C{On} exclusively
@type index: IntType
@return: B{None}
@rtype: NoneType
◆ set_by_elementlabel()
| def indiclient.indiswitchvector.set_by_elementlabel | ( | self, | |
| elementlabel | |||
| ) |
Sets all L{indiswitch} elements of this vector to C{Off}. And sets the one who's label property matches L{elementlabel}
to C{On} . If no matching one is found or at least two matching ones are found, nothing is done.
@param elementlabel: The INDI Label of the Switch to be set to C{On}
@type elementlabel: StringType
@return: B{None}
@rtype: NoneType
◆ set_by_elementname()
| def indiclient.indiswitchvector.set_by_elementname | ( | self, | |
| elementname | |||
| ) |
Sets all L{indiswitch} elements of this vector to C{Off}. And sets the one who's label property matches L{elementname}
to C{On}. If no matching one is found or at least two matching ones are found, nothing is done.
@param elementname: The INDI Name of the Switch to be set to C{On}
@type elementname: StringType
@return: B{None}
@rtype: NoneType
◆ tell()
| def indiclient.indiswitchvector.tell | ( | self | ) |
Member Data Documentation
◆ rule
| indiclient.indiswitchvector.rule |
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
