ptolemy.actor.lib.conversions
Class PolarToComplex
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.conversions.PolarToComplex
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class PolarToComplex
- extends TypedAtomicActor
This actor reads two double tokens (magnitude and angle) and outputs
a single complex token. The output is a complex token representation of
the coordinates given at the inputs in polar form. The angle input is
assumed to be in radians. If either input is NaN or infinity,
then the output is NaN or infinity.
- Since:
- Ptolemy II 1.0
- Version:
- $Id: PolarToComplex.java,v 1.22 2004/04/13 03:05:41 cxh Exp $
- Author:
- Michael Leung, Edward A. Lee, Paul Whitaker
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
TypedIOPort |
angle
The input port for the angle component (in radians), which has
type DoubleToken. |
TypedIOPort |
magnitude
The input port for the magnitude component, which has type
DoubleToken. |
TypedIOPort |
output
The port for the output, which has type ComplexToken. |
| 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 |
fire()
Consume a double token from each input port (magnitude and angle)
and output a new complex token on the output port. |
boolean |
prefire()
Return false if either of the input ports has no token, otherwise
return what the superclass returns (presumably true). |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newReceiver, outputPortList, postfire, 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, attributeChanged, 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 |
magnitude
public TypedIOPort magnitude
- The input port for the magnitude component, which has type
DoubleToken.
angle
public TypedIOPort angle
- The input port for the angle component (in radians), which has
type DoubleToken.
output
public TypedIOPort output
- The port for the output, which has type ComplexToken.
PolarToComplex
public PolarToComplex(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- 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
- Consume a double token from each input port (magnitude and angle)
and output a new complex token on the output port. The output is
a complex representation of the coordinates given at the inputs in
polar form. The input angle is assumed to be in radians. If either
input has no token, then do nothing.
- Specified by:
fire in interface Executable- Overrides:
fire in class AtomicActor
- Throws:
IllegalActionException - If there is no director.
prefire
public boolean prefire()
throws IllegalActionException
- Return false if either of the input ports has no token, otherwise
return what the superclass returns (presumably true).
- 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 there is no director.