org.kepler.ddp.actor

Class ExecutionChoice

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity

ptolemy.kernel.CompositeEntity

ptolemy.actor.CompositeActor

ptolemy.actor.TypedCompositeActor

ptolemy.actor.lib.hoc.MultiCompositeActor

ptolemy.actor.lib.hoc.Case

org.kepler.ddp.actor.ExecutionChoice

All Implemented Interfaces:

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

public class ExecutionChoice
extends Case
implements ChangeListener, IOPortEventListener

An actor that supports multiple choices for execution. Each choice is a sub-workflow that can either be loaded from a set of templates, or created by the user. Each file input port has an associated parameter. When an input token is read, the associated parameter's value is set to the be token. Each file output also has an associated parameter. When the execution choice finishes, the value of the parameter is written to the output port.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExecutionChoice.IOType The types of input/outputs.
static class	ExecutionChoice.ParameterType The types of parameters.

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

CompositeEntity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
StringParameter	additionalOptions Additional command line options.
static java.lang.String	ALL_CHOICES_NAME String constant to denote all execution choices.
static java.lang.String	ARGUMENT_NAME The name of the (optional) attribute contained in parameters.
Parameter	checkOutputTimestamp If true, verify the last modification timestamp for each output file has increased after execution.
static java.lang.String	COMMAND_LINE_NAME The name of the command line parameter in each refinement.
static java.lang.String	DEFAULT_INPUT_DIR_NAME The name of the default input directory.
static java.lang.String	DEFAULT_INPUT_FILE_NAME The name of the default input file.
static java.lang.String	DEFAULT_OUTPUT_DIR_NAME The name of the default output directory.
static java.lang.String	DEFAULT_OUTPUT_FILE_NAME The name of the default output file.
static java.lang.String	DEFAULT_TEMPLATE_NAME The name of the default template.
StringParameter	program The command line program to execute.

Fields inherited from class ptolemy.actor.lib.hoc.Case

_current, _default, _director, control

Fields inherited from class ptolemy.actor.CompositeActor

_actorFiringListeners, _causalityInterface, _derivedPiggybacks, _initializables, _notifyingActorFiring, _piggybacks, _publishedPorts, _publisherRelations, _stopRequested, _subscribedPorts

Fields inherited from class ptolemy.kernel.CompositeEntity

_levelCrossingLinks

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
ExecutionChoice(CompositeEntity container, java.lang.String name) Create a new ExecutionChoice in a container with the specified name.
ExecutionChoice(Workspace workspace) Create a new ExecutionChoice in a workspace.

Method Summary

