esys.escript.timeseries.TimeSeriesOperator

Package esys :: Package escript :: Module timeseries :: Class TimeSeriesOperator

[show private | hide private]

Class TimeSeriesOperator

     TimeSeriesBase --+    
                      |    
TimeSeriesControlerView --+
                          |
                         TimeSeriesOperator

Known Subclasses:: Plotter, TimeSeriesFilter, Writer

a TimeSeriesOperator decribes an operation acting on list of TimeSeries time_series_args. It allows to update its output (if there is any) through the update method which is overwritten by a particular implementation of the class. The update method is called to process the data [start:end] using [start-left_wing_size:end+right_wing_size] of its arguments

Method Summary
	`__init__(self, controler, time_series_args, left_wing_size, right_wing_size, debug, description)`
	`__del__(self)`
	`flush(self)` calls the update method with all the maximum processable range.
	`getArgumentDataset(self, index)` returns the dataset of in the argument with index index
	`getArguments(self, index)` returns the list of arguments or, index is present, the argument with index index.
	`getControler(self)` returns the Controler updating the TimeSeriesOperator
	`getLeftWingSize(self)` returns the left wing size
	`getRightWingSize(self)` returns the right wing size
	`update(self, start, end)` updates the the data [start:end] using [start-left_wing_size:end+right_wing_size] of its arguments (is overwritten by a particular TimeSeriesOperator)
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)

calls the update method with all the maximum processable range. It also updates the id of unused datum for all arguments

getArgumentDataset(self, index)

returns the dataset of in the argument with index index

getArguments(self, index=None)

returns the list of arguments or, index is present, the argument with index index. In the latter case None is returned if no arguments are present

getControler(self)

returns the Controler updating the TimeSeriesOperator

getLeftWingSize(self)

returns the left wing size

getRightWingSize(self)

returns the right wing size

update(self, start, end)

updates the the data [start:end] using [start-left_wing_size:end+right_wing_size] of its arguments (is overwritten by a particular TimeSeriesOperator)

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

http://epydoc.sf.net