org.jbpt.petri.IMarking Maven / Gradle / Ivy
Show all versions of jbpt-petri Show documentation
package org.jbpt.petri;
import java.util.Collection;
import java.util.Map;
/**
* Interface to a Petri net marking.
*
* @author Artem Polyvyanyy
*/
public interface IMarking, N extends INode, P extends IPlace, T extends ITransition>
extends Map {
/**
* Put specified number of tokens at a given place of the associated net.
*
* @param place Place of the associated net.
* @param tokens Number of tokens to put at the given place.
* @return 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.
*/
public Integer put(P place, Integer tokens) throws IllegalArgumentException;
/**
* Check if place is marked, i.e., contains at least one token.
*
* @param place Place of the associated net.
* @return true if p is marked; false otherwise.
*/
public boolean isMarked(P place);
/**
* Get marking as a multi-set of places.
* The multi-set contains each place as many times as there are tokens at the place.
*
* @return Marking as a multi-set of places.
*/
public Collection toMultiSet();
/**
* 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.
*
* @param places Multi-set of places.
*/
public void fromMultiSet(Collection
places);
/**
* Clear this marking.
*
* After a call to this procedure, this marking describes a situation when no place of the associated net contains a token.
*/
public void clear();
/**
* Removes all tokens from a given place of the associated net.
*
* @param place Place of the associated net.
* @return The number of tokens previously contained in the given place, or null there was no token at the given place.
*/
public Integer remove(P place);
/**
* Get number of tokens at a place.
*
* @param place Place of the associated net.
* @return Number of tokens at the place.
*/
public Integer get(P place);
/**
* Returns true if this marking does not mark any place.
*
* @return true if this marking does not mark any place; false otherwise.
*/
public boolean isEmpty();
/**
* Get Petri net which this marking is associated with.
*
* @return Petri net which this marking is associated with.
*/
public IPetriNet getPetriNet();
/**
* Create fresh marking and associate it with a given net.
*
* @param net Petri net.
* @return Fresh marking associated wuth the given 'net'.
*/
public IMarking createMarking(IPetriNet net);
/**
* Set net to associate this marking with.
*
* @param net Petri net to associate this marking with.
*/
public void setPetriNet(IPetriNet net);
/**
* 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.
*
* @param transition Transition to fire.
* @return true if firing took place; otherwise false.
*/
public boolean fire(T transition);
/**
* Check if this marking is n-bounded, i.e., there are at most n tokens at every place.
* @param n
* @return true if this marking is n-bounded; otherwise false.
*/
public boolean isBounded(int n);
/**
* Check if this marking is safe, i.e., there is at most one token at every place.
* @param n
* @return true if this marking is safe; otherwise false.
*/
public boolean isSafe();
/**
* Clone this marking.
* @return Cloned version of this marking.
*/
public IMarking clone();
}