Modifier and Type	Method and Description
protected ExecutionChoiceDirector	_createDirector() Create a director.
protected void	_setCurrentRefinement(Refinement refinement) Set the refinement to execute.
void	addDefaultExecutionChoice() Add default execution choice if none are present.
boolean	addDefaultInputsAndOutputs() Add default inputs and outputs if none are present.
static boolean	addDefaultInputsAndOutputs(ExecutionChoice choice) Add default inputs and outputs if non are present for an ExecutionChoice.
void	addDefaults()
void	attributeChanged(Attribute attribute) React to a change in an attribute.
void	changeExecuted(ChangeRequest change) React to the fact that the change has been successfully executed by doing nothing.
void	changeFailed(ChangeRequest change, java.lang.Exception exception) React to the fact that the change has failed by reporting it.
java.lang.Object	clone(Workspace workspace) Override the base class to ensure that the member fields are initialized.
void	exportExecutionChoice(java.io.File saveFile, java.lang.String name) Export an execution choice to a file.
void	fire() Override the base class to not read inputs, since this has been done in prefire().
static java.lang.String	getArgument(NamedObj container, java.lang.String name) Get the command line argument for a parameter in a specific container
java.lang.String	getArgument(java.lang.String name) Get the command line argument for a parameter.
static StringParameter	getArgumentParameter(NamedObj container, java.lang.String name) Get the parameter containing the command line argument for a parameter in a specific container.
StringParameter	getArgumentParameter(java.lang.String name) Get the parameter containing the command line argument for a parameter.
java.util.List<java.lang.String>	getExecutionChoiceNames() Get a list of execution choice names.
java.util.List<java.lang.String>	getInputNames() Get a list of file input names.
java.util.List<java.lang.String>	getInputNames(boolean includeData) Get a list of input port names.
java.util.List<java.lang.String>	getOutputNames() Get a list of file output names.
java.util.List<java.lang.String>	getOutputNames(boolean includeData) Get a list of output port names.
java.util.List<java.lang.String>	getParameterNames() Get a list of parameter names.
static ExecutionChoice.ParameterType	getParameterType(NamedObj container, java.lang.String name) Get the parameter type for a parameter in a container within this actor.
ExecutionChoice.ParameterType	getParameterType(java.lang.String name) Get the parameter type for a parameter.
static ExecutionChoice.IOType	getPortIOType(Port port) Get the IOType for a port.
java.util.Set<java.lang.String>	getTemplateNames() Get the available template names.
boolean	hasInput(java.lang.String name) Returns true if there is an input with the given name.
boolean	hasOutput(java.lang.String name) Returns true if there is an output with the given name.
Refinement	newExecutionChoice(java.io.File templateFile, java.lang.String refinementName) Create a new execution choice from a file.
Refinement	newExecutionChoice(java.lang.String templateName, java.lang.String refinementName) Create a new execution choice from a template.
void	newInput(java.lang.String name, ExecutionChoice.IOType type) Create a new file input.
void	newInput(java.lang.String name, ExecutionChoice.IOType type, java.lang.String argument) Create a new file input.
void	newOutput(java.lang.String name, ExecutionChoice.IOType type) Create a new file output.
void	newOutput(java.lang.String name, ExecutionChoice.IOType type, java.lang.String argument) Create a new file output.
void	newParameter(java.lang.String name, java.lang.String argument) Add a new parameter.
void	newParameter(java.lang.String name, java.lang.String argument, java.lang.String value) Add a new parameter.
void	newParameter(java.lang.String name, java.lang.String argument, java.lang.String value, java.lang.String choice, ExecutionChoice.ParameterType type) Add a new parameter.
void	portEvent(IOPortEvent event) Receive a port event.
void	preinitialize() List to port events for File input ports so that when a token is read, we can set the corresponding parameter.
void	removeExecutionChoice(java.lang.String name) Remove an execution choice.
void	removeInput(java.lang.String name) Remove a file input.
void	removeOutput(java.lang.String name) Remove a file output.
void	removeParameter(java.lang.String name) Remove a parameter.
void	renameExecutionChoice(java.lang.String oldName, java.lang.String newName) Rename an execution choice.
void	renameInput(java.lang.String oldName, java.lang.String newName) Rename an input.
void	renameOutput(java.lang.String oldName, java.lang.String newName) Rename an output.
boolean	renameParameter(java.lang.String oldName, java.lang.String newName) Rename a parameter.
boolean	renameParameter(java.lang.String oldName, java.lang.String newName, NamedObj container) Rename a parameter in the specified container.
static void	setArgument(Parameter parameter, java.lang.String argument) Set the command line argument for a parameter.
static void	setParameterType(NamedObj container, java.lang.String name, ExecutionChoice.ParameterType type) Set the ParameterType for a parameter in contained in a sub-workflow.
void	setParameterType(java.lang.String name, ExecutionChoice.ParameterType type) Set the ParameterType for a parameter contained by this actor.
void	setPortIOType(TypedIOPort port, ExecutionChoice.IOType type) Set the PortType for a port.
void	updateExecutionChoices() Update the execution choices in the control parameter.
void	wrapup() Perform cleanup.

Methods inherited from class ptolemy.actor.lib.hoc.Case

_addEntity, getCurrentRefinement, newRefinement, refinementClassName

Methods inherited from class ptolemy.actor.lib.hoc.MultiCompositeActor

mirrorContainerPortsInRefinement, newPort

Methods inherited from class ptolemy.actor.TypedCompositeActor

_addPort, _addRelation, _checkTypesFromTo, _destinationTypeConstraints, attributeTypeChanged, isBackwardTypeInferenceEnabled, newRelation, resolveTypes, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.CompositeActor

