ptolemy.domains.dde.lib
Class TimeAdvance

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.domains.dde.kernel.DDEActor
                              extended byptolemy.domains.dde.lib.TimeAdvance
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor

public class TimeAdvance
extends DDEActor

TimeAdvance is a simple DDE actor with an input and output multiport. When executed, a TimeAdvance will consume a token from its input port and then produce a DoubleToken on its output port with a value as specified by the 'outputValue' parameter. TimeAdvance is useful in conjunction with plotter classes (e.g., actor/lib/gui/TimedPlotter) where the value to be plotted is not as important as the time axis values.

Since:
Ptolemy II 0.3
Version:
$Id: TimeAdvance.java,v 1.26 2004/04/13 03:28:48 cxh Exp $
Author:
John S. Davis II
See Also:
Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (davisj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 TypedIOPort input
          The input port.
 TypedIOPort output
          The output port.
 Parameter outputValue
          A parameter used to specify the value of the DoubleTokens that are produced as outputs 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
TimeAdvance(CompositeEntity container, java.lang.String name)
          Construct a TimeAdvance actor with the specified container and name.
 
Method Summary
 void fire()
          Execute this actor by consuming a token on the input and producing a DoubleToken on the output with a value specified by the outputValue parameter.
 boolean postfire()
          Return true if this actor will allow subsequent iterations to occur; return false otherwise.
 
Methods inherited from class ptolemy.domains.dde.kernel.DDEActor
getLastPort, getNextToken
 
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, initialize, inputPortList, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup
 
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, attributeChanged, 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
initialize, iterate, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
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

output

public TypedIOPort output
The output port.


input

public TypedIOPort input
The input port.


outputValue

public Parameter outputValue
A parameter used to specify the value of the DoubleTokens that are produced as outputs of this actor.

Constructor Detail

TimeAdvance

public TimeAdvance(CompositeEntity container,
                   java.lang.String name)
            throws IllegalActionException,
                   NameDuplicationException
Construct a TimeAdvance actor with the specified container and name.

Parameters:
container - The TypedCompositeActor that contains this actor.
name - The name of this actor.
Throws:
NameDuplicationException - If the name of this actor duplicates that of a actor already contained by the container of this actor.
IllegalActionException - If there are errors in instantiating and specifying the type of this actor's ports.
Method Detail

fire

public void fire()
          throws IllegalActionException
Execute this actor by consuming a token on the input and producing a DoubleToken on the output with a value specified by the outputValue parameter.

Specified by:
fire in interface Executable
Overrides:
fire in class AtomicActor
Throws:
IllegalActionException - If there are errors in obtaining the receivers of this actor.

postfire

public boolean postfire()
                 throws IllegalActionException
Return true if this actor will allow subsequent iterations to occur; return false otherwise.

Specified by:
postfire in interface Executable
Overrides:
postfire in class AtomicActor
Returns:
True if continued execution is enabled; false otherwise.
Throws:
IllegalActionException - Not thrown in this base class.