PyFoam.Basics.TimeLineCollection module¶
Collection of array of timelines
-
class
PyFoam.Basics.TimeLineCollection.
TimeLineCollection
(deflt=nan, extendCopy=False, splitThres=None, split_fraction_unchanged=0.2, splitFun=None, noEmptyTime=True, advancedSplit=False, preloadData=None, accumulation='first', registry=None)[source]¶ Bases:
object
-
getLatestData
(structured=False)[source]¶ Return a dictionary with the latest values from all data sets
-
getValues
(name)[source]¶ Gets a timeline :param name: Name of the timeline :return: List with the values
-
possibleAccumulations
= ['first', 'last', 'min', 'max', 'average', 'sum', 'count']¶
-
resetValid
(val=False)[source]¶ Helper function that resets the information whether the last entry is valid
-
setAccumulator
(name, accu)[source]¶ Sets a special accumulator fopr a timeline :param name: Name of the timeline :param accu: Name of the accumulator
-
setExtend
(mode)[source]¶ Parameters: mode – whether or not to extend the timeline by copying or setting the default value
-
setSplitting
(splitThres=None, split_fraction_unchanged=0.2, splitFun=None, advancedSplit=False, noEmptyTime=True)[source]¶ Sets the parameters for splitting
-
setTime
(time, noLock=False, forceAppend=False)[source]¶ Sets the time. If time is new all the timelines are extended :param time: the new current time :param noLock: do not acquire the lock that ensures consistent data transmission
-
-
class
PyFoam.Basics.TimeLineCollection.
TimeLinesRegistry
[source]¶ Bases:
object
Collects references to TimeLineCollection objects
-
nr
= 1¶
-
prepareForTransfer
()[source]¶ Makes sure that the data about the timelines is to be transfered via XMLRPC
-