SimPy.SimulationRT.Monitor

Package SimPy :: Module SimulationRT :: Class Monitor |
[show private | hide private]
[frames | no frames]

## Type Monitor

    object --+
             |
          list --+
                 |
                Monitor

Monitored variables

A Class for monitored variables, that is, variables that allow one to gather simple statistics. A Monitor is a subclass of list and list operations can be performed on it. An object is established using m= Monitor(name = '..'). It can be given a unique name for use in debugging and in tracing and ylab and tlab strings for labelling graphs.

Method Summary
| `__init__(self, name, ylab, tlab)`
| ``accum`(self, y, t)` deprecated: accum for backward compatibility
| ``count`(self)` deprecated: the number of observations made
| ``getHistogram`(self)` Returns a histogram based on the parameters provided in preceding call to setHistogram.
| ``histogram`(self, low, high, nbins)` A histogram of the monitored y data values.
| ``mean`(self)` the simple average of the monitored variable
| ``observe`(self, y, t)` record y and t
| ``reset`(self, t)` reset the sums and counts for the monitored variable
| ``setHistogram`(self, name, low, high, nbins)` Sets histogram parameters.
| ``tally`(self, y)` deprecated: tally for backward compatibility
| ``timeAverage`(self, t)` the time-average of the monitored variable.
| ``total`(self)` the sum of the y
| ``tseries`(self)` the series of measured times
| ``var`(self)` the sample variance of the monitored variable
| ``yseries`(self)` the series of measured values
Inherited from list
| ``__add__`(x, y)` x.__add__(y) <==> x+y
| ``__contains__`(x, y)` x.__contains__(y) <==> y in x
| ``__delitem__`(x, y)` x.__delitem__(y) <==> del x[y]
| ``__delslice__`(x, i, j)` Use of negative indices is not supported.
| ``__eq__`(x, y)` x.__eq__(y) <==> x==y
| ``__ge__`(x, y)` x.__ge__(y) <==> x>=y
| ``__getattribute__`(...)` x.__getattribute__('name') <==> x.name
| ``__getitem__`(x, y)` x.__getitem__(y) <==> x[y]
| ``__getslice__`(x, i, j)` Use of negative indices is not supported.
| ``__gt__`(x, y)` x.__gt__(y) <==> x>y
| ``__hash__`(x)` x.__hash__() <==> hash(x)
| ``__iadd__`(x, y)` x.__iadd__(y) <==> x+=y
| ``__imul__`(x, y)` x.__imul__(y) <==> x*=y
| ``__iter__`(x)` x.__iter__() <==> iter(x)
| ``__le__`(x, y)` x.__le__(y) <==> x<=y
| ``__len__`(x)` x.__len__() <==> len(x)
| ``__lt__`(x, y)` x.__lt__(y) <==> x<y
| ``__mul__`(x, n)` x.__mul__(n) <==> x*n
| ``__ne__`(x, y)` x.__ne__(y) <==> x!=y
| ``__new__`(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
| ``__repr__`(x)` x.__repr__() <==> repr(x)
| ``__rmul__`(x, n)` x.__rmul__(n) <==> n*x
| ``__setitem__`(x, i, y)` x.__setitem__(i, y) <==> x[i]=y
| ``__setslice__`(x, i, j, y)` Use of negative indices is not supported.
| ``append`(...)` L.append(object) -- append object to end
| ``extend`(...)` L.extend(iterable) -- extend list by appending elements from the iterable
| ``index`(...)` L.index(value, [start, [stop]]) -> integer -- return first index of value
| ``insert`(...)` L.insert(index, object) -- insert object before index
| ``pop`(L, index)` L.pop([index]) -> item -- remove and return item at index (default last)
| ``remove`(...)` L.remove(value) -- remove first occurrence of value
| ``reverse`(...)` L.reverse() -- reverse *IN PLACE*
| ``sort`(...)` L.sort(cmpfunc=None) -- stable sort *IN PLACE*; cmpfunc(x, y) -> -1, 0, 1
Inherited from object
| ``__delattr__`(...)` x.__delattr__('name') <==> del x.name
| ``__reduce__`(...)` helper for pickle
| ``__reduce_ex__`(...)` helper for pickle
| ``__setattr__`(...)` x.__setattr__('name', value) <==> x.name = value
| ``__str__`(x)` x.__str__() <==> str(x)

Method Details

### accum(self, y, t=None) deprecated: accum for backward compatibility

### count(self) deprecated: the number of observations made Overrides: `__builtin__.list.count`

### getHistogram(self) Returns a histogram based on the parameters provided in preceding call to setHistogram.

### histogram(self, low=0.0, high=100.0, nbins=10) A histogram of the monitored y data values.

### mean(self) the simple average of the monitored variable

### observe(self, y, t=None) record y and t

### reset(self, t=None) reset the sums and counts for the monitored variable

### setHistogram(self, name='', low=0.0, high=100.0, nbins=10) Sets histogram parameters. Must be called before call to getHistogram

### tally(self, y) deprecated: tally for backward compatibility

### timeAverage(self, t=None) the time-average of the monitored variable. If t is used it is assumed to be the current time, otherwise t = now()

### total(self) the sum of the y

### tseries(self) the series of measured times

### var(self) the sample variance of the monitored variable

### yseries(self) the series of measured values

Generated by Epydoc 2.1 on Wed Jun 14 14:32:43 2006 | http://epydoc.sf.net