Package PyFoam :: Package Basics :: Module TimeLineCollection :: Class TimeLineCollection
[show private | hide private]
[frames | no frames]

Class TimeLineCollection


Method Summary
  __init__(self, deflt, extendCopy, splitThres, splitFun)
  getTimes(self)
Return a list of the time values
  getValueNames(self)
Return a list with the names of the safed values
  getValues(self, name)
Gets a timeline
  nr(self)
Number of elements in timelines
  setDefault(self, deflt)
  setExtend(self, mode)
  setSplitting(self, splitThres, splitFun)
Sets the parameters for splitting
  setTime(self, time)
Sets the time.
  setValue(self, name, value)
Sets the value of the last element in a timeline
  split(self, array, func)
Makes the array smaller by joining every two points

Method Details

__init__(self, deflt=0.0, extendCopy=False, splitThres=None, splitFun=None)
(Constructor)

Parameters:
deflt - default value for timelines if none has been defined before
extendCopy - Extends the timeline by cpying the last element
splitThres - Threshold after which the number of points is halved
splitFun - Function that is used for halving. If none is specified the mean function is used

getTimes(self)

Returns:
A list of the time values

getValueNames(self)

Returns:
A list with the names of the safed values

getValues(self, name)

Gets a timeline
Parameters:
name - Name of the timeline
Returns:
List with the values

nr(self)

Number of elements in timelines

setDefault(self, deflt)

Parameters:
deflt - default value to be used

setExtend(self, mode)

Parameters:
mode - whether or not to extend the timeline by copying or setting the default value

setSplitting(self, splitThres=None, splitFun=None)

Sets the parameters for splitting

setTime(self, time)

Sets the time. If time is new all the timelines are extended
Parameters:
time - the new current time

setValue(self, name, value)

Sets the value of the last element in a timeline
Parameters:
name - name of the timeline
value - the last element

split(self, array, func)

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

Generated by Epydoc 2.1 on Mon Jan 22 23:52:48 2007 http://epydoc.sf.net