Package ptolemy.actor.lib

Class Discard

java.lang.Object

ptolemy.kernel.util.NamedObj

ptolemy.kernel.InstantiableNamedObj

ptolemy.kernel.Entity<T>

ptolemy.kernel.ComponentEntity<T>

ptolemy.actor.AtomicActor<TypedIOPort>

ptolemy.actor.TypedAtomicActor

ptolemy.actor.lib.Sink

ptolemy.actor.lib.Discard

All Implemented Interfaces:

java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Changeable, Configurable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable

Direct Known Subclasses:

DiscardDoubles, DiscardDoublesArray, DiscardGenerals, TypeTest

public class Discard
extends Sink
implements Configurable

A simple sink actor that consumes and discards input tokens.

This actor is useful in situations where the value of an output is not needed, but for some reason, the output cannot be left unconnected. Also, when manipulating bus signals, this actor is useful if values in the middle of the bus need to be discarded. Leaving the bus unconnected in the middle will not work because no channel is allocated to an unconnected relation in a bus.

Since:

Ptolemy II 1.0

Version:

$Id$

Author:

Edward A. Lee, contributors: Christopher Brooks, Brian Hudson

Pt.AcceptedRating:

Yellow (ssachs)

Pt.ProposedRating:

Yellow (eal)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields inherited from class ptolemy.actor.lib.Sink

input

Fields inherited from class ptolemy.actor.TypedAtomicActor

_typesValid

Fields inherited from class ptolemy.actor.AtomicActor

_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested

Fields inherited from class ptolemy.kernel.util.NamedObj

_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _deferChangeRequests, _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

Constructors

Constructor	Description
Discard(CompositeEntity container, java.lang.String name)	Construct an actor with an input multiport.

Method Summary

Modifier and Type	Method	Description
protected java.util.Set<Inequality>	_customTypeConstraints()	Set the input port greater than or equal to BaseType.GENERAL in case backward type inference is enabled and the input port has no type declared.
void	configure(java.net.URL base, java.lang.String source, java.lang.String text)	Do nothing, as this actor is not actually configurable.
void	fire()	Read one token from each input channel and discard it.
java.lang.String	getConfigureSource()	Return null because this actor is not actually configurable.
java.lang.String	getConfigureText()	Return null because this actor is not actually configurable.

Methods inherited from class ptolemy.actor.TypedAtomicActor

_containedTypeConstraints, _defaultTypeConstraints, _fireAt, _fireAt, attributeTypeChanged, clone, clone, isBackwardTypeInferenceEnabled, newPort, typeConstraintList, typeConstraints

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, 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

_addPort, _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, _containedDecorators, _copyChangeRequestList, _debug, _debug, _debug, _debug, _debug, _executeChangeRequests, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _notifyHierarchyListenersAfterChange, _notifyHierarchyListenersBeforeChange, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, addHierarchyListener, attributeChanged, attributeDeleted, attributeList, attributeList, decorators, 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, notifyOfNameChange, propagateValue, propagateValues, removeAttribute, removeChangeListener, removeDebugListener, removeHierarchyListener, 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.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Methods inherited from interface ptolemy.actor.Executable

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

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, initialize, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Constructor Detail

Discard

public Discard(CompositeEntity container,
               java.lang.String name)
        throws NameDuplicationException,
               IllegalActionException

Construct an actor with an input multiport.

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

configure

public void configure(java.net.URL base,
                      java.lang.String source,
                      java.lang.String text)
               throws java.lang.Exception

Do nothing, as this actor is not actually configurable.

This class implements Configurable so that the MoML filters can replace graphical actors that implement Configurable with this actor. Note that the actors to be replaced must have an input port named input, so not all Configurable actors can be replaced with this actor.

Specified by:

configure in interface Configurable

Parameters:

base - Ignored.

source - Ignored.

text - Ignored.

Throws:

java.lang.Exception - Not thrown in this base class.

fire

public void fire()
          throws IllegalActionException

Read one token from each input channel and discard it. If there is no input on a channel, then skip that channel, doing nothing with it.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If there is no director.

getConfigureSource

public java.lang.String getConfigureSource()

Return null because this actor is not actually configurable.

Specified by:

getConfigureSource in interface Configurable

Returns:

Always return null.

getConfigureText

public java.lang.String getConfigureText()

Return null because this actor is not actually configurable.

Specified by:

getConfigureText in interface Configurable

Returns:

Always return null.

_customTypeConstraints

protected java.util.Set<Inequality> _customTypeConstraints()

Set the input port greater than or equal to BaseType.GENERAL in case backward type inference is enabled and the input port has no type declared.

Overrides:

_customTypeConstraints in class TypedAtomicActor

Returns:

A set of inequalities.