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

Class TimeSeriesBaseDataset

TimeSeriesBase --+
                 |
                TimeSeriesBaseDataset
Known Subclasses:

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

Instance Methods [hide private]
 
__getitem__(self, index)
Returns the datum with given index.
 
__init__(self, buffer, offset=0, debug=False, description='TimeSeriesDataset')
 
__len__(self)
Needed to handle negative indexing in slicing.
 
append(self, values)
Appends data to the buffer.
 
getBaseBuffer(self)
Returns the buffer referenced by the TimeSeriesBaseDataset.
 
getBaseBufferSize(self)
Returns the size of the buffer (to be overwritten by subclasses).
 
getIdOfFirstAvailableDatum(self)
Returns the identification number of the first avaiable datum (may be overwritten by subclasses).
 
getIdOfFirstDatum(self)
Returns the identification number of the first datum (may be overwritten by subclasses).
 
getIdOfLastDatum(self)
Returns the identification number of the last datum in the data set (may be overwritten by subclasses).
 
getIdOfLastUnreferencedDatum(self)
Returns the identification number of the last datum which has been unused by all TimeSeries referring to the TimeSeriesBaseDataset (may be overwritten by subclasses).
 
getNumComponents(self)
Returns the number of components of the data (may be overwritten by subclasses).
 
getNumData(self)
Returns the number of data (not all of them are accessible).
 
getOffset(self)
Returns the offset when referring to dataset elements.
 
getOffsetInBaseBuffer(self)
Returns the offset to access elements in getBaseBuffer() (may be overwritten by subclasses).
 
isEmpty(self)
Returns True if no data are appended to buffer.
 
needsRearrangement(self, num_new_data=0)
Returns True if the buffer will be full after num_new_data values have been appended (to be overwritten by subclasses).
 
updateIdOfLastUnreferencedDatum(self, last_unreferenced_datum)
Updates the identification number of the last unused datum (to be overwritten by subclasses).

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

Method Details [hide private]

__init__(self, buffer, offset=0, debug=False, description='TimeSeriesDataset')
(Constructor)

 
Overrides: TimeSeriesBase.__init__

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 subclasses).