cobald.decorator.standardiser module
- class cobald.decorator.standardiser.Standardiser(target: Pool, minimum: float = -inf, maximum: float = inf, granularity: int = 1, backlog: float = inf, surplus: float = inf)[source]
Bases:
PoolDecoratorLimits for changes to the demand of a pool
- Parameters:
target – the pool on which changes are standardised
minimum – minimum
target.demandallowedmaximum – maximum
target.demandallowedgranularity – granularity of
target.demandsurplus – how much
target.demandmay be abovetarget.supplybacklog – how much
target.demandmay be belowtarget.supply
The
supplyandbacklogclamp thedemandsuch thatsupply - backlog <= demand <= supply + surplusholds.The default values apply no limits at all so that isolated limits may be used. When several limits are set,
granularityhas the weakest priority, bothsurplusandbacklogmay limit the result ofgranularity, andminimumandmaximumoverrule all other limits.