ptolemy.domains.de.lib
Class Wire
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.domains.de.kernel.DEActor
ptolemy.domains.de.lib.DETransformer
ptolemy.domains.de.lib.Wire
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, SequenceActor, TimedActor, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
Deprecated. Use Sampler instead.
public class Wire
- extends DETransformer
A Wire is a stateful actor in DE. It should have an equal number
of input and output channels. If it receives input on any of
its channels, it will produce the most recent received on each
input channel to the corresponding output channel for all
channels. We can think its behavior similar to a wire in VHDL, where
the value is always the most recently received. If no input has been
received on an input channel, then the corresponding output channel
will get the value given by initialValue, possibly converted
to the type of the output. The type of the output is at least that
of the input and that of initialValue. Hence, for example,
if the input
is a double and initialValue is an int, then the output will
be a double.
- Since:
- Ptolemy II 5.2
- Version:
- $Id: Wire.java 57040 2010-01-27 20:52:32Z cxh $
- Author:
- Adam Cataldo, Edward A. Lee (contributor)
- See Also:
Sampler,
Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
protected Token[] |
_lastInputs
Deprecated. The recorded inputs last seen. |
Parameter |
initialValue
Deprecated. The value that is output when no input has yet been received
on the corresponding channel. |
| 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 |
Wire(CompositeEntity container,
java.lang.String name)
Deprecated. Construct an actor with the given container and name. |
|
Method Summary |
void |
fire()
Deprecated. If there is a token in on any channel of the input port,
output the most recent value on all the output port
channels. |
void |
initialize()
Deprecated. Initialize the actor. |
boolean |
prefire()
Deprecated. Return true if there is any token on an input port. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup |
| 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, attributeChanged, 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 |
initialValue
public Parameter initialValue
- Deprecated.
- The value that is output when no input has yet been received
on the corresponding channel. The output type at least the type
of this parameter and the type of the input. The default value
is 0 (an int).
_lastInputs
protected Token[] _lastInputs
- Deprecated.
- The recorded inputs last seen.
Wire
public Wire(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Deprecated.
- Construct an actor with the given container and name.
- Parameters:
container - The container.name - The name of this actor.
- Throws:
IllegalActionException - If the actor 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 a token in on any channel of the input port,
output the most recent value on all the output port
channels.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If the base class throws one.
initialize
public void initialize()
throws IllegalActionException
- Deprecated.
- Initialize the actor.
- Specified by:
initialize in interface Initializable- Overrides:
initialize in class AtomicActor
- Throws:
IllegalActionException - If the superclass throws it.
prefire
public boolean prefire()
throws IllegalActionException
- Deprecated.
- Return true if there is any token on an input port.
- Specified by:
prefire in interface Executable- Overrides:
prefire in class AtomicActor
- Returns:
- True if this actor is ready for firing, false otherwise.
- Throws:
IllegalActionException - If the base class throws it.