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

Public Member Functions

def __init__ (self, attrs, tag)
 
def is_ok (self)
 
def is_busy (self)
 
def is_idle (self)
 
def is_alert (self)
 
def set_text (self, text)
 
def update (self, attrs, tag)
 
- 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 Member Functions

def _set_value (self, value)
 

Private Attributes

 _value
 

Additional Inherited Members

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

Detailed Description

a status light
@ivar _value : The overall operating state of the device. possible values are:
    - C{Idle} (device is currently not connected or unreachable)
    - C{Ok} (device is ready to do something) 
    - C{Busy} (device is currently busy doing something, and not ready to do anything else)
    - C{Alert} (device is responding, but at least one function does not work at the moment)
@type _value : StringType

Constructor & Destructor Documentation

◆ __init__()

def indiclient.indilight.__init__ (   self,
  attrs,
  tag 
)

Member Function Documentation

◆ _set_value()

def indiclient.indilight._set_value (   self,
  value 
)
private

◆ is_alert()

def indiclient.indilight.is_alert (   self)
@return: C{True} if the light indicates the C{Alert}state (device is responding, but at least 
one function does not work at the moment) C{False} otherwise
@rtype:  BooleanType        

◆ is_busy()

def indiclient.indilight.is_busy (   self)
@return: C{True} if the light indicates the C{Busy} state (device is currently busy doing something, 
and not ready to do anything else) , C{False} otherwise
@rtype:  BooleanType        

◆ is_idle()

def indiclient.indilight.is_idle (   self)
@return: C{True} if the light indicates the C{Idle} state (device is currently not connected or unreachable)
, C{False} otherwise
@rtype:  BooleanType        

◆ is_ok()

def indiclient.indilight.is_ok (   self)
@return: C{True} if the light indicates the C{Ok} state (device is ready to do something), C{False} otherwise
@rtype:  BooleanType        

◆ set_text()

def indiclient.indilight.set_text (   self,
  text 
)

◆ update()

def indiclient.indilight.update (   self,
  attrs,
  tag 
)

Member Data Documentation

◆ _value

indiclient.indilight._value
private

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