ptolemy.actor.gt.controller
Class InputModel
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.domains.modal.kernel.State
ptolemy.domains.ptera.kernel.Event
ptolemy.actor.gt.controller.GTEvent
ptolemy.actor.gt.controller.InputModel
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Initializable, ConfigurableEntity, Changeable, Configurable, Debuggable, DebugListener, Derivable, DropTargetHandler, Flowable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
public class InputModel
- extends GTEvent
An event to receive an input model from the modelInput port and store the
model in the model parameter.
- Since:
- Ptolemy II 8.0
- Version:
- $Id: InputModel.java 57044 2010-01-27 22:41:05Z cxh $
- Author:
- Thomas Huining Feng
- See Also:
OutputModel
,
Serialized Form
- Accepted Rating:
- Proposed Rating:
Field Summary |
private static java.lang.String |
_INPUT_PORT_NAME
The input port name. |
Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
Constructor Summary |
InputModel(CompositeEntity container,
java.lang.String name)
Construct an event with the given name contained by the specified
composite entity. |
Method Summary |
Event.RefiringData |
fire(Token arguments)
Process this event and read the model from the modelInput port, if any. |
void |
scheduleEvents()
Schedule the next events only when the modelInput port has a model token
present. |
Methods inherited from class ptolemy.domains.ptera.kernel.Event |
_getParserScope, _isActiveRefinement, addInitializable, attributeChanged, clone, getController, initialize, isEndingEvent, isFinalEvent, isInitialEvent, preinitialize, refire, removeInitializable, stop, wrapup |
Methods inherited from class ptolemy.domains.modal.kernel.State |
_exportMoMLContents, configure, dropObject, getConfigurer, getConfigureSource, getConfigureText, getIncomingPort, getObjectInRefinement, getOutgoingPort, getRefinement, nonpreemptiveTransitionList, preemptiveTransitionList |
Methods inherited from class ptolemy.kernel.ComponentEntity |
_addPort, _adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setName |
Methods inherited from class ptolemy.kernel.Entity |
_description, _removePort, _validateSettables, connectedPortList, connectedPorts, connectionsChanged, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName |
Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, attributeTypeChanged, clone, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
_INPUT_PORT_NAME
private static final java.lang.String _INPUT_PORT_NAME
- The input port name.
- See Also:
- Constant Field Values
InputModel
public InputModel(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- 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.
- Parameters:
container
- The container.name
- The name of the state.
- Throws:
IllegalActionException
- If the state cannot be contained
by the proposed container.
NameDuplicationException
- If the name coincides with
that of an entity already in the container.
fire
public Event.RefiringData fire(Token arguments)
throws IllegalActionException
- Process this event and read the model from the modelInput port, if any.
The new model is stored in the model parameter.
- Overrides:
fire
in class Event
- Parameters:
arguments
- The arguments used to process this event, which must be
either an ArrayToken or a RecordToken.
- Returns:
- 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.
- Throws:
IllegalActionException
- If the port cannot be read, or if
thrown by the superclass.- See Also:
Event.refire(Token, RefiringData)
scheduleEvents
public void scheduleEvents()
throws IllegalActionException
- Schedule the next events only when the modelInput port has a model token
present.
- Overrides:
scheduleEvents
in class Event
- Throws:
IllegalActionException
- If the presence of a model token
cannot be tested, or if thrown by the superclass.