ptolemy.actor.lib
Class Pulse
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.Source
ptolemy.actor.lib.SequenceSource
ptolemy.actor.lib.Pulse
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, SequenceActor, java.io.Serializable, TypedActor
- public class Pulse
- extends SequenceSource
Produce a pulse with a shape specified by the parameters.
The values parameter contains an ArrayToken, which specifies
the sequence of values to produce at the output. The indexes
parameter contains an array of integers, which specifies when those values
should be produced. The array in the indexes parameter
must have the same length as that in the
values parameter or an exception will be thrown by the fire() method.
Also, the indexes array must be increasing and non-negative,
or an exception will be thrown when it is set.
Eventually, this actor will support various kinds of interpolation.
For now, it outputs a zero (of the same type as the values) whenever
the iteration count does not match an index in indexes.
The default for the values parameter is
an integer vector of form {1, 0}.
The default indexes array is {0, 1}.
Thus, the default output sequence will be 1, 0, 0, ...
However, the Pulse actor has a repeat parameter. When set to
true, the defined sequence is repeated indefinitely. Otherwise, the
default sequence of zero values result.
The type of the output can be any token type. This type is inferred
from the element type of the values parameter.
NOTE: A reset input for this actor would be useful. This would reset
the iterations count, to cause the pulse to emerge again.
- Since:
- Ptolemy II 0.2
- Version:
- $Id: Pulse.java,v 1.58 2004/04/13 03:03:47 cxh Exp $
- Author:
- Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
Parameter |
indexes
The indexes at which the specified values will be produced.
|
Parameter |
repeat
The flag that indicates whether the pulse sequence needs to be
repeated. |
Parameter |
values
The values that will be produced at the specified indexes.
|
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Constructor Summary |
Pulse(CompositeEntity container,
java.lang.String name)
Construct an actor with the specified container and name. |
|
Method Summary |
void |
attributeChanged(Attribute attribute)
If the attribute being changed is indexes, then check
that it is increasing and nonnegative. |
java.lang.Object |
clone(Workspace workspace)
Clone the actor into the specified workspace. |
void |
fire()
Output a value if the count of iterations matches one of the entries
in the indexes array.
|
void |
initialize()
Set the iteration count to zero. |
boolean |
postfire()
Update the iteration counters until they exceed the values
in the indexes array. |
boolean |
prefire()
Start an iteration. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup |
| 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.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 |
indexes
public Parameter indexes
- The indexes at which the specified values will be produced.
This parameter is an array of integers, with default value {0, 1}.
repeat
public Parameter repeat
- The flag that indicates whether the pulse sequence needs to be
repeated. This is a boolean, and defaults to false.
values
public Parameter values
- The values that will be produced at the specified indexes.
This parameter is an array, with default value {1, 0}.
Pulse
public Pulse(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Construct an actor with the specified container and name.
- 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.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- If the attribute being changed is indexes, then check
that it is increasing and nonnegative.
- Overrides:
attributeChanged in class SequenceSource
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - If the indexes vector is not
increasing and nonnegative, or the indexes is not a row vector.
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 parameter public members to refer
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
- Output a value if the count of iterations matches one of the entries
in the indexes array.
Otherwise output a zero token with the same type as the values in
the value array.
- Specified by:
fire in interface Executable- Overrides:
fire in class Source
- Throws:
IllegalActionException - If the values and indexes parameters
do not have the same length, or if there is no director.
initialize
public void initialize()
throws IllegalActionException
- Set the iteration count to zero.
- Specified by:
initialize in interface Executable- Overrides:
initialize in class SequenceSource
- Throws:
IllegalActionException - If the parent class throws it.
postfire
public boolean postfire()
throws IllegalActionException
- Update the iteration counters until they exceed the values
in the indexes array.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class SequenceSource
- Throws:
IllegalActionException - If the expression of indexes
is not valid.
prefire
public boolean prefire()
throws IllegalActionException
- Start an iteration.
- Specified by:
prefire in interface Executable- Overrides:
prefire in class AtomicActor
- Returns:
- True if this actor is ready for firing, false otherwise.
- Throws:
IllegalActionException - If the base class throws it.