ptolemy.actor.util

Interface ExplicitChangeContext

All Superinterfaces:

Nameable

All Known Implementing Classes:

BaseMultipleMethodsActor, FactorOracle, FmvAutomaton, FSMActor, FSMDirector, FSMMatcher, HDFFSMDirector, HybridModalDirector, InterfaceAutomaton, MetroIIFSMDirector, ModalController, ModalDirector, MultirateFSMDirector, NonStrictFSMDirector, PteraController, SequencedIntegrator, SequencedSharedMemoryActor, SequencedVariable, 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$

Author:

Steve Neuendorffer

See Also:

ConstVariableModelAnalysis

Pt.AcceptedRating:

Red (neuendor)

Pt.ProposedRating:

Red (neuendor)

Method Summary

Modifier and Type	Method and Description
Entity	getContext() Return the change context being made explicit.
java.util.List	getModifiedVariables() Return a list of variables that this entity modifies.

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Method Detail

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.