ptolemy.actor.lib.conversions
Class ComplexToPolar
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.ComplexToPolar
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class ComplexToPolar
- extends TypedAtomicActor
Convert a complex token to polar coordinates, which are represented by two
double tokens (magnitude and angle). The output angle is in radians.
The implementation uses java.lang.Math.atan2(double, double).
- Since:
- Ptolemy II 1.0
- Version:
- $Id: ComplexToPolar.java,v 1.24 2004/04/13 03:05:21 cxh Exp $
- Author:
- Michael Leung, Edward A. Lee, and Paul Whitaker
- See Also:
Math.atan2(double, double),
Serialized Form
- Accepted Rating:
- Proposed Rating:
|
Field Summary |
TypedIOPort |
angle
The output port for the angle component, which has type DoubleToken. |
TypedIOPort |
input
The port for the input, which has type ComplexToken. |
TypedIOPort |
magnitude
The output port for the magnitude component, which has type
DoubleToken. |
| 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 one complex token on the input port and output a new double
token on each of the two output ports (magnitude and angle). |
boolean |
prefire()
Return false if the input port 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 |
input
public TypedIOPort input
- The port for the input, which has type ComplexToken.
magnitude
public TypedIOPort magnitude
- The output port for the magnitude component, which has type
DoubleToken.
angle
public TypedIOPort angle
- The output port for the angle component, which has type DoubleToken.
ComplexToPolar
public ComplexToPolar(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 one complex token on the input port and output a new double
token on each of the two output ports (magnitude and angle). The
outputs are a polar form representation of the complex input. The
output angle is in radians.
- 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 the input port 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.