org.sdm.spa

Class CommandLine

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

org.sdm.spa.CommandLine

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

StatusChecker

public class CommandLine
extends TypedAtomicActor

Given a command string, the CommandLine actor executes it using the java Runtime class.

SUPPORTED COMMAND TYPES:

• command
• command < infile > outfile
• command > outfile
• command < infile
• command [arg1..argn] > outfile
• command [arg1..argn]
• command [arg1..argn] < infile > outfile
• command1 | command 2 (Warning: This type of commands doesn't give the output of all the commands. Instead it outputs only the result of the last one.)

Example commands:

• C:/Program Files/Internet Explorer/IEXPLORE.EXE
  To generate this command, just double click on the actor and type this in the command parameter field.
• C:/cygwin/bin/perl.exe c:/project/kepler/test/workflows/example.pl > c:/project/kepler/test/workflows/example.out
• C:/cygwin/bin/dir.exe > dirTemp.txt

Author:

Ilkay Altintas

Category.name:

external execution, local

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
TypedIOPort	arguments
PortParameter	command
TypedIOPort	exitCode
Parameter	hasTrigger
SingletonParameter	hide
TypedIOPort	infileHandle
TypedIOPort	outfileHandle
TypedIOPort	output
FileParameter	outputFile
Parameter	outputLineByLine
TypedIOPort	trigger

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
CommandLine(CompositeEntity container, java.lang.String name) Construct a CommandLine actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	attributeChanged(Attribute attribute) If the specified attribute is showTriggerPort, then get the value of it and re-render the trigger port.
void	fire() ...
int	getSystemProps()

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _customTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup

Methods inherited from class ptolemy.kernel.ComponentEntity

_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName

Methods inherited from class ptolemy.kernel.Entity

_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

Methods inherited from class ptolemy.kernel.util.NamedObj

_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, 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, workspace

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, isStrict, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

hide

public SingletonParameter hide

command

public PortParameter command

Entity.description:

The command to execute.
FIX ME: The style of the command will be noted here.

outputFile

public FileParameter outputFile

Entity.description:

Needs to be filled in if the user wants the command to output to a file.

arguments

public TypedIOPort arguments

Entity.description:

The arguments to the command. Implemented as a multi/input port to support more than one argument. It concatanates the inputs in all the channels.
If there is an input file, this port can be empty.

infileHandle

public TypedIOPort infileHandle

Entity.description:

This is an optional port. Used if the file accepts an input file instead of a list of arguments.

trigger

public TypedIOPort trigger

Entity.description:

The trigger port. The type of this port is undeclared, meaning that it will resolve to any data type.

outfileHandle

public TypedIOPort outfileHandle

Entity.description:

A string that forwards the outputFile parameter if it exists.

output

public TypedIOPort output

Entity.description:

The result stream of the command.

exitCode

public TypedIOPort exitCode

Entity.description:

Exit code will be 1 if the command executes successfully.

outputLineByLine

public Parameter outputLineByLine

Entity.description:

If selected, broadcasts the output of the command line by line.

hasTrigger

public Parameter hasTrigger

Entity.description:

Unhide the trigger port when this parameter is true. This Parameter is type of boolean.
NOTE: in fact, user can use the port configuration window to hide or unhide a port. This paremeter is here to provide a more intuitive interface for this actor.

Constructor Detail

CommandLine

public CommandLine(CompositeEntity container,
                   java.lang.String name)
            throws IllegalActionException,
                   NameDuplicationException

Construct a CommandLine actor with the given container and name.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the actor cannot be contained by the proposed container.

NameDuplicationException - If the container already has an actor with this name.

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

If the specified attribute is showTriggerPort, then get the value of it and re-render the trigger port. If it is true, show the trigger port; if it is false, hide the trigger port.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that has changed.

Throws:

IllegalActionException.

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

fire

public void fire()
          throws IllegalActionException

... Send the exitCode and outputFileHandle(optional) to the result port.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is no director.

getSystemProps

public int getSystemProps()