public class ReceiveInput extends Event implements TimeAdvanceEvent
timeAdvance parameter defines the amount of model time
that is advanced at the same time as the user sends input. For example, if the
current model time is 5 and timeAdvance parameter is 1 when this event is
fired, then the user input is considered to be received at model time 6. The
events scheduled to occur between time 5 and 6 occur in the background, but the
events scheduled to occur after 6 would be delayed until the user input is
actually received. Whether the events scheduled exactly at time 5 or 6 are
processed while the user input is being waited for depends on the LIFO or FIFO
policy of the model.| Red (tfeng) |
| Yellow (tfeng) |
Event.EventParameter, Event.RefiringDataEntity.ContainedObjectsIterator| Modifier and Type | Field and Description |
|---|---|
StringParameter |
acceptableComponentType
The name of the class of the component that can accept user input, such
as "java.awt.Button", or empty.
|
StringParameter |
acceptableKeyPattern
A string pattern in the Java regular expression used to match acceptable
key input.
|
StringParameter |
componentType
Class name of the component that actually receives the user input, which
is automatically updated after the input is received.
|
StringParameter |
keyPressText
The text of the key input, which is automatically updated after the
input is received.
|
Parameter |
mousePressLocation
Screen location of the mouse press, which is automatically updated after
the input is received.
|
Parameter |
receiveKeyPress
A Boolean parameter to determine whether key presses are accepted.
|
Parameter |
receiveMousePress
A Boolean parameter to determine whether mouse presses are accepted.
|
StringParameter |
referredTableau
The parameter that contains the name of the TableauParameter to be used.
|
Parameter |
timeAdvance
The amount (in double) of model time advancement.
|
actions, isEndingEvent, isFinalEvent, isInitialEvent, parametersincomingPort, isFinalState, isInitialState, outgoingPort, refinementName, saveRefinementsInConfigurer_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS| Constructor and Description |
|---|
ReceiveInput(CompositeEntity container,
java.lang.String name)
Construct an event with the given name contained by the specified
composite entity.
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
clone(Workspace workspace)
Clone the state into the specified workspace.
|
Event.RefiringData |
fire(Token arguments)
Process this event with the given arguments.
|
java.lang.String |
getTimeAdvanceText()
Return a string that represents the amount of model time advancement.
|
Event.RefiringData |
refire(Token arguments,
Event.RefiringData data)
Continue the processing of this event with the given arguments from the
previous fire() or refire().
|
void |
stop()
Request that the event cease execution altogether.
|
_getParserScope, _isActiveRefinement, addInitializable, attributeChanged, getController, initialize, isEndingEvent, isFinalEvent, isInitialEvent, preinitialize, removeInitializable, scheduleEvents, setContainer, wrapup_exportMoMLContents, configure, dropObject, errorTransitionList, getConfigurer, getConfigureSource, getConfigureText, getIncomingPort, getObjectInRefinement, getOutgoingPort, getRefinement, nonErrorNonTerminationTransitionList, nonpreemptiveTransitionList, preemptiveTransitionList, terminationTransitionList_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, newPort, propagateExistence, setName_addPort, _description, _removePort, _validateSettables, connectedPortList, connectedPorts, connectionsChanged, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, attributeTypeChanged, clone, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspaceequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetDerivedLevel, getDerivedList, propagateValuedescription, getDisplayName, getFullName, getName, getNamepublic StringParameter acceptableComponentType
public StringParameter acceptableKeyPattern
public StringParameter componentType
public StringParameter keyPressText
public Parameter mousePressLocation
public Parameter receiveKeyPress
public Parameter receiveMousePress
public StringParameter referredTableau
public Parameter timeAdvance
public ReceiveInput(CompositeEntity container, java.lang.String name) throws IllegalActionException, NameDuplicationException
container - The container.name - The name of the state.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.public java.lang.Object clone(Workspace workspace) throws java.lang.CloneNotSupportedException
clone in class Eventworkspace - The workspace for the new event.java.lang.CloneNotSupportedException - If a derived class contains
an attribute that cannot be cloned.NamedObj.exportMoML(Writer, int, String),
NamedObj.setDeferringChangeRequests(boolean)public Event.RefiringData fire(Token arguments) throws IllegalActionException
fire in class Eventarguments - The arguments used to process this event, which must be
either an ArrayToken or a RecordToken.IllegalActionException - If the number of the arguments or
their types do not match, the actions cannot be executed, or any
expression (such as guards and arguments to the next events) cannot be
evaluated.Event.refire(Token, RefiringData)public java.lang.String getTimeAdvanceText()
getTimeAdvanceText in interface TimeAdvanceEventpublic Event.RefiringData refire(Token arguments, Event.RefiringData data) throws IllegalActionException
refire in class Eventarguments - The arguments used to process this event, which must be
either an ArrayToken or a RecordToken.data - The refiring data structure returned by the previous fire()
or refire().IllegalActionException - If the number of the arguments or
their types do not match, the actions cannot be executed, or any
expression (such as guards and arguments to the next events) cannot be
evaluated.fire(Token)