ptolemy.actor.lib
Class VariableClock
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.TimedSource
ptolemy.actor.lib.Clock
ptolemy.actor.lib.VariableClock
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TimedActor, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
Deprecated. Use Clock instead.
public class VariableClock
- extends Clock
This actor is identical to Clock except that it has an additional
input port, periodControl. If this port has a token when the actor
fires, then the value read from that port is used to set the parameter
value. The initial value of the period parameter is used before
any input is observed on periodControl.
This actor can be fairly tricky to use with multiple values and
offsets because of the constraint that all offsets must be less
than the period. Thus, the default values and offsets are different
from those of the base class. The output value, by default, is
just the constant integer 1, and the offset is 0.0. The default
value of period is changed to 1.0. This gives
a very simply behavior, where the output is always the same, but
the time between outputs is controlled by the periodControl
input.
- Since:
- Ptolemy II 0.4
- Version:
- $Id: VariableClock.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.actor.lib.Clock |
_cycleCount, _cycleStartTime, _enabled, _firstOutputProduced, _nextOutputTime, _offsets, _outputProduced, _phase, _tentativeNextOutputTime, numberOfCycles, offsets, period, values |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Constructor Summary |
VariableClock(CompositeEntity container,
java.lang.String name)
Deprecated. Construct an actor with the specified container and name. |
|
Method Summary |
void |
fire()
Deprecated. If there is an input on the periodControl port, read it
and set the value of the period parameter. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate |
| 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.util.NamedObj |
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, 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, propagateValue, propagateValues, removeChangeListener, removeDebugListener, 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 |
periodControl
public TypedIOPort periodControl
- Deprecated.
- The port that controls the value of the period parameter.
VariableClock
public VariableClock(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Deprecated.
- 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.
fire
public void fire()
throws IllegalActionException
- Deprecated.
- If there is an input on the periodControl port, read it
and set the value of the period parameter.
Then call the base class fire() method.
- Specified by:
fire in interface Executable- Overrides:
fire in class Clock
- Throws:
IllegalActionException - If the input is not positive,
or if the base class throws it.