ptolemy.domains.tm.lib
Class PeriodicTrigger
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.domains.tm.lib.PeriodicTrigger
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class PeriodicTrigger
- extends TypedAtomicActor
This actor produces a ramp at 2 Hz.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: PeriodicTrigger.java,v 1.19 2004/04/13 03:37:13 cxh Exp $
- Author:
- Edward A. Lee
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Method Summary |
void |
attributeChanged(Attribute attribute)
Once the period is updated, calculate the execution period. |
java.lang.Object |
clone(Workspace workspace)
Clone the actor into the specified workspace. |
void |
initialize()
Begin execution of the actor. |
boolean |
postfire()
This method should be invoked once per iteration, after the last
invocation of fire() in that iteration. |
void |
stopFire()
Request that execution of the current iteration complete. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, connectionsChanged, fire, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, 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 |
output
public TypedIOPort output
- The output port.
period
public Parameter period
- The execution period, in terms of Hz. Default is 2.0.
PeriodicTrigger
public PeriodicTrigger(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
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
output
variable to equal the new port.
- 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.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- Once the period is updated, calculate the execution period.
- Overrides:
attributeChanged in class NamedObj
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - If the change is not acceptable
to this container (not thrown in this base class).
initialize
public void initialize()
throws IllegalActionException
- Description copied from interface:
Executable
- Begin execution of the actor. This is invoked exactly once
after the preinitialization phase. Since type resolution is done
in the preinitialization phase, along with topology changes that
may be requested by higher-order function actors, an actor
can produce output data and schedule events in the initialize()
method.
- Specified by:
initialize in interface Executable- Overrides:
initialize in class AtomicActor
- Throws:
IllegalActionException - If a derived class throws it.
postfire
public boolean postfire()
throws IllegalActionException
- Description copied from interface:
Executable
- This method should be invoked once per iteration, after the last
invocation of fire() in that iteration. It may produce output data.
It returns true if the execution can proceed into the next iteration,
false if the actor does not wish to be fired again.
This method typically wraps up an iteration, which may involve
updating local state. In an opaque, non-atomic entity, it may also
transfer output data. The execution of this method is bounded.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class AtomicActor
- Returns:
- True if execution can continue into the next iteration.
- Throws:
IllegalActionException - Not thrown in this base class.
stopFire
public void stopFire()
- Description copied from interface:
Executable
- Request that execution of the current iteration complete. If
an iteration is always a finite computation (the usual case),
i.e. the fire() method always returns in finite time, then
nothing needs to be done in this method, except possibly to
pass on the request to any contained executable objects. This
method is used to request that an unbounded computation
suspend, returning control to the caller. Thus, if the fire()
method does not normally return in finite time, then this
method is used to request that it return. It should suspend
execution in such a way that if the fire() method is called
again, execution will resume at the point where it was
suspended. However, it should not assume the fire() method
will be called again. It is possible that the wrapup() method
will be called next.
- Specified by:
stopFire in interface Executable- Overrides:
stopFire in class AtomicActor