ptolemy.actor.util
Interface ExplicitChangeContext
- All Superinterfaces:
- Nameable
- All Known Implementing Classes:
- FmvAutomaton, FmvAutomaton, FSMActor, FSMActor, FSMDirector, FSMDirector, FSMMatcher, HDFFSMDirector, HSFSMDirector, HSModalDirector, HybridModalDirector, InterfaceAutomaton, InterfaceAutomaton, ModalController, ModalController, ModalDirector, ModalDirector, MultirateFSMDirector, MultirateFSMDirector, NonStrictFSMDirector, NonStrictFSMDirector, PteraController, SetVariable, TDLActor, TDLController, TDLModuleDirector, VariableLattice, VariableRecursiveLattice
public interface ExplicitChangeContext
- extends Nameable
An entity that implements an explicit change context declares a
change context, in which parameters are modified. If the
ExplicitChangeContext is an Entity, then the change context is
assumed to be the entity. If the ExplicitChangeContext is not an
entity, but directly contained by an entity, then that entity is
considered to be the change context. This capability allows
directors to easily declare change contexts. The information
declared by this class is used by the ConstVariableModelAnalysis to
determine what parameters might be modified by a given entity.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: ExplicitChangeContext.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Steve Neuendorffer
- See Also:
ConstVariableModelAnalysis
- Accepted Rating:
- Proposed Rating:
getModifiedVariables
java.util.List getModifiedVariables()
throws IllegalActionException
- Return a list of variables that this entity modifies. The
variables are assumed to have a change context of the given
entity.
- Returns:
- A list of variables.
- Throws:
IllegalActionException
- If the list of modified
variables cannot be returned.
getContext
Entity getContext()
throws IllegalActionException
- Return the change context being made explicit. In simple cases, this
will simply be the entity implementing this interface. However, in
more complex cases, directors may implement this interface, or entities
may modify parameters according to a different change context (i.e. HDF)
- Returns:
- The change context being made explicit.
- Throws:
IllegalActionException
- If the context is not available.