ptolemy.domains.petrinet.kernel
Class Place

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.Transformer
                              ptolemy.domains.petrinet.kernel.Place

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 Place
extends Transformer

A Petri net place. A Petri net place is a basic component of the Petri Net model. Another basic component is the Transition. A place is connected to transitions. It contains an integer as the marking of the place, which represents the number of tokens in the place. The operation of the Petri net is controlled by the marking and the weights of arcs connecting places and transitions. The methods here are used to manipulate the integer marking. The TemporaryMarking is used for checking whether a transition is ready or not.

Since:

Ptolemy II 2.0

Version:

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

Author:

Yuke Wang and Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (cxh@eecs)

Proposed Rating:

Red (yukewang)

Nested Class Summary

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

Entity.ContainedObjectsIterator

Field Summary

private int	_currentMarking Current marking.
private int	_temporaryMarking Temporary marking.
Parameter	initialMarking The number of initial tokens in the place.

Fields inherited from class ptolemy.actor.lib.Transformer

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

Place(CompositeEntity container, java.lang.String name)
Create a new actor in the specified container with the specified name.

Method Summary

void	decreaseMarking(int i) Decrease the _currentMarking.
void	decreaseTemporaryMarking(int i) Decrease the _temporaryMarking by i.
int	getMarking() getMarking() is to get the _currentMarking of the place.
int	getTemporaryMarking() getTemporaryMarking() is to get the temporaryMarking of the place.
void	increaseMarking(int i) Increase the _currentMarking.
void	initialize() Set the current marking equal to the initial marking.
void	setTemporaryMarking(int i) Set the _temporaryMarking.

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

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

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

Methods inherited from interface ptolemy.kernel.util.Derivable

getDerivedLevel, getDerivedList, propagateValue

Field Detail

initialMarking

public Parameter initialMarking

The number of initial tokens in the place. This is an integer.

_currentMarking

private int _currentMarking

Current marking.

_temporaryMarking

private int _temporaryMarking

Temporary marking.

Constructor Detail

Place

public Place(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

getMarking

public int getMarking()

getMarking() is to get the _currentMarking of the place.

Returns:

the currentMarking of the place.

getTemporaryMarking

public int getTemporaryMarking()

getTemporaryMarking() is to get the temporaryMarking of the place. temporaryMarking is used for checking whether the _currentMarking of the place is bigger than the sum of all links between the place and a transition. TemporaryMarking is used in Transition.prefire.

Returns:

the _temporaryMarking of the place.

See Also:

setTemporaryMarking(int)

increaseMarking

public void increaseMarking(int i)

Increase the _currentMarking.

Parameters:

i - the number to be increased for the marking in the place.

decreaseMarking

public void decreaseMarking(int i)

Decrease the _currentMarking.

Parameters:

i - the number to be decreased for the marking in the place.

decreaseTemporaryMarking

public void decreaseTemporaryMarking(int i)

Decrease the _temporaryMarking by i.

Parameters:

i - the number to be decreased for the TemporaryMarking in the place.

setTemporaryMarking

public void setTemporaryMarking(int i)

Set the _temporaryMarking.

Parameters:

i - set the TemporaryMarking of the place to i.

See Also:

getTemporaryMarking()

initialize

public void initialize()
                throws IllegalActionException

Set the current marking equal to the initial marking.

Specified by:

initialize in interface Initializable

Overrides:

initialize in class AtomicActor

Throws:

IllegalActionException - If the initialMarking parameter throws it.