org.jbpt.petri

Interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

All Superinterfaces:

Map<P,Integer>

All Known Implementing Classes:

AbstractMarking, Marking

public interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>
extends Map<P,Integer>

Interface to a Petri net marking.

Author:

Artem Polyvyanyy

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Clear this marking.
IMarking<F,N,P,T>	clone() Clone this marking.
IMarking<F,N,P,T>	createMarking(IPetriNet<F,N,P,T> net) Create fresh marking and associate it with a given net.
boolean	fire(T transition) Fire a transition.
void	fromMultiSet(Collection<P> places) Construct this marking from the given multi-set of places.
Integer	get(P place) Get number of tokens at a place.
IPetriNet<F,N,P,T>	getPetriNet() Get Petri net which this marking is associated with.
boolean	isBounded(int n) Check if this marking is n-bounded, i.e., there are at most n tokens at every place.
boolean	isEmpty() Returns true if this marking does not mark any place.
boolean	isMarked(P place) Check if place is marked, i.e., contains at least one token.
boolean	isSafe() Check if this marking is safe, i.e., there is at most one token at every place.
Integer	put(P place, Integer tokens) Put specified number of tokens at a given place of the associated net.
Integer	remove(P place) Removes all tokens from a given place of the associated net.
void	setPetriNet(IPetriNet<F,N,P,T> net) Set net to associate this marking with.
Collection<P>	toMultiSet() Get marking as a multi-set of places.

Methods inherited from interface java.util.Map

containsKey, containsValue, entrySet, equals, get, hashCode, keySet, putAll, remove, size, values

Method Detail

put

Integer put(P place,
          Integer tokens)
            throws IllegalArgumentException

Put specified number of tokens at a given place of the associated net.

Specified by:

put in interface Map<P extends IPlace,Integer>

Parameters:

place - Place of the associated net.

tokens - Number of tokens to put at the given place.

Returns:

Previous number of tokens at the given place. Returns 0 if place is set to null. Attempts to remove all tokens from the given place if tokens is negative, equals to 0, or is set to null.

Throws:

IllegalArgumentException - if the given place is not part of the associated net.

isMarked

boolean isMarked(P place)

Check if place is marked, i.e., contains at least one token.

Parameters:

place - Place of the associated net.

Returns:

true if p is marked; false otherwise.

toMultiSet

Collection<P> toMultiSet()

Get marking as a multi-set of places. The multi-set contains each place as many times as there are tokens at the place.

Returns:

Marking as a multi-set of places.

fromMultiSet

void fromMultiSet(Collection<P> places)

Construct this marking from the given multi-set of places. The multi-set contains each place as many times as there are tokens at the place.

Parameters:

places - Multi-set of places.

clear

void clear()

Clear this marking. After a call to this procedure, this marking describes a situation when no place of the associated net contains a token.

Specified by:

clear in interface Map<P extends IPlace,Integer>

remove

Integer remove(P place)

Removes all tokens from a given place of the associated net.

Parameters:

place - Place of the associated net.

Returns:

The number of tokens previously contained in the given place, or null there was no token at the given place.

get

Integer get(P place)

Get number of tokens at a place.

Parameters:

place - Place of the associated net.

Returns:

Number of tokens at the place.

isEmpty

boolean isEmpty()

Returns true if this marking does not mark any place.

Specified by:

isEmpty in interface Map<P extends IPlace,Integer>

Returns:

true if this marking does not mark any place; false otherwise.

getPetriNet

IPetriNet<F,N,P,T> getPetriNet()

Get Petri net which this marking is associated with.

Returns:

Petri net which this marking is associated with.

createMarking

IMarking<F,N,P,T> createMarking(IPetriNet<F,N,P,T> net)

Create fresh marking and associate it with a given net.

Parameters:

net - Petri net.

Returns:

Fresh marking associated wuth the given 'net'.

setPetriNet

void setPetriNet(IPetriNet<F,N,P,T> net)

Set net to associate this marking with.

Parameters:

net - Petri net to associate this marking with.

fire

boolean fire(T transition)

Fire a transition. Transition fires only if it is enabled. Firing of a transition removes one token from every input place and adds one token to every output place of the transition.

Parameters:

transition - Transition to fire.

Returns:

true if firing took place; otherwise false.

isBounded

boolean isBounded(int n)

Check if this marking is n-bounded, i.e., there are at most n tokens at every place.

Parameters:

n -

Returns:

true if this marking is n-bounded; otherwise false.

isSafe

boolean isSafe()

Check if this marking is safe, i.e., there is at most one token at every place.

Parameters:

n -

Returns:

true if this marking is safe; otherwise false.

clone

IMarking<F,N,P,T> clone()

Clone this marking.

Returns:

Cloned version of this marking.