|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.gui.InteractiveShell
This actor creates a command shell on the screen, sending commands that are typed by the user to its output port, and reporting strings received at its input by displaying them. Each time it fires, it reads the input, displays it, then displays a command prompt (which by default is ">>"), and waits for a command to be typed. The command is terminated by an enter or return character, which then results in the command being produced on the output. In a typical use of this actor, it will be preceded by a SampleDelay actor which will provide an initial welcome message or instructions. The output will then be routed to some subsystem for processing, and the result will be fed back to the input.
Note that because of complexities in Swing, if you resize the display window, then, unlike the plotters, the new size will not be persistent. That is, if you save the model and then re-open it, the new size is forgotten. The position, however, is persistent.
| Red (cxh) |
| Yellow (eal) |
| Nested Class Summary | |
class |
InteractiveShell.ShellFrame
The frame that is created by an instance of ShellTableau. |
class |
InteractiveShell.ShellTableau
Version of ExpressionShellTableau that records the size of the display when it is closed. |
| Nested classes inherited from class ptolemy.kernel.Entity |
Entity.ContainedObjectsIterator |
| Field Summary | |
TypedIOPort |
input
The input port. |
TypedIOPort |
output
The output port. |
PortParameter |
prompt
The prompt. |
ShellTextArea |
shell
The shell window object. |
| Fields inherited from class ptolemy.actor.AtomicActor |
_stopRequested |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
| Fields inherited from interface ptolemy.actor.Executable |
COMPLETED, NOT_READY, STOP_ITERATING |
| Constructor Summary | |
InteractiveShell(CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
|
| Method Summary | |
protected void |
_exportMoMLContents(java.io.Writer output,
int depth)
Write a MoML description of the contents of this object. |
java.lang.Object |
clone(Workspace workspace)
Clone the actor into the specified workspace. |
java.lang.String |
evaluateCommand(java.lang.String command)
Evaluate the specified command. |
void |
fire()
Read and display the input, then wait for user input and produce the user data on the output. |
java.lang.String |
getOutput()
Get the output string to be sent. |
void |
initialize()
If the shell has not already been created, create it. |
boolean |
isCommandComplete(java.lang.String command)
Return true if the specified command is complete (ready to be interpreted). |
void |
place(java.awt.Container container)
Specify the container into which this shell should be placed. |
boolean |
postfire()
Override the base class to return false if the user has typed "quit" or "exit". |
void |
setContainer(CompositeEntity container)
Override the base class to remove the shell from its graphical container if the argument is null. |
void |
setOutput(java.lang.String value)
Specify an output string to be sent. |
void |
stop()
Override the base class to call notifyAll() to get out of any waiting. |
void |
wrapup()
Override the base class to make the shell uneditable. |
| Methods inherited from class ptolemy.actor.TypedAtomicActor |
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, removeDependency, stopFire, terminate |
| Methods inherited from class ptolemy.kernel.ComponentEntity |
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName |
| Methods inherited from class ptolemy.kernel.Entity |
_description, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables |
| Methods inherited from class ptolemy.kernel.InstantiableNamedObj |
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface ptolemy.actor.Actor |
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList |
| Methods inherited from interface ptolemy.actor.Executable |
iterate, prefire, preinitialize, stopFire, terminate |
| Methods inherited from interface ptolemy.kernel.util.Derivable |
getDerivedLevel, getDerivedList, propagateValue |
| Methods inherited from interface ptolemy.kernel.util.Nameable |
description, getFullName, getName, getName |
| Field Detail |
public TypedIOPort input
public TypedIOPort output
public PortParameter prompt
public ShellTextArea shell
| Constructor Detail |
public InteractiveShell(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
container - The container.name - The name of this actor.
IllegalActionException - If the actor cannot be contained
by the proposed container.
NameDuplicationException - If the container already has an
actor with this name.| Method Detail |
public java.lang.Object clone(Workspace workspace)
throws java.lang.CloneNotSupportedException
clone in class AtomicActorworkspace - The workspace for the new object.
java.lang.CloneNotSupportedException - If a derived class has an
attribute that cannot be cloned.
public java.lang.String evaluateCommand(java.lang.String command)
throws java.lang.Exception
evaluateCommand in interface ShellInterpretercommand - The command.
java.lang.Exception - If something goes wrong processing the command.ShellTextArea.returnResult(String)
public void fire()
throws IllegalActionException
fire in interface Executablefire in class AtomicActorIllegalActionException - If producing the output
causes an exception.public java.lang.String getOutput()
public void initialize()
throws IllegalActionException
initialize in interface Executableinitialize in class AtomicActorIllegalActionException - If the parent class throws it.public boolean isCommandComplete(java.lang.String command)
isCommandComplete in interface ShellInterpretercommand - The command.
public void place(java.awt.Container container)
place in interface Placeablecontainer - The container into which to place the shell, or
null to specify that a new shell should be created.
public boolean postfire()
throws IllegalActionException
postfire in interface Executablepostfire in class AtomicActorIllegalActionException - If the superclass throws it.
public void setContainer(CompositeEntity container)
throws IllegalActionException,
NameDuplicationException
setContainer in class AtomicActorcontainer - The proposed container.
IllegalActionException - If the base class throws it.
NameDuplicationException - If the base class throws it.public void setOutput(java.lang.String value)
value - An output string to be sent.getOutput()public void stop()
stop in interface Executablestop in class AtomicActor
public void wrapup()
throws IllegalActionException
wrapup in interface Executablewrapup in class AtomicActorIllegalActionException - If the parent class throws it.
protected void _exportMoMLContents(java.io.Writer output,
int depth)
throws java.io.IOException
_exportMoMLContents in class Entityoutput - The output stream to write to.depth - The depth in the hierarchy, to determine indenting.
java.io.IOException - If an I/O error occurs.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||