TwiceAsNice  2019-02-18
Public Member Functions | Private Attributes | List of all members
indiclient.indiswitch Class Reference
Inheritance diagram for indiclient.indiswitch:
Inheritance graph
Collaboration diagram for indiclient.indiswitch:
Collaboration graph

Public Member Functions

def get_active (self)
 
def set_active (self, bool)
 
- Public Member Functions inherited from indiclient.indielement
def __init__ (self, attrs, tag)
 
def set_float (self, num)
 
def tell (self)
 
def get_text (self)
 
def set_text (self, text)
 
def get_xml (self, transfertype)
 
def updateByElement (self, element)
 
- 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)
 

Private Attributes

 _value
 

Additional Inherited Members

- Public Attributes inherited from indiclient.indinamedobject
 name
 
 label
 
- Public Attributes inherited from indiclient.indiobject
 tag
 

Detailed Description

a switch that can be either C{On} or C{Off}

Member Function Documentation

◆ get_active()

def indiclient.indiswitch.get_active (   self)
@return: a Boolean representing the state of the switch:
    - True (I{Python}) = C{"On"} (I{INDI})
    - False (I{Python}) = C{"Off"} (I{INDI})
@rtype: BooleanType 

◆ set_active()

def indiclient.indiswitch.set_active (   self,
  bool 
)
@param bool: The boolean representation of the new state of the switch.
    - True (I{Python}) = C{"On"} (I{INDI})
    - False (I{Python}) = C{"Off"} (I{INDI})
@type bool: BooleanType:
@return: B{None}
@rtype: NoneType

Member Data Documentation

◆ _value

indiclient.indiswitch._value
private

The documentation for this class was generated from the following file: