ptolemy.actor

Interface InstanceOpener

All Known Implementing Classes:

Configuration, SingleWindowConfiguration

public interface InstanceOpener

An interface that is used to open an instance of a NamedObj.

This interface exists so that ModalController and ModalRefinement need not depend on Configuration.

Since:

Ptolemy II 10.0

Version:

$Id: InstanceOpener.java 70402 2014-10-23 00:52:20Z cxh $

Author:

Christopher Brooks

Accepted Rating:

Yellow (cxh)

Proposed Rating:

Green (cxh)

Method Summary

Modifier and Type	Method and Description
void	openAnInstance(NamedObj entity) Open the specified instance.

Method Detail

openAnInstance

void openAnInstance(NamedObj entity)
             throws IllegalActionException,
                    NameDuplicationException

Open the specified instance. A derived class looks for the instance, and if the instance already has open tableaux, then put those in the foreground Otherwise, create a new tableau and if necessary, a new effigy. Unless there is a more natural container for the effigy (e.g. it is a hierarchical model), then if a new effigy is created, it is put into the directory of the configuration. Any new tableau created will be contained by that effigy.

Parameters:

entity - The entity to open.

Throws:

IllegalActionException - If constructing an effigy or tableau fails.

NameDuplicationException - If a name conflict occurs (this should not be thrown).