_actorFiring, _actorFiring, _finishedAddEntity, _setDirector, _transferPortParameterInputs, addActorFiringListener, addInitializable, addPiggyback, connectionsChanged, createReceivers, createSchedule, getCausalityInterface, getDirector, getExecutiveDirector, getManager, getPublishedPort, getPublishedPortChannel, getPublishedPorts, getSubscribedPortChannel, inferringWidths, inferWidths, initialize, inputPortList, isFireFunctional, isOpaque, isPublishedPort, isStrict, iterate, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, linkToPublishedPort, needsWidthInference, newInsideReceiver, newReceiver, notifyConnectivityChange, outputPortList, postfire, prefire, recordFiring, registerPublisherPort, registerPublisherPort, removeActorFiringListener, removeInitializable, removePiggyback, requestChange, setContainer, setDirector, setManager, stop, stopFire, terminate, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unlinkToPublishedPort, unregisterPublisherPort, unregisterPublisherPort

Methods inherited from class ptolemy.kernel.CompositeEntity

_adjustDeferrals, _containedDecorators, _deepOpaqueEntityList, _description, _exportMoMLContents, _removeEntity, _removeRelation, _validateSettables, allAtomicEntityList, allowLevelCrossingConnect, classDefinitionList, connect, connect, containedObjectsIterator, deepCompositeEntityList, deepEntityList, deepGetEntities, deepNamedObjList, deepOpaqueEntityList, deepRelationSet, entityList, entityList, exportLinks, exportMoML, getAttribute, getEntities, getEntity, getPort, getRelation, getRelations, isAtomic, lazyAllAtomicEntityList, lazyAllCompositeEntityList, lazyAllCompositeTransparentAndOpaqueEntityList, lazyClassDefinitionList, lazyDeepEntityList, lazyEntityList, lazyRelationList, numberOfEntities, numberOfRelations, numEntities, numRelations, relationList, removeAllEntities, removeAllRelations, setClassDefinition, statistics, uniqueName

Methods inherited from class ptolemy.kernel.ComponentEntity

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

Methods inherited from class ptolemy.kernel.Entity

_removePort, connectedPortList, connectedPorts, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts

Methods inherited from class ptolemy.kernel.InstantiableNamedObj

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

Methods inherited from class ptolemy.kernel.util.NamedObj

_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, 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, 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, removeInitializable

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

program

public StringParameter program

The command line program to execute.

additionalOptions

public StringParameter additionalOptions

Additional command line options.

checkOutputTimestamp

public Parameter checkOutputTimestamp

If true, verify the last modification timestamp for each output file has increased after execution. If the timestamp has not increased, throw an error.

DEFAULT_TEMPLATE_NAME

public static final java.lang.String DEFAULT_TEMPLATE_NAME

The name of the default template.

See Also:

Constant Field Values

DEFAULT_INPUT_DIR_NAME

public static final java.lang.String DEFAULT_INPUT_DIR_NAME

The name of the default input directory.

See Also:

Constant Field Values

DEFAULT_OUTPUT_DIR_NAME

public static final java.lang.String DEFAULT_OUTPUT_DIR_NAME

The name of the default output directory.

See Also:

Constant Field Values

DEFAULT_INPUT_FILE_NAME

public static final java.lang.String DEFAULT_INPUT_FILE_NAME

The name of the default input file.

See Also:

Constant Field Values

DEFAULT_OUTPUT_FILE_NAME

public static final java.lang.String DEFAULT_OUTPUT_FILE_NAME

The name of the default output file.

See Also:

Constant Field Values

ALL_CHOICES_NAME

public static final java.lang.String ALL_CHOICES_NAME

String constant to denote all execution choices.

See Also:

Constant Field Values

ARGUMENT_NAME

public static final java.lang.String ARGUMENT_NAME

The name of the (optional) attribute contained in parameters. The value of this attribute is the command-line argument for the parameter, e.g., "-e".

See Also:

Constant Field Values

COMMAND_LINE_NAME

public static final java.lang.String COMMAND_LINE_NAME

The name of the command line parameter in each refinement.

See Also:

Constant Field Values

Constructor Detail

ExecutionChoice

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

Create a new ExecutionChoice in a container with the specified name.

Throws:

IllegalActionException

NameDuplicationException

ExecutionChoice

public ExecutionChoice(Workspace workspace)
                throws IllegalActionException,
                       NameDuplicationException

Create a new ExecutionChoice in a workspace.

Throws:

IllegalActionException

NameDuplicationException

Method Detail

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

React to a change in an attribute.

Overrides:

