esys.escript.timeseries.TimeSeriesBaseDataset

Package esys :: Package escript :: Module timeseries :: Class TimeSeriesBaseDataset

[show private | hide private]

Class TimeSeriesBaseDataset

TimeSeriesBase --+
                 |
                TimeSeriesBaseDataset

Known Subclasses:: TimeSeries, TimeSeriesBaseBuffer

provides an interface for accessing a set of linearly ordered data.

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

getitem(self, index)
(Indexing operator)

returns the datum index

len(self)
(Length operator)

needed to handle negative indexing in slicing

append(self, values)

appends data to the buffer. If the buffer would be full the buffer is rearranged before the data are appended (to be overwritten by subclass)

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=0)

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)

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

http://epydoc.sf.net