esys.escript.timeseries.TimeSeries

Package esys :: Package escript :: Module timeseries :: Class TimeSeries

[show private | hide private]

Class TimeSeries

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

Known Subclasses:: Controler, DataCatcher, TimeSeriesFilter, TimeSeriesShift

makes TimeSeriesBaseDataset look like a TimeSeries and introduces operations Any implementation of a TimeSeriesControlerView must provide the getControler method which returns the controler

Method Summary
	`__init__(self, dataset, debug, description)`
	`__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

getDataset(self)

returns the TimeSeriesBaseDataset of the time series

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

http://epydoc.sf.net