attributeChanged in class TypedCompositeActor

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - Not thrown in this base class. Derived classes can throw this exception if type change is not allowed.

changeExecuted

public void changeExecuted(ChangeRequest change)

React to the fact that the change has been successfully executed by doing nothing.

Specified by:

changeExecuted in interface ChangeListener

Parameters:

change - The change that has been executed.

changeFailed

public void changeFailed(ChangeRequest change,
                         java.lang.Exception exception)

React to the fact that the change has failed by reporting it.

Specified by:

changeFailed in interface ChangeListener

Parameters:

change - The change that was attempted.

exception - The exception that resulted.

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Override the base class to ensure that the member fields are initialized.

Overrides:

clone in class Case

Parameters:

workspace - The workspace for the new object.

Returns:

A new ExecutionChoice.

Throws:

java.lang.CloneNotSupportedException - If any of the attributes cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

exportExecutionChoice

public void exportExecutionChoice(java.io.File saveFile,
                                  java.lang.String name)
                           throws IllegalActionException,
                                  NameDuplicationException

Export an execution choice to a file.

Parameters:

saveFile - the file to write the execution choice as a MoML XML.

name - the name of the execution choice to save.

Throws:

IllegalActionException

NameDuplicationException

fire

public void fire()
          throws IllegalActionException

Description copied from class: Case

Override the base class to not read inputs, since this has been done in prefire(). Fire the current refinement, and then send any output data created by calling the local director's transferOutputs method.

Specified by:

fire in interface Executable

Overrides:

fire in class Case

Throws:

IllegalActionException - If there is no director, or if the director's fire() method throws it, or if the actor is not opaque.

getArgument

public java.lang.String getArgument(java.lang.String name)
                             throws IllegalActionException

Get the command line argument for a parameter.

Parameters:

name - the name of the parameter

Returns:

the command line argument if one was set, otherwise null

Throws:

IllegalActionException

getArgument

public static java.lang.String getArgument(NamedObj container,
                                           java.lang.String name)
                                    throws IllegalActionException

Get the command line argument for a parameter in a specific container

Parameters:

container - the container

name - the name of the parameter

Returns:

the command line argument if one was set, otherwise null

Throws:

IllegalActionException

getArgumentParameter

public StringParameter getArgumentParameter(java.lang.String name)
                                     throws IllegalActionException

Get the parameter containing the command line argument for a parameter.

Parameters:

name - the name of the parameter

Returns:

the parameter containing the value of the argument

Throws:

IllegalActionException

getArgumentParameter

public static StringParameter getArgumentParameter(NamedObj container,
                                                   java.lang.String name)
                                            throws IllegalActionException

Get the parameter containing the command line argument for a parameter in a specific container.

Parameters:

container - the container

name - the name of the parameter

Returns:

the parameter containing the value of the argument

Throws:

IllegalActionException

getExecutionChoiceNames

public java.util.List<java.lang.String> getExecutionChoiceNames()

Get a list of execution choice names.

getInputNames

public java.util.List<java.lang.String> getInputNames()
                                               throws IllegalActionException

Get a list of file input names.

Throws:

IllegalActionException

getInputNames

public java.util.List<java.lang.String> getInputNames(boolean includeData)
                                               throws IllegalActionException

Get a list of input port names.

Throws:

IllegalActionException

getOutputNames

public java.util.List<java.lang.String> getOutputNames()
                                                throws IllegalActionException

Get a list of file output names.

Throws:

IllegalActionException

getOutputNames

public java.util.List<java.lang.String> getOutputNames(boolean includeData)
                                                throws IllegalActionException

Get a list of output port names.

Throws:

IllegalActionException

getParameterNames

public java.util.List<java.lang.String> getParameterNames()
                                                   throws IllegalActionException

Get a list of parameter names. The returned list does not include parameters associated with inputs or outputs, fields of ExecutionChoice, visibility set to none, or names starting with "_".

Throws:

IllegalActionException

getParameterType

public ExecutionChoice.ParameterType getParameterType(java.lang.String name)
                                               throws IllegalActionException

Get the parameter type for a parameter.

Throws:

IllegalActionException

getParameterType

public static ExecutionChoice.ParameterType getParameterType(NamedObj container,
                                                             java.lang.String name)
                                                      throws IllegalActionException

Get the parameter type for a parameter in a container within this actor.

