ptolemy.actor.lib
Class Ramp

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.Source
                              extended byptolemy.actor.lib.SequenceSource
                                  extended byptolemy.actor.lib.Ramp
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, SequenceActor, java.io.Serializable, TypedActor

public class Ramp
extends SequenceSource

Produce an output token on each firing with a value that is incremented by the specified step each iteration. The first output is given by the init parameter, and the increment may be given either by the step parameter or by the associated step port. Note that the increment will show up in the output only on the next iteration. If you need it to show up on the current iteration, use the Accumulator actor. The type of the output is determined by the constraint that it must be greater than or equal to the types of the parameter (and/or the step port, if it is connected). Thus, this actor is polymorphic in the sense that its output data type can be that of any token type that supports addition.

Since:
Ptolemy II 0.2
Version:
$Id: Ramp.java,v 1.82 2004/04/13 03:03:51 cxh Exp $
Author:
Yuhong Xiong, Edward A. Lee
See Also:
Accumulator, Serialized Form
Accepted Rating:
Green (bilung)
Proposed Rating:
Green (eal)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 Parameter init
          The value produced by the ramp on its first iteration.
 PortParameter step
          The amount by which the ramp output is incremented on each iteration.
 
Fields inherited from class ptolemy.actor.lib.SequenceSource
_firingCountLimit, _iterationCount, firingCountLimit
 
Fields inherited from class ptolemy.actor.lib.Source
output, trigger
 
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
Ramp(CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
 java.lang.Object clone(Workspace workspace)
          Clone the actor into the specified workspace.
 void fire()
          Send the current value of the state of this actor to the output.
 void initialize()
          Set the state to equal the value of the init parameter.
 int iterate(int count)
          Invoke a specified number of iterations of this actor.
 boolean postfire()
          Update the state of the actor by adding the value of the step parameter to the state.
 
Methods inherited from class ptolemy.actor.lib.SequenceSource
attributeChanged
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, 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, 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
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

init

public Parameter init
The value produced by the ramp on its first iteration. The default value of this parameter is the integer 0.


step

public PortParameter step
The amount by which the ramp output is incremented on each iteration. The default value of this parameter is the integer 1.

Constructor Detail

Ramp

public Ramp(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 constructors, construct the init and step parameter and the step port. Initialize init to IntToken with value 0, and step to IntToken with value 1.

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

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException
Clone the actor into the specified workspace. This calls the base class and then sets the init and step public members to the parameters of the new actor.

Overrides:
clone in class AtomicActor
Parameters:
workspace - The workspace for the new object.
Returns:
A new actor.
Throws:
java.lang.CloneNotSupportedException - If a derived class contains an attribute that cannot be cloned.

fire

public void fire()
          throws IllegalActionException
Send the current value of the state of this actor to the output.

Specified by:
fire in interface Executable
Overrides:
fire in class Source
Throws:
IllegalActionException - If calling send() or super.fire() throws it.

initialize

public void initialize()
                throws IllegalActionException
Set the state to equal the value of the init parameter. The state is incremented by the value of the step parameter on each iteration (in the postfire() method).

Specified by:
initialize in interface Executable
Overrides:
initialize in class SequenceSource
Throws:
IllegalActionException - If the parent class throws it.

iterate

public int iterate(int count)
            throws IllegalActionException
Invoke a specified number of iterations of this actor. Each iteration updates the state of the actor by adding the value of the step parameter to the state and sending the value of the state to the output. The iteration count is also incremented by the value of count, and if the result is greater than or equal to firingCountLimit then return STOP_ITERATING.

This method should be called instead of the usual prefire(), fire(), postfire() methods when this actor is used in a domain that supports vectorized actors. This leads to more efficient execution.

Specified by:
iterate in interface Executable
Overrides:
iterate in class AtomicActor
Parameters:
count - The number of iterations to perform.
Returns:
COMPLETED if the actor was successfully iterated the specified number of times. Otherwise, if the maximum iteration count has been reached, return STOP_ITERATING.
Throws:
IllegalActionException - If iterating cannot be performed.

postfire

public boolean postfire()
                 throws IllegalActionException
Update the state of the actor by adding the value of the step parameter to the state. Also, increment the iteration count, and if the result is equal to firingCountLimit, then return false.

Specified by:
postfire in interface Executable
Overrides:
postfire in class SequenceSource
Returns:
False if the number of iterations matches the number requested.
Throws:
IllegalActionException - If the firingCountLimit parameter has an invalid expression.