pywr.recorders.TotalFlowNodeRecorder

class pywr.recorders.TotalFlowNodeRecorder(*args, **kwargs)

Recorder to total the flow for a Node.

A factor can be provided to scale the total flow (e.g. for calculating operational costs).

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(*args, **kwargs)	Initialize self.
after(self)
aggregated_value(self)
before(self)
finish(self)
is_constraint_violated(self)	Returns true if the value from this Recorder violates its constraint bounds.
load(type cls, model, data)
register(type cls)
reset(self)
setup(self)
unregister(type cls)
values(self)

Attributes

agg_func
children
comment	comment: unicode
constraint_lower_bounds
constraint_upper_bounds
epsilon	epsilon: ‘double’
factor	factor: ‘double’
ignore_nan	ignore_nan: ‘bool’
is_constraint	Returns true if either upper or lower constraint bounds is defined.
is_double_bounded_constraint	Returns true if upper and lower constraint bounds are both defined and not-equal to one another.
is_equality_constraint	Returns true if upper and lower constraint bounds are both defined and equal to one another.
is_lower_bounded_constraint	Returns true if lower constraint bounds is defined and upper constraint bounds is not.
is_objective
is_upper_bounded_constraint	Returns true if upper constraint bounds is defined and lower constraint bounds is not.
model
name
node
parents