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

addCollector(collector)[source]

Adds a collector time-line-collection

addSlave(slave)[source]
getData()[source]

Return the whole current data as a SpreadsheetData-object

getLatestData(structured=False)[source]

Return a dictionary with the latest values from all data sets

getTimes(name=None)[source]
Returns:A list of the time values
getValueNames()[source]
Returns:A list with the names of the safed values
getValues(name)[source]

Gets a timeline :param name: Name of the timeline :return: List with the values

nr()[source]

Number of elements in timelines

nrValid()[source]

Helper function that gets the number of valid 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

setDefault(deflt)[source]
Parameters:deflt – default value to be used
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

setValue(name, value)[source]

Sets the value of the last element in a timeline :param name: name of the timeline :param value: the last element

split(array, func)[source]

Makes the array smaller by joining every two points :param array: the field to split :param func: The function to use for joining two points

class PyFoam.Basics.TimeLineCollection.TimeLinesRegistry[source]

Bases: object

Collects references to TimeLineCollection objects

add(line, nr=None)[source]
clear()[source]
get(nr)[source]
nr = 1
prepareForTransfer()[source]

Makes sure that the data about the timelines is to be transfered via XMLRPC

resolveCollectors()[source]

Looks through all the registered lines and replaces integers with the actual registered line

resolveSlaves()[source]
PyFoam.Basics.TimeLineCollection.allLines()[source]
PyFoam.Basics.TimeLineCollection.mean(a, b)[source]

Mean value of a and b

PyFoam.Basics.TimeLineCollection.signedMax(a, b)[source]

Absolute Maximum of a and b with the sign preserved