A contract monitor that decorates each entity in a model with a
<i>value</i> parameter and monitors the sum of all such values.
If the sum of the values equals or exceeds the value given in
<a href="../../../ptolemy/data/expr/ConstraintMonitor.xml#threshold">threshold</a> and <a href="../../../ptolemy/data/expr/ConstraintMonitor.xml#warningEnabled">warningEnabled</a> is true, then this
class will issue a warning when the aggregate value matches or
exceeds the threshold.
The decorator values default to 0.0, so the default total
is 0.0. The default threshold is Infinity, so no warnings will
be issued by default.
<p>
If the <a href="../../../ptolemy/data/expr/ConstraintMonitor.xml#includeOpaqueContents">includeOpaqueContents</a> parameter is true, then this decorator will
also decorate entities within opaque composite actors. By default,
this is false.
<p>
This object is a <a href="../../../ptolemy/data/expr/Parameter.xml">ptolemy.data.expr.Parameter</a> whose value is the total
of the values of all the decorator values. To use it, simply
drag it into a model.
<p>
Edward A. Lee
$Id: ConstraintMonitor.java 70402 2014-10-23 00:52:20Z cxh $
Ptolemy II 10.0
Yellow (eal)
Red (eal)
If true, then this decorator decorates entities within
opaque composite actors. This is a boolean that defaults to
false.
If true, then this decorator decorates transparent composite
entities. This is a boolean that defaults to false.
Threshold at which this monitor issues a warning, if
<a href="../../../ptolemy/data/expr/ConstraintMonitor.xml#warningEnabled">warningEnabled</a> is true.
This is a double that defaults to Infinity, meaning no
constraint on the sum of the decorator values.
If true (the default), then a warning is issued when the
aggregate value equals or exceeds the specified <a href="../../../ptolemy/data/expr/ConstraintMonitor.xml#threshold">threshold</a>.
This is a boolean that defaults to true.