esys.escript.timeseries.TimeSeriesBaseBuffer

Package esys :: Package escript :: Module timeseries :: Class TimeSeriesBaseBuffer

[show private | hide private]

Class TimeSeriesBaseBuffer

   TimeSeriesBase --+    
                    |    
TimeSeriesBaseDataset --+
                        |
                       TimeSeriesBaseBuffer

An inplementation of TimeSeriesBaseDataset which actually is storing data into a numarray buffer

Method Summary
	`__init__(self, buffer_size, numComponents, type, id_of_first_datum, debug, description)`
	`append(self, data)` appends data to the buffer.
	`getBaseBufferSize(self)` returns the size of the buffer
	`getIdOfFirstAvailableDatum(self)` returns the identification number of the first avaiable datum (overwrites TimeSeriesBaseDataset method)
	`getIdOfFirstDatum(self)` returns the identification number of the first datum (overwrites method from TimeSeriesBaseDataset)
	`getIdOfLastDatum(self)` returns the identification number of the last datum in the data set (overwrites method from TimeSeriesBaseDataset)
	`getIdOfLastUnreferencedDatum(self)` returns the identification number of the last datum which has been unused by all TimeSeries refering to the TimeSeriesBaseDataset (overwrites method from TimeSeriesBaseDataset)
	`getNumComponents(self)` returns the number of components of the data (overwrites TimeSeriesBaseDataset method)
	`getNumDataInBaseBuffer(self)` returns the number of data currently in the buffer
	`getOffsetInBaseBuffer(self)` returns the offset to access elements in the buffer (overwrites method from TimeSeriesBaseDataset)
	`needsRearrangement(self, num_new_data)` returns True if the buffer will be full after num_new_data have been appended
	`updateIdOfLastUnreferencedDatum(self, last_unreferenced_datum)` updates the identification number of the last unused datum (overwrites TimeSeriesBaseDataset method)
Inherited from TimeSeriesBaseDataset
	`__getitem__(self, index)` returns the datum index
	`__len__(self)` needed to handle negative indexing in slicing
	`getBaseBuffer(self)` return the buffer referenced by the TimeSeriesBaseDataset
	`getNumData(self)` returns the number of data (not all of them are accessible)
	`getOffset(self)` return the offset when referring to dataset elements
	`isEmpty(self)` returns true if no data are appeneded to buffer
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

append(self, data)

appends data to the buffer. If the buffer would be full the buffer is rearranged before the data are appended (overwrites TimeSeriesBaseDataset method)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.append

getBaseBufferSize(self)

returns the size of the buffer

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getBaseBufferSize

getIdOfFirstAvailableDatum(self)

returns the identification number of the first avaiable datum (overwrites TimeSeriesBaseDataset method)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getIdOfFirstAvailableDatum

getIdOfFirstDatum(self)

returns the identification number of the first datum (overwrites method from TimeSeriesBaseDataset)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getIdOfFirstDatum

getIdOfLastDatum(self)

returns the identification number of the last datum in the data set (overwrites method from TimeSeriesBaseDataset)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getIdOfLastDatum

getIdOfLastUnreferencedDatum(self)

returns the identification number of the last datum which has been unused by all TimeSeries refering to the TimeSeriesBaseDataset (overwrites method from TimeSeriesBaseDataset)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getIdOfLastUnreferencedDatum

getNumComponents(self)

returns the number of components of the data (overwrites TimeSeriesBaseDataset method)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getNumComponents

getNumDataInBaseBuffer(self)

returns the number of data currently in the buffer

getOffsetInBaseBuffer(self)

returns the offset to access elements in the buffer (overwrites method from TimeSeriesBaseDataset)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.getOffsetInBaseBuffer

needsRearrangement(self, num_new_data=0)

returns True if the buffer will be full after num_new_data have been appended

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.needsRearrangement

updateIdOfLastUnreferencedDatum(self, last_unreferenced_datum)

updates the identification number of the last unused datum (overwrites TimeSeriesBaseDataset method)

Overrides:: esys.escript.timeseries.TimeSeriesBaseDataset.updateIdOfLastUnreferencedDatum

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

http://epydoc.sf.net