esys.escript.timeseries.Controler

Package esys :: Package escript :: Module timeseries :: Class Controler

[show private | hide private]

Class Controler

     TimeSeriesBase --+        
                      |        
  TimeSeriesBaseDataset --+    
                          |    
     TimeSeriesBase --+   |    
                      |   |    
TimeSeriesControlerView --+    
                          |    
                 TimeSeries --+
                              |
                             Controler

controls a set of TimeSeries

Method Summary
	`__init__(self, buffer_size, debug, description)`
	`__del__(self)`
	`appendOperatorToUpdateList(self, time_serie)`
	`flush(self)` flushes all dependend TimeSeriesFilters by processing their flush method
	`getControler(self)` returns the Controler of the time series (overwrites method of by TimeSeries)
	`needsFlushing(self)` returns true if the depending TimeSeriesFilters needs to be flushed becuase the time nodes buffer is full or because of the set flush rate
	`nextTime(self, value)`
	`removeOperatorFromUpdateList(self, time_serie)`
	`setFlushRate(self, rate)` set the flush rate, i.e.
Inherited from TimeSeries
	`__add__(self, arg)`
	`__div__(self, arg)`
	`__lshift__(self, arg)`
	`__mul__(self, arg)`
	`__neg__(self)`
	`__pos__(self)`
	`__pow__(self, arg)`
	`__radd__(self, arg)`
	`__rdiv__(self, arg)`
	`__rmul__(self, arg)`
	`__rpow__(self, arg)`
	`__rshift__(self, arg)`
	`__rsub__(self, arg)`
	`__sub__(self, arg)`
	`getDataset(self)` returns the TimeSeriesBaseDataset of the time series
Inherited from TimeSeriesBaseDataset
	`__getitem__(self, index)` returns the datum index
	`__len__(self)` needed to handle negative indexing in slicing
	`append(self, values)` appends data to the buffer.
	`getBaseBuffer(self)` return the buffer referenced by the TimeSeriesBaseDataset
	`getBaseBufferSize(self)` returns the size of the buffer (to be overwritten by subclass)
	`getIdOfFirstAvailableDatum(self)` returns the identification number of the first avaiable datum (may be overwritten by subclass)
	`getIdOfFirstDatum(self)` returns the identification number of the first datum (may be overwritten by subclass)
	`getIdOfLastDatum(self)` returns the identification number of the last datum in the data set (may be overwritten by subclass)
	`getIdOfLastUnreferencedDatum(self)` returns the identification number of the last datum which has been unused by all TimeSeries refering to the TimeSeriesBaseDataset (may be overwritten by subclass)
	`getNumComponents(self)` returns the number of components of the data (may be overwritten by subclass)
	`getNumData(self)` returns the number of data (not all of them are accessible)
	`getOffset(self)` return the offset when referring to dataset elements
	`getOffsetInBaseBuffer(self)` returns the offset to access elements in getBaseBuffer() (may be overwritten by subclass)
	`isEmpty(self)` returns true if no data are appeneded to buffer
	`needsRearrangement(self, num_new_data)` returns True if the buffer will be full after num_new_data have been appended (to be overwritten by subclass)
	`updateIdOfLastUnreferencedDatum(self, last_unreferenced_datum)` updates the identification number of the last unused datum (to be overwritten by subclass)
Inherited from TimeSeriesControlerView
	`getIdOfLastProcessedDatum(self)`
	`updateIdOfLastProcessedDatum(self, id_last_processed_datum)`
Inherited from TimeSeriesBase
	`__str__(self)`
	`debug(self)` returns true if debug mode is on
	`setDebug(self, flag)` sets debug mode to flag
	`setDebugOff(self)` switch off degugging mode
	`setDebugOn(self)` switch on degugging mode
	`setDescription(self, text)`

Method Details

flush(self)

flushes all dependend TimeSeriesFilters by processing their flush method

getControler(self)

returns the Controler of the time series (overwrites method of by TimeSeries)

needsFlushing(self)

returns true if the depending TimeSeriesFilters needs to be flushed becuase the time nodes buffer is full or because of the set flush rate

setFlushRate(self, rate=50)

set the flush rate, i.e. after rate new time nodes have been checked in the flush method is called.

Generated by Epydoc 2.1 on Thu Apr 27 11:16:18 2006

http://epydoc.sf.net