ptolemy.actor.lib.vhdl
Class FixComparator

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.vhdl.FixTransformer
                              ptolemy.actor.lib.vhdl.SynchronousFixTransformer
                                  ptolemy.actor.lib.vhdl.FixComparator

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 FixComparator
extends SynchronousFixTransformer

Produce an output token on each firing with a FixPoint value that is equal to the sum of all the inputs at the plus port minus the inputs at the minus port.

Since:

Ptolemy II 6.0

Version:

$Id: FixComparator.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Man-Kit Leung

See Also:

Serialized Form

Accepted Rating:

Red (mankit)

Proposed Rating:

Red (mankit)

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.kernel.Entity

Entity.ContainedObjectsIterator

Field Summary

TypedIOPort	A Input for tokens to be added.
TypedIOPort	B Input for tokens to be subtracted.
Parameter	operation Indicate whether addition or subtraction needs to be performed.

Fields inherited from class ptolemy.actor.lib.vhdl.SynchronousFixTransformer

initialValue, latency

Fields inherited from class ptolemy.actor.lib.vhdl.FixTransformer

output

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

FixComparator(CompositeEntity container, java.lang.String name)
Construct an actor with the given container and name.

Method Summary

void	fire() Output the fixpoint value of the sum of the input bits.
void	preinitialize() Override the base class to declare that the A and B ports do not depend on the output in a firing.

Methods inherited from class ptolemy.actor.lib.vhdl.SynchronousFixTransformer

attributeChanged, initialize, isStrict

Methods inherited from class ptolemy.actor.lib.vhdl.FixTransformer

_checkFixMaxValue, _checkFixTokenWidth, _setAndHideQuantizationParameters, _setQuantizationParameters, _showQuantizationParameters, getPortPrecision, newFixOutputPort, sendOutput

Methods inherited from class ptolemy.actor.TypedAtomicActor

_addPort, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, addActorFiringListener, addInitializable, clone, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, iterate, newReceiver, outputPortList, postfire, prefire, 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.InstantiableNamedObj

_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition

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, 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

Methods inherited from interface ptolemy.actor.Actor

createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList

Methods inherited from interface ptolemy.actor.Executable

isFireFunctional, iterate, postfire, prefire, stop, stopFire, terminate

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

description, getContainer, getDisplayName, getFullName, getName, getName, setName

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

A

public TypedIOPort A

Input for tokens to be added. This is a multiport of fix point type

B

public TypedIOPort B

Input for tokens to be subtracted. This is a multiport of fix point type.

operation

public Parameter operation

Indicate whether addition or subtraction needs to be performed.

Constructor Detail

FixComparator

public FixComparator(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.

Method Detail

fire

public void fire()
          throws IllegalActionException

Output the fixpoint value of the sum of the input bits. If there is no inputs, then produce null.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor

Throws:

IllegalActionException - If there is no director.

preinitialize

public void preinitialize()
                   throws IllegalActionException

Override the base class to declare that the A and B ports do not depend on the output in a firing.

Specified by:

preinitialize in interface Initializable

Overrides:

preinitialize in class SynchronousFixTransformer

Throws:

IllegalActionException - Not thrown in this base class.