Package esys :: Package escript :: Module timeseries :: Class TimeSeriesOperator
[hide private]
[frames] | no frames]

Class TimeSeriesOperator

     TimeSeriesBase --+    
                      |    
TimeSeriesControlerView --+
                          |
                         TimeSeriesOperator
Known Subclasses:

A TimeSeriesOperator decribes an operation acting on a 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.

Instance Methods [hide private]
 
__del__(self)
 
__init__(self, controler, time_series_args=[], left_wing_size=0, right_wing_size=0, debug=False, description='TimeSeriesOperator')
 
flush(self)
Calls the update method with the maximum processable range.
 
getArgumentDataset(self, index)
Returns the dataset of the argument with given index.
 
getArguments(self, index=None)
Returns the list of arguments or, if index is present, the argument with given 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 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, updateIdOfLastProcessedDatum

Inherited from TimeSeriesBase: __str__, debug, setDebug, setDebugOff, setDebugOn, setDescription

Method Details [hide private]

__init__(self, controler, time_series_args=[], left_wing_size=0, right_wing_size=0, debug=False, description='TimeSeriesOperator')
(Constructor)

 
Overrides: TimeSeriesBase.__init__

flush(self)

 

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

getArguments(self, index=None)

 

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