ptolemy.domains.petrinet.kernel
Class Place

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.Transformer
                              extended byptolemy.domains.petrinet.kernel.Place
All Implemented Interfaces:
Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor

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,v 1.24 2004/04/13 03:33:47 cxh Exp $
Author:
Yuke Wang and Edward A. Lee
See Also:
Serialized Form
Accepted Rating:
Red (reviewmoderator)
Proposed Rating:
Red (yukewang)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
 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
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _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)
          decreaseMarking() is to decrease the _currentMarking by i
 void decreaseTemporaryMarking(int i)
          decreaseTemporaryMarking() is to 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)
          increaseMarking() is to increase the _currentMarking by i
 void increaseTemporaryMarking(int i)
           
 void initialize()
          Set the current marking equal to the initial marking.
 void setMarking(int i)
          setMarking() is to set the _currentMarking to i
 void setTemporaryMarking(int i)
          setTemporaryMarking() is to set the _temporaryMarking to i
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, clone, connectionsChanged, fire, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeChanged, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
fire, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

initialMarking

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

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.

increaseMarking

public void increaseMarking(int i)
increaseMarking() is to increase the _currentMarking by i

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

decreaseMarking

public void decreaseMarking(int i)
decreaseMarking() is to decrease the _currentMarking by i

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

decreaseTemporaryMarking

public void decreaseTemporaryMarking(int i)
decreaseTemporaryMarking() is to decrease the _temporaryMarking by i.

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

increaseTemporaryMarking

public void increaseTemporaryMarking(int i)
Parameters:
i - the number to be increased for the TemporaryMarking in the place.

setTemporaryMarking

public void setTemporaryMarking(int i)
setTemporaryMarking() is to set the _temporaryMarking to i

Parameters:
i - set the TemporaryMarking of the place to i.

setMarking

public void setMarking(int i)
setMarking() is to set the _currentMarking to i

Parameters:
i - set the marking of the place to i

initialize

public void initialize()
                throws IllegalActionException
Set the current marking equal to the initial marking.

Specified by:
initialize in interface Executable
Overrides:
initialize in class AtomicActor
Throws:
IllegalActionException - If the initialMarking parameter throws it.