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

Class TimeSeriesBaseBuffer

   TimeSeriesBase --+    
                    |    
TimeSeriesBaseDataset --+
                        |
                       TimeSeriesBaseBuffer

An implementation of TimeSeriesBaseDataset which actually is storing data in a numarray buffer.

Instance Methods

[hide private]

__init__(self, buffer_size=1000, numComponents=1, type=Float64, id_of_first_datum=0, debug=False, description='TimeSeriesBaseBuffer')

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 available 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 referring 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=0)
Returns True if the buffer will be full after num_new_data values have been appended.

updateIdOfLastUnreferencedDatum(self, last_unreferenced_datum)
Updates the identification number of the last unused datum (overwrites TimeSeriesBaseDataset method).

Inherited from TimeSeriesBaseDataset: __getitem__, __len__, getBaseBuffer, getNumData, getOffset, isEmpty

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

Method Details

[hide private]

init(self, buffer_size=1000, numComponents=1, type=Float64, id_of_first_datum=0, debug=False, description=`'TimeSeriesBaseBuffer'`)
(Constructor)

Overrides: TimeSeriesBase.__init__

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: TimeSeriesBaseDataset.append

getBaseBufferSize(self)

Returns the size of the buffer.

Overrides: TimeSeriesBaseDataset.getBaseBufferSize

getIdOfFirstAvailableDatum(self)

Returns the identification number of the first available datum (overwrites TimeSeriesBaseDataset method).

Overrides: TimeSeriesBaseDataset.getIdOfFirstAvailableDatum

getIdOfFirstDatum(self)

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

Overrides: TimeSeriesBaseDataset.getIdOfFirstDatum

getIdOfLastDatum(self)

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

Overrides: TimeSeriesBaseDataset.getIdOfLastDatum

getIdOfLastUnreferencedDatum(self)

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

Overrides: TimeSeriesBaseDataset.getIdOfLastUnreferencedDatum

getNumComponents(self)

Returns the number of components of the data (overwrites TimeSeriesBaseDataset method).

Overrides: TimeSeriesBaseDataset.getNumComponents

getOffsetInBaseBuffer(self)

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

Overrides: TimeSeriesBaseDataset.getOffsetInBaseBuffer

needsRearrangement(self, num_new_data=0)

Returns True if the buffer will be full after num_new_data values have been appended.

Overrides: TimeSeriesBaseDataset.needsRearrangement

updateIdOfLastUnreferencedDatum(self, last_unreferenced_datum)

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

Overrides: TimeSeriesBaseDataset.updateIdOfLastUnreferencedDatum