|
||||||||||
| 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.python.PythonScript
An actor of this class executes a Python script. There are two versions of this actor provided in the Vergil libraries. The one called "PythonActor" has an input port and an output port; to view or edit its Python script, look inside the actor. The second version is called "PythonScript" and has no ports; to view or edit its Python script, select Configure (or double click on the icon).
Upon creation, this actor has no ports, and no parameters other than
script; The script parameter has visibility
EXPERT, and therefore does not normally show up in a configure dialog
for the actor. To make the script visible and editable, you have two
options. Including an instance of an attribute of class
TextEditorConfigureFactory (with its attributeName parameter
set to script) results in behavior like that of the Vergil
"PythonScript." That is, to edit the script, you Configure the actor.
If instead you include an instance of TextEditorTableauFactory,
then to edit the script you look inside the actor. Use the latter
if you wish to add additional attributes to the actor and hide the
script from the users. Use the former if the script is the main
means by which users interact with the actor.
Upon creation, this actor has no ports, and no parameters other than
script; The script parameter has visibility
EXPERT, and therefore does not normally show up in a configure dialog
for the actor. To make the script visible and editable, you have two
options. Including an instance of an attribute of class
TextEditorConfigureFactory (with its attributeName parameter
set to script) results in behavior like that of the Vergil
"PythonScript." That is, to edit the script, you Configure the actor.
If instead you include an instance of TextEditorTableauFactory,
then to edit the script you look inside the actor. Use the latter
if you wish to add additional attributes to the actor and hide the
script from the users. Use the former if the script is the main
means by which users interact with the actor.
The functionality of an actor of this type is given by a Python script.
As an example, a simplified version of the
Scale
actor can be implemented by the following script:
1. class Main : 2. "scale" 3. def fire(self) : 4. if not self.input.hasToken(0) : 5. return 6. s = self.scale.getToken() 7. t = self.input.get(0) 8. self.output.broadcast(s.multiply(t))Line 1 defines a Python class Main. This name is fixed. An instance of this class is created when the actor is initialized. Line 2 is a description of the purpose of the script. Lines 3-8 define the fire() method, which is called by the
fire() method of this actor. In the method body,
input and output are ports that have to have been
added to the actor, and scale is a parameter that has to have been
added to the actor (these can be added in the XML that defines the
actor instance in an actor library). The Main class can provide other
methods in the Executable interface
as needed.
In the script, use self.actor to access the actor. For example,
self.actor.getDirector() returns the current director of the
actor. For debugging, use self.actor.debug(someMessage). The
final message sent to the debug listeners of the actor will have the string
"From script: " inserted at the beginning. To avoid generating the debug
message when there are no listeners, use:
if self.actor.isDebugging() : self.actor.debug(someMessage)
This class relies on Jython, which is a Java implementation of Python. Follow the links below for more information about the Python language, licensing, downloads, etc.
| Red (reviewmoderator) |
| Yellow (liuxj) |
| Nested Class Summary |
| Nested classes inherited from class ptolemy.kernel.Entity |
ptolemy.kernel.Entity.ContainedObjectsIterator |
| Field Summary | |
ptolemy.kernel.util.StringAttribute |
script
The script that specifies the function of this actor. |
| 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 | |
PythonScript(ptolemy.kernel.CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
|
| Method Summary | |
void |
attributeChanged(ptolemy.kernel.util.Attribute attribute)
If script is changed, invoke the python interpreter to evaluate the script. |
void |
debug(java.lang.String message)
Send the message to all registered debug listeners. |
void |
fire()
Invoke the fire() method if defined in the script. |
void |
initialize()
Invoke the initialize() method if defined in the script. |
boolean |
isDebugging()
Return true if this actor has at least one debug listener. |
boolean |
postfire()
Invoke the postfire() method if defined in the script. |
boolean |
prefire()
Invoke the prefire() method if defined in the script. |
void |
preinitialize()
Create an instance of the Main class defined in the script. |
void |
stop()
Invoke the stop() method if defined in the script. |
void |
stopFire()
Invoke the stopFire() method if defined in the script. |
void |
terminate()
Invoke the terminate() method if defined in the script. |
void |
wrapup()
Invoke the wrapup() method if defined in the script. |
| Methods inherited from class ptolemy.actor.TypedAtomicActor |
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, pruneDependencies, removeDependency, setContainer |
| 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, _exportMoMLContents, _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 ptolemy.kernel.util.NamedObj |
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace |
| 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 |
| 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 ptolemy.kernel.util.StringAttribute script
| Constructor Detail |
public PythonScript(ptolemy.kernel.CompositeEntity container,
java.lang.String name)
throws ptolemy.kernel.util.NameDuplicationException,
ptolemy.kernel.util.IllegalActionException
container - The container.name - The name of this actor.
ptolemy.kernel.util.NameDuplicationException - If the container already
has an actor with this name.
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained
by the proposed container.| Method Detail |
public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
throws ptolemy.kernel.util.IllegalActionException
attribute - The attribute that changed.
ptolemy.kernel.util.IllegalActionException - If there is any error in evaluating
the script.public void debug(java.lang.String message)
self.actor.debug() to call this method.
message - The debug message.
public void fire()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If there is any error in calling the
fire() method defined by the script.
public void initialize()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If there is any error in calling the
initialize() method defined by the script.public boolean isDebugging()
public boolean postfire()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If there is any error in calling the
postfire() method defined by the script.
public boolean prefire()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If there is any error in calling the
prefire() method.
public void preinitialize()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If there is any error in creating
an instance of the Main class defined in the script.public void stop()
public void stopFire()
public void terminate()
public void wrapup()
throws ptolemy.kernel.util.IllegalActionException
ptolemy.kernel.util.IllegalActionException - If there is any error in calling the
wrapup() method defined in the script.
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||