IoticAgent.IOT.PointValueHelper module¶
Shareable object helper classes
-
class
IoticAgent.IOT.PointValueHelper.
PointDataObjectHandler
(point, client)¶ Bases:
object
Caches metadata for a point and produces skeletal represenation of a point’s values, optionally populating it with data from a share/ask/tell. Threadsafe.
-
get_template
(data=None)¶ Get new template which represents the values of this point in a PointDataObject from the IoticAgent.IOT.Point module. If data is set (to a dictionary), use this to populate the created template.
-
-
exception
IoticAgent.IOT.PointValueHelper.
RefreshException
¶ Bases:
Exception
Raised by __refresh() to indicate metadata unsuitable for template usage.
-
class
IoticAgent.IOT.PointValueHelper.
Value
(label, type_, unit=None, description=None)¶ Bases:
object
Represent data and metadata for a single value. NOT thread safe.
-
copy
()¶
-
description
¶ Human-readable description of this value
-
label
¶ Label for this value
-
type_
¶ Value type, e.g. one of IoticAgent.Datatypes
-
unit
¶ Value unit, e.g. one of IoticAgent.Units
-
unset
¶ Whether this value instances has had data assigned to it
-
value
¶ Data for this value.
Returns: None if it hasn’t been set. To distinguish between None and and unset, check the unset property.
-