Throws:

IllegalActionException

getPortIOType

public static ExecutionChoice.IOType getPortIOType(Port port)
                                            throws IllegalActionException

Get the IOType for a port.

Throws:

IllegalActionException

getTemplateNames

public java.util.Set<java.lang.String> getTemplateNames()
                                                 throws IllegalActionException

Get the available template names.

Throws:

IllegalActionException

hasInput

public boolean hasInput(java.lang.String name)

Returns true if there is an input with the given name.

hasOutput

public boolean hasOutput(java.lang.String name)

Returns true if there is an output with the given name.

newExecutionChoice

public Refinement newExecutionChoice(java.lang.String templateName,
                                     java.lang.String refinementName)
                              throws IllegalActionException

Create a new execution choice from a template.

Parameters:

templateName - the name of the template. The template name must be contained in the set of names return by getTemplateNames().

name - the name to give the new refinement

Returns:

The refinement created for the new execution choice.

Throws:

IllegalActionException

newExecutionChoice

public Refinement newExecutionChoice(java.io.File templateFile,
                                     java.lang.String refinementName)
                              throws IllegalActionException

Create a new execution choice from a file.

Parameters:

templateFile - the containing the MoML of the execution choice.

name - the name to give the new refinement.

Returns:

The refinement created for the new execution choice.

Throws:

IllegalActionException

newInput

public void newInput(java.lang.String name,
                     ExecutionChoice.IOType type)
              throws NameDuplicationException,
                     IllegalActionException

Create a new file input.

Throws:

NameDuplicationException

IllegalActionException

newInput

public void newInput(java.lang.String name,
                     ExecutionChoice.IOType type,
                     java.lang.String argument)
              throws NameDuplicationException,
                     IllegalActionException

Create a new file input.

Throws:

NameDuplicationException

IllegalActionException

newOutput

public void newOutput(java.lang.String name,
                      ExecutionChoice.IOType type)
               throws IllegalActionException,
                      NameDuplicationException

Create a new file output.

Throws:

IllegalActionException

NameDuplicationException

newOutput

public void newOutput(java.lang.String name,
                      ExecutionChoice.IOType type,
                      java.lang.String argument)
               throws IllegalActionException,
                      NameDuplicationException

Create a new file output.

Throws:

IllegalActionException

NameDuplicationException

newParameter

public void newParameter(java.lang.String name,
                         java.lang.String argument)
                  throws IllegalActionException,
                         NameDuplicationException

Add a new parameter.

Parameters:

name - the parameter name

argument - the command line argument for this parameter. this can be null.

Throws:

IllegalActionException

NameDuplicationException

newParameter

public void newParameter(java.lang.String name,
                         java.lang.String argument,
                         java.lang.String value)
                  throws IllegalActionException,
                         NameDuplicationException

Add a new parameter.

Parameters:

name - the parameter name

argument - the command line argument for this parameter. this can be null.

value - the default value for the paramete. this can be null.

Throws:

IllegalActionException

NameDuplicationException

newParameter

public void newParameter(java.lang.String name,
                         java.lang.String argument,
                         java.lang.String value,
                         java.lang.String choice,
                         ExecutionChoice.ParameterType type)
                  throws IllegalActionException,
                         NameDuplicationException

Add a new parameter.

Parameters:

name - the parameter name

argument - the command line argument for this parameter. this can be null.

value - the default value for the paramete. this can be null.

choice - the refinement in which to add the parameter. if null or set to ALL_CHOICES_NAME, the parameter is added to this actor.

Throws:

IllegalActionException

NameDuplicationException

portEvent

public void portEvent(IOPortEvent event)
               throws IllegalActionException

Receive a port event. If the port is an input port and has an associated parameter, set the value of the parameter to be the token read by the port.

Specified by:

portEvent in interface IOPortEventListener

Parameters:

event - The event to report.

Throws:

IllegalActionException - If thrown by the implementation.

preinitialize

public void preinitialize()
                   throws IllegalActionException

List to port events for File input ports so that when a token is read, we can set the corresponding parameter. Also, make sure output Data file ports that are connected outside are connected in the current refinement.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class CompositeActor

Throws:

IllegalActionException - If there is no director, or if the director's preinitialize() method throws it, or if this actor is not opaque.

See Also:

#portEvent()

removeExecutionChoice

