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

Public Member Functions

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 _get_changed (self)
 
def _set_value (self, value)
 

Private Attributes

 _old_value
 
 _value
 

Additional Inherited Members

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

Detailed Description

The Base Class of any element of an INDI Vector \n
@ivar _value : The value of the INDI object. Meaning character contained between the end of the 
    I{StartElement} and the beginning of the I{EndElement} in XML version. This may be coded in another format
    or compressed  and thus require some manipulation before it can be used.
@type _value : StringType   
@ivar _old_value : The old value of the object, the value it had when L{_get_changed} was called last time.
@type _old_value : StringType       

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ _get_changed()

def indiclient.indielement._get_changed (   self)
private
@return: C{True} if the objects XML data was changed since the last L{_get_changed} was called, 
C{False} otherwise.
@rtype: BooleanType

◆ _set_value()

def indiclient.indielement._set_value (   self,
  value 
)
private
Sets the value variable of this object.
@param value: A string to be copied into the L{_value}.
@type value: DictType
@return: B{None}
@rtype: NoneType

◆ get_text()

def indiclient.indielement.get_text (   self)
@return: a string representation of it value
@rtype: StringType

◆ get_xml()

def indiclient.indielement.get_xml (   self,
  transfertype 
)

◆ set_float()

def indiclient.indielement.set_float (   self,
  num 
)
@param num: The new value to be set.
@type num: FloatType
@return: B{None}
@rtype: NoneType

◆ set_text()

def indiclient.indielement.set_text (   self,
  text 
)
@param text: A string representation of the data to be written into the object.
@type text: StringType
@return: B{None}
@rtype: NoneType

◆ tell()

def indiclient.indielement.tell (   self)
Prints all parameters of the object
@return: B{None}
@rtype: NoneType

◆ updateByElement()

def indiclient.indielement.updateByElement (   self,
  element 
)

Member Data Documentation

◆ _old_value

indiclient.indielement._old_value
private

◆ _value

indiclient.indielement._value
private

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