/* An event to receive an input model from the modelInput port and store the
model in the model parameter.
Copyright (c) 2008-2009 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.gt.controller;
import ptolemy.data.ActorToken;
import ptolemy.data.BooleanToken;
import ptolemy.data.Token;
import ptolemy.data.expr.ParserScope;
import ptolemy.domains.ptera.kernel.PteraDebugEvent;
import ptolemy.kernel.CompositeEntity;
import ptolemy.kernel.Entity;
import ptolemy.kernel.util.IllegalActionException;
import ptolemy.kernel.util.NameDuplicationException;
//////////////////////////////////////////////////////////////////////////
//// InputModel
/**
An event to receive an input model from the modelInput port and store the
model in the model parameter.
@author Thomas Huining Feng
@version $Id$
@since Ptolemy II 7.1
@Pt.ProposedRating Yellow (tfeng)
@Pt.AcceptedRating Red (tfeng)
@see OutputModel
*/
public class InputModel extends GTEvent {
/** Construct an event with the given name contained by the specified
* composite entity. The container argument must not be null, or a
* NullPointerException will be thrown. This event will use the
* workspace of the container for synchronization and version counts.
* If the name argument is null, then the name is set to the empty
* string.
* Increment the version of the workspace.
* This constructor write-synchronizes on the workspace.
*
* @param container The container.
* @param name The name of the state.
* @exception IllegalActionException If the state cannot be contained
* by the proposed container.
* @exception NameDuplicationException If the name coincides with
* that of an entity already in the container.
*/
public InputModel(CompositeEntity container, String name)
throws IllegalActionException, NameDuplicationException {
super(container, name);
}
/** Process this event and read the model from the modelInput port, if any.
* The new model is stored in the model parameter.
*
* @param arguments The arguments used to process this event, which must be
* either an ArrayToken or a RecordToken.
* @return A refiring data structure that contains a non-negative double
* number if refire() should be called after that amount of model time, or
* null if refire() need not be called.
* @exception IllegalActionException If the port cannot be read, or if
* thrown by the superclass.
*/
public RefiringData fire(Token arguments) throws IllegalActionException {
RefiringData data = super.fire(arguments);
ParserScope scope = _getParserScope();
BooleanToken inputPortPresent = (BooleanToken) scope
.get(_INPUT_PORT_NAME + "_isPresent");
if (inputPortPresent != null && inputPortPresent.booleanValue()) {
_debug(new PteraDebugEvent(this, "Input model received at "
+ _INPUT_PORT_NAME + "."));
ActorToken modelToken = (ActorToken) scope.get(_INPUT_PORT_NAME);
Entity entity = modelToken.getEntity();
if (!(entity instanceof CompositeEntity)) {
throw new IllegalActionException("Only instances of "
+ "CompositeEntity are accepted in the input "
+ "ActorTokens to the transformation controller.");
}
getModelParameter().setModel((CompositeEntity) entity);
}
return data;
}
/** Schedule the next events only when the modelInput port has a model token
* present.
*
* @exception IllegalActionException If the presence of a model token
* cannot be tested, or if thrown by the superclass.
*/
public void scheduleEvents() throws IllegalActionException {
ParserScope scope = _getParserScope();
BooleanToken inputPortPresent = (BooleanToken) scope
.get(_INPUT_PORT_NAME + "_isPresent");
if (inputPortPresent != null && inputPortPresent.booleanValue()) {
super.scheduleEvents();
}
}
/** The input port name.
*/
private static final String _INPUT_PORT_NAME = "modelInput";
}