Package ptolemy.domains.modal.kernel

Interface RefinementActor

All Superinterfaces:

Actor, Executable, Initializable, Nameable, TypedActor

All Known Implementing Classes:

FactorOracle, ModalController, ModalRefinement, OracleModel, PteraController, Refinement, TDLRefinement, TransitionRefinement

public interface RefinementActor
extends TypedActor

An interface for actors that act as refinements of states in FSMs or events in Ptera models.

Since:

Ptolemy II 8.0

Version:

$Id$

Author:

Thomas Huining Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Field Summary

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Method Summary

Modifier and Type	Method	Description
void	addRefinement(State state, java.lang.String name, Entity template, java.lang.String className, InstanceOpener instanceOpener)	Create a refinement for the given state.
State	getRefinedState()	Return the state (or event, which subclasses state) that this actor refines.
void	setMirrorDisable(int disable)	Control whether adding a port should be mirrored in the modal model and the mode controller.

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

fire, isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Methods inherited from interface ptolemy.actor.TypedActor

isBackwardTypeInferenceEnabled, typeConstraints

Method Detail

addRefinement

void addRefinement(State state,
                   java.lang.String name,
                   Entity template,
                   java.lang.String className,
                   InstanceOpener instanceOpener)
            throws IllegalActionException

Create a refinement for the given state.

Parameters:

state - The state that will contain the new refinement.

name - The name of the composite entity that stores the refinement.

template - The template used to create the refinement, or null if template is not used.

className - The class name for the refinement, which is used when template is null.

instanceOpener - The instanceOpener, typically a Configuration, that is used to open the refinement (as a look-inside action) after it is created, or null if it is not needed to open the refinement.

Throws:

IllegalActionException - If error occurs while creating the refinement.

getRefinedState

State getRefinedState()
               throws IllegalActionException

Return the state (or event, which subclasses state) that this actor refines.

Returns:

The state or event that this actor refines.

Throws:

IllegalActionException - If thrown while trying to find the refined state or event.

setMirrorDisable

void setMirrorDisable(int disable)

Control whether adding a port should be mirrored in the modal model and the mode controller.

Parameters:

disable - 0 if mirroring should occur, -1 if mirroring should not occur downwards in the hierarchy, 1 if mirroring should not occur upwards in the hierarchy.