ptolemy.actor.lib.python
Class PythonScript

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.python.PythonScript
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor

public class PythonScript
extends TypedAtomicActor

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.

Since:
Ptolemy II 2.3
Version:
$Id: PythonScript.java,v 1.23 2004/04/13 05:13:17 cxh Exp $
Author:
Xiaojun Liu
See Also:
Python, Jython, Serialized Form
Accepted Rating:
Red (reviewmoderator)
Proposed Rating:
Yellow (liuxj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 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(CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 void attributeChanged(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

script

public StringAttribute script
The script that specifies the function of this actor. The default value provides an empty template.

Constructor Detail

PythonScript

public PythonScript(CompositeEntity container,
                    java.lang.String name)
             throws NameDuplicationException,
                    IllegalActionException
Construct an actor with the given container and name. In addition to invoking the base class constructor, create the script parameter, and initialize the script to provide an empty template.

Parameters:
container - The container.
name - The name of this actor.
Throws:
NameDuplicationException - If the container already has an actor with this name.
IllegalActionException - If the actor cannot be contained by the proposed container.
Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException
If script is changed, invoke the python interpreter to evaluate the script.

Overrides:
attributeChanged in class NamedObj
Parameters:
attribute - The attribute that changed.
Throws:
IllegalActionException - If there is any error in evaluating the script.

debug

public void debug(java.lang.String message)
Send the message to all registered debug listeners. In the script, use self.actor.debug() to call this method.

Parameters:
message - The debug message.

fire

public void fire()
          throws IllegalActionException
Invoke the fire() method if defined in the script.

Specified by:
fire in interface Executable
Overrides:
fire in class AtomicActor
Throws:
IllegalActionException - If there is any error in calling the fire() method defined by the script.

initialize

public void initialize()
                throws IllegalActionException
Invoke the initialize() method if defined in the script.

Specified by:
initialize in interface Executable
Overrides:
initialize in class AtomicActor
Throws:
IllegalActionException - If there is any error in calling the initialize() method defined by the script.

isDebugging

public boolean isDebugging()
Return true if this actor has at least one debug listener.

Returns:
True if this actor has at least one debug listener.

postfire

public boolean postfire()
                 throws IllegalActionException
Invoke the postfire() method if defined in the script. Return true when the method return value is not zero, or the method does not return a value, or the method is not defined in the script.

Specified by:
postfire in interface Executable
Overrides:
postfire in class AtomicActor
Returns:
False if postfire() is defined in the script and returns 0, true otherwise.
Throws:
IllegalActionException - If there is any error in calling the postfire() method defined by the script.

prefire

public boolean prefire()
                throws IllegalActionException
Invoke the prefire() method if defined in the script. Return true when the method return value is not zero, or the method does not return a value, or the method is not defined in the script.

Specified by:
prefire in interface Executable
Overrides:
prefire in class AtomicActor
Returns:
False if prefire() is defined in the script and returns 0, true otherwise.
Throws:
IllegalActionException - If there is any error in calling the prefire() method.

preinitialize

public void preinitialize()
                   throws IllegalActionException
Create an instance of the Main class defined in the script. Add all parameters and ports of this actor as attributes of the object, so that they become accessible to the methods defined in the script.

Specified by:
preinitialize in interface Executable
Overrides:
preinitialize in class AtomicActor
Throws:
IllegalActionException - If there is any error in creating an instance of the Main class defined in the script.

stop

public void stop()
Invoke the stop() method if defined in the script. Ignore any error in calling the method.

Specified by:
stop in interface Executable
Overrides:
stop in class AtomicActor

stopFire

public void stopFire()
Invoke the stopFire() method if defined in the script. Ignore any error in calling the method.

Specified by:
stopFire in interface Executable
Overrides:
stopFire in class AtomicActor

terminate

public void terminate()
Invoke the terminate() method if defined in the script. Ignore any error in calling the method.

Specified by:
terminate in interface Executable
Overrides:
terminate in class AtomicActor

wrapup

public void wrapup()
            throws IllegalActionException
Invoke the wrapup() method if defined in the script. Ignore any error in calling the method.

Specified by:
wrapup in interface Executable
Overrides:
wrapup in class AtomicActor
Throws:
IllegalActionException - If there is any error in calling the wrapup() method defined in the script.