ptolemy.domains.ct.lib
Class CTPeriodicSampler
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.Transformer
ptolemy.domains.ct.lib.CTPeriodicSampler
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, CTEventGenerator, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TimedActor, TypedActor
- public class CTPeriodicSampler
- extends Transformer
- implements CTEventGenerator, TimedActor
Generate discrete events by periodically sampling a CT signal.
This actor periodically sample the input signal and generate events
which has the value of the input signal. The sampling rate is given by
parameter "samplePeriod", which has default value 0.1.
The actor has a multi-input port and a multi-output port. Signals in
each input channel are sampled and produced to corresponding output
channel.
- Since:
- Ptolemy II 0.3
- Version:
- $Id: CTPeriodicSampler.java,v 1.58.2.1 2004/07/31 02:19:06 cxh Exp $
- Author:
- Jie Liu
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
Parameter |
samplePeriod
The parameter for the sampling period; the type is double; the
default value is 1.0. |
| 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)
Update the local cache of the sampling period if it has been changed. |
void |
fire()
Emit the current event if there is one. |
boolean |
hasCurrentEvent()
Return true if there is a current event. |
void |
initialize()
Set the next sampling time as the start time (i.e. the current time).
|
boolean |
postfire()
Set the next sampling time and return true.
|
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, prefire, 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 |
samplePeriod
public Parameter samplePeriod
- The parameter for the sampling period; the type is double; the
default value is 1.0.
CTPeriodicSampler
public CTPeriodicSampler(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an actor in the specified container with the specified
name. The name must be unique within the container or an exception
is thrown. The container argument must not be null, or a
NullPointerException will be thrown.
The actor can be either dynamic, or not. It must be set at the
construction time and can't be changed thereafter.
A dynamic actor will produce a token at its initialization phase.
- Parameters:
container - The container of this actor.name - The actor's name
- Throws:
IllegalActionException - If the entity cannot be contained
by the proposed container.
NameDuplicationException - If name coincides with
an entity already in the container.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- Update the local cache of the sampling period if it has been changed.
- Overrides:
attributeChanged in class NamedObj
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - If the sampling period is
less than or equal to 0.
fire
public void fire()
throws IllegalActionException
- Emit the current event if there is one. The value of the event
is the sample of the input signal.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If the transfer of tokens failed.
hasCurrentEvent
public boolean hasCurrentEvent()
- Return true if there is a current event.
- Specified by:
hasCurrentEvent in interface CTEventGenerator
- Returns:
- If there is a discrete event to emit.
initialize
public void initialize()
throws IllegalActionException
- Set the next sampling time as the start time (i.e. the current time).
We do not register the start time as a breakpoint, since the
director will fire at the start time any way.
- Specified by:
initialize in interface Executable- Overrides:
initialize in class AtomicActor
- Throws:
IllegalActionException - If thrown by the supper class.
postfire
public boolean postfire()
throws IllegalActionException
- Set the next sampling time and return true.
It computes the next sampling time,
and registers it as a breakpoint.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class AtomicActor
- Returns:
- True.
- Throws:
IllegalActionException - Not thrown in this base class.