public void removeExecutionChoice(java.lang.String name)
                           throws IllegalActionException,
                                  NameDuplicationException

Remove an execution choice.

Throws:

IllegalActionException

NameDuplicationException

removeInput

public void removeInput(java.lang.String name)
                 throws java.lang.Exception

Remove a file input.

Throws:

java.lang.Exception

removeOutput

public void removeOutput(java.lang.String name)
                  throws java.lang.Exception

Remove a file output.

Throws:

java.lang.Exception

removeParameter

public void removeParameter(java.lang.String name)
                     throws java.lang.Exception

Remove a parameter.

Throws:

java.lang.Exception

renameExecutionChoice

public void renameExecutionChoice(java.lang.String oldName,
                                  java.lang.String newName)

Rename an execution choice.

renameInput

public void renameInput(java.lang.String oldName,
                        java.lang.String newName)

Rename an input.

renameParameter

public boolean renameParameter(java.lang.String oldName,
                               java.lang.String newName)

Rename a parameter.

renameParameter

public boolean renameParameter(java.lang.String oldName,
                               java.lang.String newName,
                               NamedObj container)

Rename a parameter in the specified container.

renameOutput

public void renameOutput(java.lang.String oldName,
                         java.lang.String newName)

Rename an output.

setArgument

public static void setArgument(Parameter parameter,
                               java.lang.String argument)
                        throws IllegalActionException,
                               NameDuplicationException

Set the command line argument for a parameter.

Throws:

IllegalActionException

NameDuplicationException

setParameterType

public void setParameterType(java.lang.String name,
                             ExecutionChoice.ParameterType type)
                      throws IllegalActionException,
                             NameDuplicationException

Set the ParameterType for a parameter contained by this actor.

Throws:

IllegalActionException

NameDuplicationException

setParameterType

public static void setParameterType(NamedObj container,
                                    java.lang.String name,
                                    ExecutionChoice.ParameterType type)
                             throws IllegalActionException,
                                    NameDuplicationException

Set the ParameterType for a parameter in contained in a sub-workflow.

Throws:

IllegalActionException

NameDuplicationException

setPortIOType

public void setPortIOType(TypedIOPort port,
                          ExecutionChoice.IOType type)
                   throws IllegalActionException,
                          NameDuplicationException

Set the PortType for a port.

Throws:

IllegalActionException

NameDuplicationException

updateExecutionChoices

public void updateExecutionChoices()
                            throws IllegalActionException

Update the execution choices in the control parameter.

Throws:

IllegalActionException

wrapup

public void wrapup()
            throws IllegalActionException

Perform cleanup. Stop listening to input ports.

Specified by:

wrapup in interface Initializable

Overrides:

wrapup in class CompositeActor

Throws:

IllegalActionException - If there is no director, or if the director's wrapup() method throws it, or if this actor is not opaque.

_createDirector

protected ExecutionChoiceDirector _createDirector()
                                           throws IllegalActionException,
                                                  NameDuplicationException

Create a director. This base class creates an instance of CaseDirector.

Overrides:

_createDirector in class Case

Returns:

The created director.

Throws:

IllegalActionException - If the director cannot be created.

NameDuplicationException - If there is already an attribute with the name "_director".

_setCurrentRefinement

protected void _setCurrentRefinement(Refinement refinement)

Set the refinement to execute.

addDefaults

public void addDefaults()
                 throws IllegalActionException,
                        NameDuplicationException

Throws:

IllegalActionException

NameDuplicationException

addDefaultExecutionChoice

public void addDefaultExecutionChoice()
                               throws IllegalActionException

Add default execution choice if none are present.

Throws:

IllegalActionException

addDefaultInputsAndOutputs

public boolean addDefaultInputsAndOutputs()
                                   throws NameDuplicationException,
                                          IllegalActionException

Add default inputs and outputs if none are present.

Returns:

true if inputs/outputs were created.

Throws:

NameDuplicationException

IllegalActionException

addDefaultInputsAndOutputs

public static boolean addDefaultInputsAndOutputs(ExecutionChoice choice)
                                          throws IllegalActionException,
                                                 NameDuplicationException

Add default inputs and outputs if non are present for an ExecutionChoice.

Returns:

true if inputs/outputs were created.

Throws:

IllegalActionException

NameDuplicationException