|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.LimitedFiringSource ptolemy.actor.lib.SequenceSource ptolemy.backtrack.automatic.ptolemy.actor.lib.Interpolator
public class Interpolator
Produce an interpolation based on the parameters. This class uses the Interpolation class in the math package to compute the interpolation. The values parameter specifies a sequence of values to produce at the output. The indexes parameter specifies when those values should be produced. The values and indexes parameters must both contain arrays, and have equal lengths or an exception will be thrown. The indexes array must be increasing and non-negative. The values are periodic if the period parameter contains a positive value. In this case, the period must be greater than the largest index, and values within the index range 0 to (period-1) are repeated indefinitely. If the period is zero, the values are not periodic, and the values outside the range of the indexes are considered to be 0.0. The order parameter specifies which order of interpolation to apply whenever the iteration count does not match an index in indexes. The Interpolation class currently supports zero, first, and third order interpolations. The default parameter are those set in the Interpolation class.
This actor counts iterations. Whenever the iteration count matches an entry in the indexes array, the corresponding entry (at the same position) in the values array is produced at the output. Whenever the iteration count does not match a value in the indexes array, an interpolation of the values is produced at the output.
Output type is DoubleToken.
Interpolation
,
Serialized Form
Yellow (yuhong) |
Yellow (yuhong) |
Nested Class Summary |
---|
Nested classes/interfaces inherited from class ptolemy.kernel.Entity |
---|
Entity.ContainedObjectsIterator |
Field Summary | |
---|---|
private int[] |
_indexes
|
private ptolemy.backtrack.automatic.ptolemy.math.Interpolation |
_interpolation
|
private int |
_iterationCount
|
private double[] |
_values
|
protected Checkpoint |
$CHECKPOINT
|
private FieldRecord |
$RECORD$_indexes
|
private FieldRecord |
$RECORD$_interpolation
|
private FieldRecord |
$RECORD$_iterationCount
|
private FieldRecord |
$RECORD$_values
|
protected CheckpointRecord |
$RECORD$$CHECKPOINT
|
private FieldRecord[] |
$RECORDS
|
Parameter |
indexes
The indexes at which the specified values will be produced. |
Parameter |
order
The order of interpolation for non-index iterations. |
Parameter |
period
The period of the reference values. |
Parameter |
values
The values that will be produced at the specified indexes. |
Fields inherited from class ptolemy.actor.lib.LimitedFiringSource |
---|
_firingCountLimit, firingCountLimit |
Fields inherited from class ptolemy.actor.lib.Source |
---|
output, trigger |
Fields inherited from class ptolemy.actor.AtomicActor |
---|
_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested |
Fields inherited from class ptolemy.kernel.util.NamedObj |
---|
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _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 | |
---|---|
Interpolator(CompositeEntity container,
java.lang.String name)
Construct an actor with the specified container and name. |
Method Summary | |
---|---|
private int[] |
$ASSIGN$_indexes(int[] newValue)
|
private int |
$ASSIGN$_indexes(int index0,
int newValue)
|
private ptolemy.backtrack.automatic.ptolemy.math.Interpolation |
$ASSIGN$_interpolation(ptolemy.backtrack.automatic.ptolemy.math.Interpolation newValue)
|
private int |
$ASSIGN$_iterationCount(int newValue)
|
private double[] |
$ASSIGN$_values(double[] newValue)
|
private double |
$ASSIGN$_values(int index0,
double newValue)
|
private int |
$ASSIGN$SPECIAL$_iterationCount(int operator,
long newValue)
|
private int[] |
$BACKUP$_indexes()
|
private double[] |
$BACKUP$_values()
|
void |
$COMMIT(long timestamp)
Commit changes up to the given timestamp, but not including changes made at timestamp and afterward. |
Checkpoint |
$GET$CHECKPOINT()
Get the checkpoint object that monitors this rollbackable object. |
void |
$RESTORE(long timestamp,
boolean trim)
Restore a previous state to all the private fields of this rollbackable object. |
java.lang.Object |
$SET$CHECKPOINT(Checkpoint checkpoint)
Set the checkpoint object of this rollbackable object. |
void |
attributeChanged(Attribute attribute)
Check the validity of the parameter. |
java.lang.Object |
clone(Workspace workspace)
Clone the actor into the specified workspace. |
void |
fire()
Output the value at the current iteration count. |
void |
initialize()
Set the iteration count to zero. |
boolean |
postfire()
Update the iteration counter, then call the super class method. |
Methods inherited from class ptolemy.actor.lib.Source |
---|
prefire |
Methods inherited from class ptolemy.actor.TypedAtomicActor |
---|
_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints |
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 |
---|
_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 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, 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 |
---|
protected transient Checkpoint $CHECKPOINT
public Parameter indexes
public Parameter order
public Parameter period
public Parameter values
private transient int[] _indexes
private int _iterationCount
private ptolemy.backtrack.automatic.ptolemy.math.Interpolation _interpolation
private transient double[] _values
protected transient CheckpointRecord $RECORD$$CHECKPOINT
private transient FieldRecord $RECORD$_indexes
private transient FieldRecord $RECORD$_iterationCount
private transient FieldRecord $RECORD$_interpolation
private transient FieldRecord $RECORD$_values
private transient FieldRecord[] $RECORDS
Constructor Detail |
---|
public Interpolator(CompositeEntity container, java.lang.String name) throws NameDuplicationException, IllegalActionException
container
- The container.name
- The name of this actor.
IllegalActionException
- If the entity cannot be contained
by the proposed container.
NameDuplicationException
- If the container already has an
actor with this name.Method Detail |
---|
public void attributeChanged(Attribute attribute) throws IllegalActionException
attributeChanged
in class LimitedFiringSource
attribute
- The attribute that changed.
IllegalActionException
- If the argument is the
values parameter and it does not contain an one dimensional
array; or the argument is the indexes parameter and it does
not contain an one dimensional array or is not increasing and
non-negative; or the argument is the period parameter and is
negative; or the argument is the order parameter and the order
is not supported by the Interpolation class.public java.lang.Object clone(Workspace workspace) throws java.lang.CloneNotSupportedException
clone
in class AtomicActor
workspace
- The workspace for the new object.
java.lang.CloneNotSupportedException
- If a derived class contains
an attribute that cannot be cloned.NamedObj.exportMoML(Writer, int, String)
,
NamedObj.setDeferringChangeRequests(boolean)
public void fire() throws IllegalActionException
fire
in interface Executable
fire
in class Source
IllegalActionException
- If the values and
indexes parameters do not contain arrays of the same length,
or the period is not 0 and not greater than the largest index.public void initialize() throws IllegalActionException
initialize
in interface Initializable
initialize
in class LimitedFiringSource
IllegalActionException
- If the super class throws it.public boolean postfire() throws IllegalActionException
postfire
in interface Executable
postfire
in class LimitedFiringSource
IllegalActionException
- If the super class throws it.private final int[] $ASSIGN$_indexes(int[] newValue)
private final int $ASSIGN$_indexes(int index0, int newValue)
private final int[] $BACKUP$_indexes()
private final int $ASSIGN$_iterationCount(int newValue)
private final int $ASSIGN$SPECIAL$_iterationCount(int operator, long newValue)
private final ptolemy.backtrack.automatic.ptolemy.math.Interpolation $ASSIGN$_interpolation(ptolemy.backtrack.automatic.ptolemy.math.Interpolation newValue)
private final double[] $ASSIGN$_values(double[] newValue)
private final double $ASSIGN$_values(int index0, double newValue)
private final double[] $BACKUP$_values()
public void $COMMIT(long timestamp)
Rollbackable
$COMMIT
in interface Rollbackable
timestamp
- The timestamp.public void $RESTORE(long timestamp, boolean trim)
Rollbackable
$RESTORE
in interface Rollbackable
timestamp
- The timestamp taken at the time when the previous
state was recorded.trim
- Whether to delete the records used for the rollback.Checkpoint.rollback(long, boolean)
public final Checkpoint $GET$CHECKPOINT()
Rollbackable
$GET$CHECKPOINT
in interface Rollbackable
public final java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)
Rollbackable
$SET$CHECKPOINT
in interface Rollbackable
checkpoint
- The new checkpoint object.
Checkpoint.setCheckpoint(Checkpoint)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |