ptolemy.actor.lib
Class MultiplyDivide
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.MultiplyDivide
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
public class MultiplyDivide
- extends TypedAtomicActor
A polymorphic multiplier and/or divider. This adder has two input
ports, both of which are multiports, and one output port, which is
not. The types on the ports are undeclared and will be resolved by
the type resolution mechanism. Data that arrives on the input port
named multiply will be multiplied, and data that arrives on
the input port named divide will be divided. Any token type
supporting multiplication and division can be used. In most
domains, either input port can be left unconnected. Thus, to get a
simple multiplier (with no division), just leave the divide
input unconnected.
Currently, the type system is quite liberal about the resolved
types it will permit at the inputs. In particular, it may permit
the multiply and divide inputs to resolve to types
that cannot in fact be multiplied or divided. In these cases, a
run-time error will occur. In the future, we hope that the type
system will intercept such errors before run time.
This actor does not require that each input channel have a token
upon firing. It will multiply or divide available tokens at the
inputs and ignore the channels that do not have tokens. It
consumes at most one input token from each port. If no input
tokens are available on the multiply inputs, then a
numerator of one is assumed for the division operations. The "one"
is obtained by calling the one() method of the first token seen at
the divide input. If no input tokens are available at all,
then no output is produced.
- Since:
- Ptolemy II 0.3
- Version:
- $Id: MultiplyDivide.java 57040 2010-01-27 20:52:32Z cxh $
- 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, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
|
Constructor Summary |
MultiplyDivide(CompositeEntity container,
java.lang.String name)
Construct an actor in the specified container with the specified
name. |
|
Method Summary |
void |
fire()
If there is at least one token on the input ports, multiply
tokens from the multiply port, divide by tokens from
the divide port, and send the result to the output
port. |
| Methods inherited from class ptolemy.actor.AtomicActor |
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, initialize, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, postfire, prefire, 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 |
divide
public TypedIOPort divide
- Input for tokens to be divided. This is a multiport, and its
type is inferred from the connections.
output
public TypedIOPort output
- Output port. The type is inferred from the connections.
multiply
public TypedIOPort multiply
- Input for tokens to be multiplied. This is a multiport, and its
type is inferred from the connections.
MultiplyDivide
public MultiplyDivide(CompositeEntity container,
java.lang.String name)
throws IllegalActionException,
NameDuplicationException
- Construct an actor in the specified container with the specified
name.
- Parameters:
container - The container.name - The name of this actor within the container.
- Throws:
IllegalActionException - If the actor cannot be contained
by the proposed container.
NameDuplicationException - If the name coincides with
an actor already in the container.
fire
public void fire()
throws IllegalActionException
- If there is at least one token on the input ports, multiply
tokens from the multiply port, divide by tokens from
the divide port, and send the result to the output
port. At most one token is read from each channel, so if more
than one token is pending, the rest are left for future
firings. If none of the input channels has a token, do
nothing. If none of the multiply channels have tokens, then
the tokens on the divide channels are divided into a one token
of the same type as the denominator.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If there is no director,
or if multiplication and division are not supported by the
available tokens.