Reference

Class `ContinuousIconPlaceHolder`

Continuous sensors SVG placeholder.

Inherits from:

IconPlaceHolder

These placeholders will contain a dynamic icon to represent the value of a continuous sensor. Relevant sensors are lamp, thermometer, etc.

Info:

edit Alexis BRENON brenon.alexis+arcades@gmail.com

See also:

IconPlaceHolder

Fields

number
max_value

Maximum value of the sensor.
number
min_value

Minimum value of the sensor.

Metamethods

__init ( element, spec )
Constructor.
Parameters:
- Doc element
  XML element to parse
- table spec
  PlaceHolder's specification extracted from SVG description

Public Methods

get_random_value ()
Get a random value from the placeholder.

The value is sampled from the range [self.min_value,self.max_value].

Overrides: PlaceHolder:get_random_value

Returns:
- number A value in the range [self.min_value,self.max_value]
set_value ( value )
Change current value of the placeholder.

Overrides: PlaceHolder:set_value

Parameters:
- number value
  New value to apply
Returns:
- ContinuousIconPlaceHolder self
- boolean Is the value modified

Private Methods

_prepare_string ( element )
Initialize string and placed_values from given XML element.

Overrides: PlaceHolder._prepare_string

Parameters:
- Doc element
  XML element