/* Refinement for modal models.
Copyright (c) 2006 The Regents of the University of California.
All rights reserved.
Permission is hereby granted, without written agreement and without
license or royalty fees, to use, copy, modify, and distribute this
software and its documentation for any purpose, provided that the above
copyright notice and the following two paragraphs appear in all copies
of this software.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
PT_COPYRIGHT_VERSION_2
COPYRIGHTENDKEY
*/
package ptolemy.actor.lib.hoc;
import ptolemy.actor.TypedCompositeActor;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.Entity;
import ptolemy.kernel.Port;
import ptolemy.kernel.Relation;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.InternalErrorException;
import ptolemy.kernel.util.NameDuplicationException;
//////////////////////////////////////////////////////////////////////////
//// Refinement
/**
This typed composite actor supports mirroring of its ports in its container
(which is required to be a MultiCompositeActor), which in turn assures
mirroring of ports in each of the refinements and the controller.
@author Edward A. Lee
@version $Id$
@since Ptolemy II 5.2
@Pt.ProposedRating Yellow (eal)
@Pt.AcceptedRating Red (reviewmoderator)
*/
public class Refinement extends TypedCompositeActor {
/** Construct a modal controller with a name and a container.
* The container argument must not be null, or a
* NullPointerException will be thrown.
* @param container The container.
* @param name The name of this actor.
* @exception IllegalActionException If the container is incompatible
* with this actor.
* @exception NameDuplicationException If the name coincides with
* an actor already in the container.
*/
public Refinement(CompositeEntity container, String name)
throws IllegalActionException, NameDuplicationException {
super(container, name);
// The base class identifies the class name as TypedCompositeActor
// irrespective of the actual class name. We override that here.
setClassName("ptolemy.actor.lib.hoc.Refinement");
}
///////////////////////////////////////////////////////////////////
//// public methods ////
/** Create a new port with the specified name in the container of
* this refinement, which in turn creates a port in this refinement
* all other refinements, and the controller.
* This method is write-synchronized on the workspace.
* @param name The name to assign to the newly created port.
* @return The new port.
* @exception NameDuplicationException If the entity already has a port
* with the specified name.
*/
public Port newPort(String name) throws NameDuplicationException {
try {
_workspace.getWriteAccess();
if (_mirrorDisable || (getContainer() == null)) {
// Have already called newPort() in the container.
// This time, process the request.
RefinementPort port = new RefinementPort(this, name);
// NOTE: Changed RefinementPort so mirroring
// is enabled by default. This means mirroring
// will occur during MoML parsing, but this
// is harmless. EAL 12/04.
// port._mirrorDisable = false;
// Create the appropriate links.
MultiCompositeActor container = (MultiCompositeActor) getContainer();
if (container != null) {
String relationName = name + "Relation";
Relation relation = container.getRelation(relationName);
if (relation == null) {
relation = container.newRelation(relationName);
Port containerPort = container.getPort(name);
containerPort.link(relation);
}
port.link(relation);
}
return port;
} else {
_mirrorDisable = true;
((MultiCompositeActor) getContainer()).newPort(name);
return getPort(name);
}
} catch (IllegalActionException ex) {
// This exception should not occur, so we throw a runtime
// exception.
throw new InternalErrorException(
"Refinement.newPort: Internal error: " + ex.getMessage());
} finally {
_mirrorDisable = false;
_workspace.doneWriting();
}
}
/** Control whether adding a port should be mirrored in the modal
* model and the mode controller.
* This is added to allow control by the UI.
* @param disable True if mirroring should not occur.
*/
public void setMirrorDisable(boolean disable) {
_mirrorDisable = disable;
}
///////////////////////////////////////////////////////////////////
//// protected methods ////
/** Override the base class to ensure that the proposed container
* is a MultiCompositeActor or null.
* @param container The proposed container.
* @exception IllegalActionException If the proposed container is not a
* TypedActor, or if the base class throws it.
*/
protected void _checkContainer(Entity container)
throws IllegalActionException {
if (!(container instanceof MultiCompositeActor) && (container != null)) {
throw new IllegalActionException(container, this,
"Refinement can only be contained by "
+ "MultiCompositeActor objects.");
}
}
///////////////////////////////////////////////////////////////////
//// protected variables ////
// These are protected to be accessible to MultiCompositeActor.
/** Indicator that we are processing a newPort request. */
protected boolean _mirrorDisable = false;
}