org.jbpt.petri

Class AbstractMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<P,Integer>

org.jbpt.petri.AbstractMarking<F,N,P,T>

All Implemented Interfaces:

Serializable, Cloneable, Map<P,Integer>, IMarking<F,N,P,T>

Direct Known Subclasses:

Marking

public abstract class AbstractMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>
extends HashMap<P,Integer>
implements IMarking<F,N,P,T>

Implementation of a Petri net marking.

Author:

Christian Wiggert, Artem Polyvyanyy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractMarking()
AbstractMarking(IPetriNet<F,N,P,T> net) Construct a marking and associate it with a given net.

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.
Set<Map.Entry<P,Integer>>	entrySet() Returns set of pairs where every pair specifies a marked place of the associated net and the number of tokens at the place.
boolean	equals(Object o)
boolean	fire(T transition) Fire a transition.
void	fromMultiSet(Collection<P> places) Construct this marking from the given multi-set of places.
Integer	get(Object p) Get number of tokens at a place.
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.
int	hashCode()
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 p, Integer tokens) Put specified number of tokens at a given place of the associated net.
void	putAll(Map<? extends P,? extends Integer> m) Copies all of the marking from the specified map to this marking.
Integer	remove(Object place) Removes all tokens from 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.
int	size() Returns the number of marked places in the associated net.
Collection<P>	toMultiSet() Get marking as a multi-set of places.

Methods inherited from class java.util.HashMap

containsKey, containsValue, keySet, values

Methods inherited from class java.util.AbstractMap

toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

containsKey, containsValue, keySet, values

Constructor Detail

AbstractMarking

public AbstractMarking()

AbstractMarking

public AbstractMarking(IPetriNet<F,N,P,T> net)

Construct a marking and associate it with a given net.

Parameters:

net - A net to associate marking with.

Throws:

IllegalArgumentException - if a given net is set to null.

Method Detail

put

public Integer put(P p,
          Integer tokens)

Description copied from interface: IMarking

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

Specified by:

put in interface Map<P extends IPlace,Integer>

Specified by:

put in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

put in class HashMap<P extends IPlace,Integer>

Parameters:

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

getPetriNet

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

Description copied from interface: IMarking

Get Petri net which this marking is associated with.

Specified by:

getPetriNet in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Petri net which this marking is associated with.

isMarked

public boolean isMarked(P place)

Description copied from interface: IMarking

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

Specified by:

isMarked in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Place of the associated net.

Returns:

true if p is marked; false otherwise.

toMultiSet

public Collection<P> toMultiSet()

Description copied from interface: IMarking

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

Specified by:

toMultiSet in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

Marking as a multi-set of places.

fromMultiSet

public void fromMultiSet(Collection<P> places)

Description copied from interface: IMarking

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.

Specified by:

fromMultiSet in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

places - Multi-set of places.

remove

public Integer remove(P place)

Description copied from interface: IMarking

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

Specified by:

remove in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

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

public Integer get(P place)

Description copied from interface: IMarking

Get number of tokens at a place.

Specified by:

get in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

place - Place of the associated net.

Returns:

Number of tokens at the place.

clear

public void clear()

Description copied from interface: IMarking

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>

Specified by:

clear in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

clear in class HashMap<P extends IPlace,Integer>

isEmpty

public boolean isEmpty()

Description copied from interface: IMarking

Returns true if this marking does not mark any place.

Specified by:

isEmpty in interface Map<P extends IPlace,Integer>

Specified by:

isEmpty in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

isEmpty in class HashMap<P extends IPlace,Integer>

Returns:

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

remove

public Integer remove(Object place)

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

Specified by:

remove in interface Map<P extends IPlace,Integer>

Overrides:

remove in class HashMap<P extends IPlace,Integer>

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.

putAll

public void putAll(Map<? extends P,? extends Integer> m)

Copies all of the marking from the specified map to this marking. These operation will replace any info that this marking had for any of the places currently in the specified map.

Specified by:

putAll in interface Map<P extends IPlace,Integer>

Overrides:

putAll in class HashMap<P extends IPlace,Integer>

Parameters:

map - Mapping to be stored in this marking.

Throws:

NullPointerException - if the specified map is null.

get

public Integer get(Object p)

Get number of tokens at a place.

Specified by:

get in interface Map<P extends IPlace,Integer>

Overrides:

get in class HashMap<P extends IPlace,Integer>

Parameters:

p - Place of the associated net.

Returns:

Number of tokens at the place.

size

public int size()

Returns the number of marked places in the associated net.

Specified by:

size in interface Map<P extends IPlace,Integer>

Overrides:

size in class HashMap<P extends IPlace,Integer>

Returns:

The number of marked places in the associated net.

entrySet

public Set<Map.Entry<P,Integer>> entrySet()

Returns set of pairs where every pair specifies a marked place of the associated net and the number of tokens at the place.

Specified by:

entrySet in interface Map<P extends IPlace,Integer>

Overrides:

entrySet in class HashMap<P extends IPlace,Integer>

Returns:

The set of pairs where every pair specifies a marked place of the associated net and the number of tokens at the place.

equals

public boolean equals(Object o)

Specified by:

equals in interface Map<P extends IPlace,Integer>

Overrides:

equals in class AbstractMap<P extends IPlace,Integer>

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<P extends IPlace,Integer>

Overrides:

hashCode in class AbstractMap<P extends IPlace,Integer>

createMarking

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

Description copied from interface: IMarking

Create fresh marking and associate it with a given net.

Specified by:

createMarking in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

net - Petri net.

Returns:

Fresh marking associated wuth the given 'net'.

setPetriNet

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

Description copied from interface: IMarking

Set net to associate this marking with.

Specified by:

setPetriNet in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

net - Petri net to associate this marking with.

fire

public boolean fire(T transition)

Description copied from interface: IMarking

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.

Specified by:

fire in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

transition - Transition to fire.

Returns:

true if firing took place; otherwise false.

clone

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

Description copied from interface: IMarking

Clone this marking.

Specified by:

clone in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

clone in class HashMap<P extends IPlace,Integer>

Returns:

Cloned version of this marking.

isBounded

public boolean isBounded(int n)

Description copied from interface: IMarking

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

Specified by:

isBounded in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

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

isSafe

public boolean isSafe()

Description copied from interface: IMarking

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

Specified by:

isSafe in interface IMarking<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Returns:

true if this marking is safe; otherwise false.