| org.cougaar.core.adaptivity.OperatingMode
All known Subclasses: org.cougaar.core.adaptivity.OperatingModeImpl,
| OperatingMode | | public interface OperatingMode extends java.io.Serializable(Code) | | A control input for a component (for example, a plugin). The
AdaptivityEngine sets OperatingMode values according to the plays
it selects. OperatingModes are generally created by the component
whose operation can be controlled. OperatingModes should be
published to the blackboard so they are accessible to the
OperatingModeServiceProvider . The component should also subscribe
to the OperatingMode if it needs to know when changes occur.
Alternatively, the value can be examined as needed.
|
| getAllowedValues | | OMCRangeList getAllowedValues()(Code) | | Get the list of allowed value ranges for this OperatingMode.
Attempts to set the value outside these ranges will fail.
a list of allowed value ranges |
| getName | | String getName()(Code) | | Gets the (distinct) name of this OperatingMode. The names of
all the OperatingMode on a particular blackboard must be
distinct. This can be achieved by establishing naming
conventions such has including the class name of the plugin or
other component in the name. Where the same component class may
be instantiated multiple times, the multiple instances may
already have some sor of name that can be used in addition to
the class name. It is the responsibility of the component
designer to insure that OperatingMode names are not ambiguous.
the name of this OperatingMode |
| getValue | | Comparable getValue()(Code) | | Get the current value of this OperatingMode. This value must
never be outside the allowed value ranges.
the current value of this OperatingMode |
| setValue | | void setValue(Comparable newValue)(Code) | | Set a new value for this OperatingMode. Used by the
AdaptivityEngine to alter the mode of the component having this
OperatingMode.
Parameters:
newValue - the new value for this OperatingMode. Must bein the allowed value ranges.
exception:
IllegalArgumentException - if the newValue is notallowed. |
|
|