org.sdm.spa

Class ProcessFileRT

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.ProcessFileRT

All Implemented Interfaces:

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

public class ProcessFileRT
extends TypedAtomicActor

no documentation yet.

Author:

Norbert Podhorszki

Category.name:

remote, connection, external execution

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
FileParameter	CkptFile
Parameter	cleanupAfterError Enforce killing remote process(es) after an error or timeout.
Parameter	Command The command to be executed on the remote host.
Parameter	doCheckOutput
Parameter	doCkpt
Parameter	doProcessing
FileParameter	ErrorLogFile
Parameter	ErrorTokenName
Parameter	Ext
TypedIOPort	filein Input file to work on (recordtype {name=string, data=long, size=long})
TypedIOPort	fileout Output file as result (recordtype {name=string, data=long, size=long})
Parameter	HostStr
Parameter	InDir
FileParameter	LogFile
Parameter	LogFormat
Parameter	LogHeader
Parameter	OutDir
Parameter	OutRemoteMachine
TypedIOPort	provenanceout Output file as result (recordtype {name=string, data=long, size=long}).
Parameter	RemoteMachine Target in user@host:port format.
Parameter	ReplaceExt
Parameter	StopFile
TypedIOPort	subs Substitutions (array of recordtype {name=string, value=string})
Parameter	thirdParty Third party target in user@host:port format.
Parameter	timeoutSeconds Timeout in seconds for the command to be executed. 0 means waiting indefinitely for command termination.

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
ProcessFileRT(CompositeEntity container, java.lang.String name) Construct an ExecuteCmd actor with the given container and name.

Method Summary

Modifier and Type	Method and Description
void	fire() Send the token in the value parameter to the output.
void	initialize() initialize() runs once before first exec

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, 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, attributeChanged, 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, 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

filein

public TypedIOPort filein

Input file to work on (recordtype {name=string, data=long, size=long})

fileout

public TypedIOPort fileout

Output file as result (recordtype {name=string, data=long, size=long})

subs

public TypedIOPort subs

Substitutions (array of recordtype {name=string, value=string})

provenanceout

public TypedIOPort provenanceout

Output file as result (recordtype {name=string, data=long, size=long}). For provenance purposes. Info comes from the remote command.

RemoteMachine

public Parameter RemoteMachine

Target in user@host:port format. If user is not provided, the local username will be used. If port is not provided, the default port 22 will be applied. If target is "local" or empty string, the command will be executed locally, using Java Runtime.

Command

public Parameter Command

The command to be executed on the remote host. It needs to be provided as a string.

InDir

public Parameter InDir

OutRemoteMachine

public Parameter OutRemoteMachine

OutDir

public Parameter OutDir

Ext

public Parameter Ext

ReplaceExt

public Parameter ReplaceExt

doProcessing

public Parameter doProcessing

doCkpt

public Parameter doCkpt

doCheckOutput

public Parameter doCheckOutput

LogHeader

public Parameter LogHeader

LogFile

public FileParameter LogFile

ErrorLogFile

public FileParameter ErrorLogFile

LogFormat

public Parameter LogFormat

CkptFile

public FileParameter CkptFile

StopFile

public Parameter StopFile

ErrorTokenName

public Parameter ErrorTokenName

HostStr

public Parameter HostStr

timeoutSeconds

public Parameter timeoutSeconds

Timeout in seconds for the command to be executed. 0 means waiting indefinitely for command termination.

cleanupAfterError

public Parameter cleanupAfterError

Enforce killing remote process(es) after an error or timeout. Unix specific solution is used, therefore you should not set this flag if connecting to other servers. But it is very useful for unix as timeout leaves processes living there, and sometimes errors too. All processes belonging to the same group as the remote command (i.e. its children) will be killed.

thirdParty

public Parameter thirdParty

Third party target in user@host:port format. If user is not provided, the local username will be used. If port is not provided, the default port 22 will be applied.

Constructor Detail

ProcessFileRT

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

Construct an ExecuteCmd actor with the given container and name. Create the parameters, initialize their values.

Parameters:

container - The container.

name - The name of this actor.

Throws:

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

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

Method Detail

initialize

public void initialize()
                throws IllegalActionException

initialize() runs once before first exec

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If the parent class throws it.

fire

public void fire()
          throws IllegalActionException

Send the token in the value parameter to the output.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If it is thrown by the send() method sending out the token.