org.ptolemy.faultModels

Class StuckAtFaultGenerator

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.aspect.AtomicCommunicationAspect

org.ptolemy.faultModels.StuckAtFaultGenerator

All Implemented Interfaces:

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

public class StuckAtFaultGenerator
extends AtomicCommunicationAspect

This actor is an CommunicationAspect that, when its ...

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Ilge Akkaya, Patricia Derler, Edward A. Lee

Pt.AcceptedRating:

Red (derler)

Pt.ProposedRating:

Yellow (derler)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field and Description
Parameter	stuckAtFaultProbability The service time.

Fields inherited from class ptolemy.actor.lib.aspect.AtomicCommunicationAspect

_parameters, _tokenCount

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.CommunicationAspect

decoratorHighlightColorName

Fields inherited from interface ptolemy.actor.Executable

COMPLETED, NOT_READY, STOP_ITERATING

Constructor Summary

Constructors

Constructor and Description
StuckAtFaultGenerator(CompositeEntity container, java.lang.String name) Construct a Bus with a name and a container.

Method Summary

Modifier and Type	Method and Description
protected void	_scheduleRefire() Schedule a refiring of the actor.
void	attributeChanged(Attribute attribute) If the attribute is serviceTime, then ensure that the value is non-negative.
java.lang.Object	clone(Workspace workspace) Clone this actor into the specified workspace.
void	fire() Send first token in the queue to the target receiver.
IntermediateReceiver	getReceiver(Receiver receiver) Create an intermediate receiver that wraps a given receiver.
Receiver	getReceiver(Receiver receiver, IOPort port) Create a receiver to mediate a communication via the specified receiver.
void	initialize() Initialize the actor.
boolean	postfire() If there are still tokens in the queue and a token has been produced in the fire, schedule a refiring.
void	reset() Reset the communication aspect and clear the tokens.
void	sendToken(Receiver source, Receiver receiver, Token token) Initiate a send of the specified token to the specified receiver.

Methods inherited from class ptolemy.actor.lib.aspect.AtomicCommunicationAspect

_sendToReceiver, createDecoratorAttributes, createIntermediateReceiver, decoratedObjects, isGlobalDecorator, registerListener, sendCommunicationEvent, setContainer

Methods inherited from class ptolemy.actor.TypedAtomicActor

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

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, prefire, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, 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, 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.kernel.util.Nameable

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

Methods inherited from interface ptolemy.actor.Actor

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

Methods inherited from interface ptolemy.actor.Executable

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

Methods inherited from interface ptolemy.actor.Initializable

addInitializable, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

stuckAtFaultProbability

public Parameter stuckAtFaultProbability

The service time. This is a double with default 0.1. It is required to be positive.

Constructor Detail

StuckAtFaultGenerator

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

Construct a Bus with a name and a container. The container argument must not be null, or a NullPointerException will be thrown. This actor will use the workspace of the container for synchronization and version counts. If the name argument is null, then the name is set to the empty string. Increment the version of the workspace.

Parameters:

container - The container.

name - The name of this actor.

Throws:

IllegalActionException - If the container is incompatible with this actor.

NameDuplicationException - If the name coincides with an actor already in the container.

Method Detail

getReceiver

public IntermediateReceiver getReceiver(Receiver receiver)

Create an intermediate receiver that wraps a given receiver.

Parameters:

receiver - The receiver that is being wrapped.

Returns:

A new intermediate receiver.

getReceiver

public Receiver getReceiver(Receiver receiver,
                            IOPort port)
                     throws IllegalActionException

Create a receiver to mediate a communication via the specified receiver. This receiver is linked to a specific port of the communication aspect.

Parameters:

receiver - Receiver whose communication is to be mediated.

port - Port of the communication aspect.

Returns:

A new receiver.

Throws:

IllegalActionException - If the receiver cannot be created.

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

If the attribute is serviceTime, then ensure that the value is non-negative.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the service time is negative.

clone

public java.lang.Object clone(Workspace workspace)
                       throws java.lang.CloneNotSupportedException

Clone this actor into the specified workspace. The new actor is not added to the directory of that workspace (you must do this yourself if you want it there). The result is a new actor with the same ports as the original, but no connections and no container. A container must be set before much can be done with this actor.

Overrides:

clone in class AtomicCommunicationAspect

Parameters:

workspace - The workspace for the cloned object.

Returns:

A new Bus.

Throws:

java.lang.CloneNotSupportedException - If cloned ports cannot have as their container the cloned entity (this should not occur), or if one of the attributes cannot be cloned.

See Also:

NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

initialize

public void initialize()
                throws IllegalActionException

Initialize the actor.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicCommunicationAspect

Throws:

IllegalActionException - If the superclass throws it.

fire

public void fire()
          throws IllegalActionException

Send first token in the queue to the target receiver.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

postfire

public boolean postfire()
                 throws IllegalActionException

If there are still tokens in the queue and a token has been produced in the fire, schedule a refiring.

Specified by:

postfire in interface Executable

Overrides:

postfire in class AtomicActor<TypedIOPort>

Returns:

True if execution can continue into the next iteration.

Throws:

IllegalActionException - Not thrown in this base class.

sendToken

public void sendToken(Receiver source,
                      Receiver receiver,
                      Token token)
               throws IllegalActionException

Initiate a send of the specified token to the specified receiver. This method will schedule a refiring of this actor if there is not one already scheduled.

Parameters:

source - Sender of the token.

receiver - The receiver to send to.

token - The token to send.

Throws:

IllegalActionException - If the refiring request fails.

reset

public void reset()

Reset the communication aspect and clear the tokens.

_scheduleRefire

protected void _scheduleRefire()
                        throws IllegalActionException

Schedule a refiring of the actor.

Throws:

IllegalActionException - Thrown if the actor cannot be rescheduled