public class DiscreteClock extends TimedSource
The values parameter by default contains the array {1}. The default offsets array is {0.0}. The default period is 1.0.
The type of the output can be any token type. This type is inferred from the element type of the values parameter.
For example, if values = {1, 2, 3}, offsets = {0.1, 0.2, 0.3}, period = 1.0, and the actor is initialized at time 0.0, then it will produce outputs with value 1 at all times n + 0.1, outputs with value 2 at all times n + 0.2, and outputs with value 3 at all times n + 0.3, for all non-negative integers n.
If the actor is not fired by the enclosing director at the time of the next expected output, then it will stop producing outputs. This should not occur. If it does, it is a bug in the director.
If the director that this is used with supports superdense time (like DE, Continuous), then the outputs are normally produced at microstep index 1. The reason for producing outputs at index 1 is to maintain continuity in continuous-time models. Specifically, if the signal is absent prior to an output time, then it should be absent at index 0 of the time at which it will produce the next output. There are two exceptions. If two or more offsets have the same value, then each output at the same time is produced at superdense time index one greater than the previous output. Also, if an expected output has not been produced by the expected index, then it will be produced at the next available index. E.g., the very first output may be produced at a superdense index greater than zero if the director's index is greater than zero when this actor is initialized. This can happen, for example, if this clock is in a refinement in a modal model, and the modal model enters that mode with a reset transition.
If the period is changed at any time, either by provided by an input or by changing the parameter, then the new period will take effect immediately if the new period is provided at the same time (including the microstep) that the current cycle starts, or after the current cycle completes otherwise.
If the trigger input is connected, then an output will only be produced if a trigger input has been received since the last output or if the trigger input coincides with the time when an output should be produced. If a trigger input has not been received, then the output will be skipped, moving on to the the next phase. The only exception is the first output, which is produced whether a trigger is provided or not. This is because the trigger input is typically useful in a feedback situation, where the output of the clock eventually results in a trigger input. If the time-stamp of that trigger input is less than the time between clock events, then the clock will behave as if there were no trigger input. Otherwise, it will "skip beats."
This actor is a timed source; the untimed version is Pulse.
Entity.ContainedObjectsIterator| Modifier and Type | Field and Description |
|---|---|
protected int |
_cycleCount
The count of cycles executed so far, or 0 before the start.
|
protected Time |
_cycleStartTime
The most recent cycle start time.
|
protected boolean |
_enabled
Indicator of whether the specified number of cycles have
been completed.
|
protected boolean |
_firstOutputProduced
Indicator of whether the first output has been produced.
|
protected int |
_nextOutputIndex
The index of when the output should be emitted.
|
protected Time |
_nextOutputTime
The time for the next output.
|
protected double[] |
_offsets
Cache of offsets array value.
|
protected int |
_phase
The phase of the next output.
|
Parameter |
offsets
The offsets at which the specified values will be produced.
|
PortParameter |
period
The period of the output waveform.
|
TypedIOPort |
start
A port that, if connected, is used to specify when the clock
starts.
|
TypedIOPort |
stop
A port that, if connected, is used to specify when the clock
stops.
|
Parameter |
values
The values that will be produced at the specified offsets.
|
stopTime, stopTimeIsLocal_triggered, output, trigger_typesValid_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKSCOMPLETED, NOT_READY, STOP_ITERATING| Constructor and Description |
|---|
DiscreteClock(CompositeEntity container,
java.lang.String name)
Construct an actor in the specified container with the specified
name.
|
| Modifier and Type | Method and Description |
|---|---|
protected Token |
_getValue(int index)
Get the specified output value, checking the form of the values
parameter.
|
protected void |
_produceIntermediateOutput()
Produce the output required at times between the specified times.
|
protected void |
_skipToNextPhase()
Skip the current firing phase and request a refiring at the
time of the next one.
|
void |
attributeChanged(Attribute attribute)
If the argument is the offsets parameter, check that the
array is nondecreasing and has the right dimension; if the
argument is period, check that it is positive.
|
java.lang.Object |
clone(Workspace workspace)
Clone the actor into the specified workspace.
|
void |
fire()
Output the current value of the clock if the clock is currently
enabled and, if the trigger input is connected, a trigger has been
received.
|
void |
initialize()
Override the base class to initialize the index.
|
boolean |
postfire()
Update the time and index of the next expected output.
|
boolean |
prefire()
Return true if current time has not exceeded the
stopTime.
|
getModelStopTime, getStopTime, wrapup_customTypeConstraints_containedTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints_actorFiring, _actorFiring, _declareDelayDependency, 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_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName_addPort, _description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeDeleted, attributeList, attributeList, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspaceequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitcreateReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortListisFireFunctional, isStrict, iterate, stop, stopFire, terminateaddInitializable, preinitialize, removeInitializabledescription, getContainer, getDisplayName, getFullName, getName, getName, setNamegetDerivedLevel, getDerivedList, propagateValuepublic Parameter offsets
public PortParameter period
public TypedIOPort start
public TypedIOPort stop
public Parameter values
protected transient int _cycleCount
protected transient Time _cycleStartTime
protected transient boolean _enabled
protected transient boolean _firstOutputProduced
protected transient Time _nextOutputTime
protected transient int _nextOutputIndex
protected transient double[] _offsets
protected transient int _phase
public DiscreteClock(CompositeEntity container, java.lang.String name) throws IllegalActionException, NameDuplicationException
container - The container.name - The actor's nameIllegalActionException - If the entity cannot be contained
by the proposed container.NameDuplicationException - If name coincides with
an entity already in the container.public void attributeChanged(Attribute attribute) throws IllegalActionException
attributeChanged in class TimedSourceattribute - The attribute that changed.IllegalActionException - If the offsets array is not
nondecreasing and nonnegative.public java.lang.Object clone(Workspace workspace) throws java.lang.CloneNotSupportedException
clone in class TypedAtomicActorworkspace - 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 Executablefire in class SourceIllegalActionException - If
the value in the offsets parameter is encountered that is greater
than the period, or if there is no director.public void initialize()
throws IllegalActionException
initialize in interface Initializableinitialize in class TimedSourceIllegalActionException - If the parent class throws it,
or if the values parameter is not a row vector, or if the
fireAt() method of the director throws it, or if the director does not
agree to fire the actor at the specified time.public boolean postfire()
throws IllegalActionException
postfire in interface Executablepostfire in class TimedSourceIllegalActionException - If the director throws it when
scheduling the next firing, or if an offset value exceeds the period.public boolean prefire()
throws IllegalActionException
prefire in interface Executableprefire in class TimedSourceIllegalActionException - If the values and
offsets parameters do not have the same length.protected Token _getValue(int index) throws IllegalActionException
index - The index of the output values.IllegalActionException - If the index is out of the range of
the values parameter.protected void _produceIntermediateOutput()
throws IllegalActionException
IllegalActionException - If sending the output fails.protected void _skipToNextPhase()
throws IllegalActionException
IllegalActionException - If the period cannot be evaluated, or
if an offset is encountered that is greater than the period.