ptolemy.domains.ct.lib
Class CTPeriodicSampler

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.Transformer
                              extended byptolemy.domains.ct.lib.CTPeriodicSampler
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, CTEventGenerator, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, TimedActor, ptolemy.actor.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:
Red (cxh)
Proposed Rating:
Red (liuj)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.data.expr.Parameter samplePeriod
          The parameter for the sampling period; the type is double; the default value is 1.0.
 
Fields inherited from class ptolemy.actor.lib.Transformer
input, output
 
Fields inherited from class ptolemy.actor.AtomicActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
CTPeriodicSampler(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor in the specified container with the specified name.
 
Method Summary
 void attributeChanged(ptolemy.kernel.util.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.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
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.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
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.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
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
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
iterate, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

samplePeriod

public ptolemy.data.expr.Parameter samplePeriod
The parameter for the sampling period; the type is double; the default value is 1.0.

Constructor Detail

CTPeriodicSampler

public CTPeriodicSampler(ptolemy.kernel.CompositeEntity container,
                         java.lang.String name)
                  throws ptolemy.kernel.util.IllegalActionException,
                         ptolemy.kernel.util.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:
ptolemy.kernel.util.IllegalActionException - If the entity cannot be contained by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If name coincides with an entity already in the container.
Method Detail

attributeChanged

public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
                      throws ptolemy.kernel.util.IllegalActionException
Update the local cache of the sampling period if it has been changed.

Throws:
ptolemy.kernel.util.IllegalActionException - If the sampling period is less than or equal to 0.

fire

public void fire()
          throws ptolemy.kernel.util.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 ptolemy.actor.Executable
Throws:
ptolemy.kernel.util.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 ptolemy.kernel.util.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 ptolemy.actor.Executable
Throws:
ptolemy.kernel.util.IllegalActionException - If thrown by the supper class.

postfire

public boolean postfire()
                 throws ptolemy.kernel.util.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 ptolemy.actor.Executable
Returns:
True.
Throws:
ptolemy.kernel.util.IllegalActionException