indiclient.indinumber

Module indiclient :: Class indinumber

[show private | hide private]

Class indinumber

 indiobject --+        
              |        
indinamedobject --+    
                  |    
        indielement --+
                      |
                     indinumber

A floating point number with a defined format

Method Summary
	`__init__(self, attrs, tag)`
IntType	`get_digits_after_point(self)` Return the number of digits after the decimal point in the string representation of the number.
FloatType	`get_float(self)` Return a float representation of it value
IntType	`get_int(self)` Return an integer representation of it value
FloatType	`get_max(self)` Return the highest possible value for this object
FloatType	`get_min(self)` Return the smallest possible value for this object
IntType	`get_number_of_steps(self)` Return the number of steps between min and max, 0 if `is_range`==False
FloatType	`get_range(self)` Return `get_max`-`get_min`
FloatType	`get_step(self)` Return the stepsize
StringType	`get_text(self)` Return a formated string representation of it value
FloatType	`is_range(self)` Return `True` if (`get_step`>0) and (`get_range`>0) , `False` otherwise.
BooleanType	`is_sexagesimal(self)` Return `True` if the format property requires sexagesimal display
NoneType	`set_float(self, num)` Return None
NoneType	`set_text(self, text)` Return None
Inherited from indielement
StringType	`get_xml(self, transfertype)` Returns an XML representation of the object
NoneType	`tell(self)` Prints all parameters of the object
Inherited from indiobject
BooleanType	`is_valid(self)` Checks whether the object is valid.
NoneType	`update(self, attrs, tag)` Update this element with data received form the XML Parser.

Instance Variable Summary
StringType	`format`: A format string describing the way the number is displayed
Inherited from indinamedobject
StringType	`label`: label of the INDI object as given in the "label" XML attribute
StringType	`name`: name of the INDI object as given in the "name" XML attribute
Inherited from indiobject
`indixmltag`	`tag`: The XML tag of the INDI object (see `indixmltag`).

Method Details

init(self, attrs, tag)
(Constructor)

Parameters:: attrs - The attributes of the XML version of the INDI object.
(type=DictType); tag - The XML tag of the object (see indixmltag).
(type=indixmltag)

Overrides:: indiclient.indielement.__init__ (inherited documentation)

get_digits_after_point(self)

Returns:: The number of digits after the decimal point in the string representation of the number.
(type=IntType)

get_float(self)

Returns:: a float representation of it value
(type=FloatType)

get_int(self)

Returns:: an integer representation of it value
(type=IntType)

get_max(self)

Returns:: The highest possible value for this object
(type=FloatType)

get_min(self)

Returns:: The smallest possible value for this object
(type=FloatType)

get_number_of_steps(self)

Returns:: The number of steps between min and max, 0 if is_range==False
(type=IntType)

get_range(self)

Returns:: get_max-get_min
(type=FloatType)

get_step(self)

Returns:: The stepsize
(type=FloatType)

get_text(self)

Returns:: a formated string representation of it value
(type=StringType)

Overrides:: indiclient.indielement.get_text

is_range(self)

Returns:: True if (get_step>0) and (get_range>0) , False otherwise.
(type=FloatType)

is_sexagesimal(self)

Returns:: True if the format property requires sexagesimal display
(type=BooleanType)

set_float(self, num)

Parameters:: num - The new value to be set.
(type=FloatType)

Returns:: None
(type=NoneType)

Overrides:: indiclient.indielement.set_float

set_text(self, text)

Parameters:: text - A string representing the the new value to be set. Sexagesimal format is also supported
(type=StringType)

Returns:: None
(type=NoneType)

Overrides:: indiclient.indielement.set_text

Instance Variable Details

format

A format string describing the way the number is displayed

Type:: StringType

Generated by Epydoc 2.1 on Sat Sep 10 10:26:04 2005

http://epydoc.sf.net