Package ptolemy.domains.tcs.lib

Class AbstractTrack

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.domains.tcs.lib.AbstractTrack

All Implemented Interfaces:

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

Direct Known Subclasses:

InverseTrack, Track

public class AbstractTrack
extends TypedAtomicActor
implements Rejecting

A model of a track in Train control systems. This track can have no more than one Train in transit. If there is one in transit, then it rejects all inputs.

Since:

Ptolemy II 11.0

Version:

$Id$

Author:

Maryam Bagheri

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

Fields

Modifier and Type	Field	Description
protected ResizablePolygonAttribute	_shape	The shape.
Parameter	broken	True if the track is broken.
TypedIOPort	input	The input port.
Parameter	lineSymbol	The line symbol.
TypedIOPort	output	The output port.
Parameter	trackId	The id of the track.

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
AbstractTrack(CompositeEntity container, java.lang.String name)	Create a new actor in the specified container with the specified name.

Method Summary

Modifier and Type	Method	Description
protected void	_changeIcon(java.lang.String symbol)	Change icon of the track from train shape to rectangle.
protected ArrayToken	_setIcon(int id)	Determine the color of the track/train .
protected void	_setIconForTrain(Token idOfTrain)	Change icon of the track from rectangle to icon of the train.
void	attributeChanged(Attribute attribute)	This method handles changing in the broken and symbol parameter of the track.
void	declareDelayDependency()	Set the dependency between all output ports and all input ports of this actor.
void	fire()	Do nothing.
void	initialize()	Initialize this actor.
boolean	reject(Token token, IOPort port)	Return true if the token cannot be accepted at the specified port.

Methods inherited from class ptolemy.actor.TypedAtomicActor

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

Methods inherited from class ptolemy.actor.AtomicActor

_actorFiring, _actorFiring, _declareDelayDependency, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, 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, 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, preinitialize, removeInitializable, wrapup

Methods inherited from interface ptolemy.kernel.util.Nameable

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

Field Detail

input

public TypedIOPort input

The input port.

output

public TypedIOPort output

The output port. The type is a that of a Record of String labels and Types.

trackId

public Parameter trackId

The id of the track. The default value is an int with the value of -1, indicating that the id has not been set.

lineSymbol

public Parameter lineSymbol

The line symbol. The default type is that of String.

broken

public Parameter broken

True if the track is broken. The default is false.

_shape

protected ResizablePolygonAttribute _shape

The shape.

Constructor Detail

AbstractTrack

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

Create a new actor in the specified container with the specified name. The name must be unique within the container or an exception is thrown. The container argument must not be null, or a NullPointerException will be thrown.

Parameters:

container - The container.

name - The name of this actor within the container.

Throws:

IllegalActionException - If this actor cannot be contained by the proposed container (see the setContainer() method).

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

Method Detail

reject

public boolean reject(Token token,
                      IOPort port)

Description copied from interface: Rejecting

Return true if the token cannot be accepted at the specified port.

Specified by:

reject in interface Rejecting

Parameters:

token - The token that may be rejected.

port - The port.

Returns:

True to reject the token.

attributeChanged

public void attributeChanged(Attribute attribute)
                      throws IllegalActionException

This method handles changing in the broken and symbol parameter of the track. Symbol is the symbol of the line.

Overrides:

attributeChanged in class NamedObj

Parameters:

attribute - The attribute that changed.

Throws:

IllegalActionException - If the change is not acceptable to this container (not thrown in this base class).

declareDelayDependency

public void declareDelayDependency()
                            throws IllegalActionException

Description copied from class: AtomicActor

Set the dependency between all output ports and all input ports of this actor. By default, each output port is assumed to have a dependency on all input ports. Since this is the assumed behavior, this method does nothing by default. However, for subclasses such as TimeDelay, where output ports depend on input ports with a time delay, this method should be overridden. Protected method _declareDelayDependency() should be used to declare dependency between input and output ports for this actor.

Overrides:

declareDelayDependency in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class, derived classes should throw this exception if the delay dependency cannot be computed.

See Also:

AtomicActor.getCausalityInterface(), AtomicActor._declareDelayDependency(IOPort, IOPort, double)

fire

public void fire()
          throws IllegalActionException

Description copied from class: AtomicActor

Do nothing. Derived classes override this method to define their primary run-time action.

Specified by:

fire in interface Executable

Overrides:

fire in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - Not thrown in this base class.

initialize

public void initialize()
                throws IllegalActionException

Description copied from class: AtomicActor

Initialize this actor. Derived classes override this method to perform actions that should occur once at the beginning of an execution, but after type resolution. Derived classes can produce output data and schedule events.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor<TypedIOPort>

Throws:

IllegalActionException - If a derived class throws it.

_changeIcon

protected void _changeIcon(java.lang.String symbol)
                    throws IllegalActionException

Change icon of the track from train shape to rectangle.

Parameters:

symbol - The symbol of the line.

Throws:

IllegalActionException

_setIconForTrain

protected void _setIconForTrain(Token idOfTrain)
                         throws IllegalActionException

Change icon of the track from rectangle to icon of the train.

Parameters:

idOfTrain - The id of the train .

Throws:

IllegalActionException

_setIcon

protected ArrayToken _setIcon(int id)
                       throws IllegalActionException

Determine the color of the track/train .

Parameters:

id - The train ID or -1 to indicate no train.

Returns:

The color.

Throws:

IllegalActionException - If thrown while getting the director.