org.jbpt.petri.IPetriNet Maven / Gradle / Ivy
Show all versions of jbpt-petri Show documentation
package org.jbpt.petri;
import java.util.Collection;
import java.util.Map;
import java.util.Set;
import org.jbpt.graph.abs.IDirectedGraph;
/**
* Interface to a Petri net.
*
* @author Artem Polyvyanyy
* @author Matthias Weidlich
*/
public interface IPetriNet, N extends INode, P extends IPlace, T extends ITransition> extends IDirectedGraph {
/**
* Add flow to this net.
* This method ensures net stays bipartite.
*
* @param from Source node.
* @param to Target node.
* @return Flow added to this net; null if no flow was added.
*/
public F addFlow(N from, N to);
/**
* Add flow to this net.
*
* @param place Source place.
* @param transition Target transition.
* @return Flow added to this net; null if no flow was added.
*/
public F addFlow(P place, T transition);
/**
* Add flow to this net.
*
* @param transition Source transition.
* @param place Target place.
* @return Flow added to this net; null if no flow was added.
*/
public F addFlow(T transition, P place);
/**
* Add node to this net.
*
* @param node Node to add.
* @return Node added to this net; null if no node was added.
*/
public N addNode(N node);
/**
* Add nodes to this net.
*
* @param nodes Nodes to add.
* @return Nodes added to this net.
*/
public Collection addNodes(Collection nodes);
/**
* Add place to this net.
*
* @param place Place to add.
* @return Place added to this net; null if no place was added.
*/
public P addPlace(P place);
/**
* Add places to this net.
*
* @param places Places to add.
* @return Places added to this net.
*/
public Collection addPlaces(Collection
places);
/**
* Add transition to this net.
*
* @param transition Transition to add.
* @return Transition added to this net; null if no transition was added.
*/
public T addTransition(T transition);
/**
* Add transitions to this net.
*
* @param transitions Transitions to add.
* @return Transitions added to this net.
*/
public Collection addTransitions(Collection transitions);
/**
* Remove node from this net.
*
* @param node Node to remove.
* @return Node removed from this net; null if node was not removed.
*/
public N removeNode(N node);
/**
* Remove nodes from this net.
*
* @param nodes Nodes to remove.
* @return Nodes removed from this net.
*/
public Collection removeNodes(Collection nodes);
/**
* Remove place from this net.
*
* @param place Place to remove.
* @return Place removed from this net; null if place was not removed.
*/
public P removePlace(P place);
/**
* Remove places from this net.
*
* @param places Places to remove.
* @return Places removed from this net.
*/
public Collection removePlaces(Collection
places);
/**
* Remove transition from this net.
*
* @param transition Transition to remove.
* @return Transition removed from this net; null if transition was not removed.
*/
public T removeTransition(T transition);
/**
* Remove transitions from this net.
*
* @param transitions Transitions to remove.
* @return Transitions removed from this net.
*/
public Collection removeTransitions(Collection transitions);
/**
* Remove flow from this net.
*
* @param flow Flow to remove.
* @return Flow removed from this net; null if no flow was removed.
*/
public F removeFlow(F flow);
/**
* Remove flow from this net.
*
* @param flow Flow to remove.
* @return Flow removed from this net.
*/
public Collection removeFlow(Collection flow);
/**
* Get nodes of this net.
*
* @return Nodes of this net.
*/
public Set getNodes();
/**
* Get places of this net.
*
* @return Places of this net.
*/
public Set getPlaces();
/**
* Get transitions of this net.
*
* @return Transitions of this net.
*/
public Set getTransitions();
/**
* Get flow relation of this net.
*
* @return Flow relation of this net.
*/
public Set getFlow();
/**
* Get silent transitions of this net.
*
* @return Silent transitions of this net.
*/
public Set getSilentTransitions();
/**
* Get observable transitions of this net.
*
* @return Observable transitions of this net.
*/
public Set getObservableTransitions();
/**
* Get postset of a given transition.
*
* @param transition Transition.
* @return Postset of the given transition.
*/
public Set getPostset(T transition);
/**
* Get postset of given transitions.
*
* @param transitions Transitions.
* @return Postset of the given transitions.
*/
public Set
getPostsetPlaces(Collection transitions);
/**
* Get postset of a given place
*
* @param place Place.
* @return Postset of the given place.
*/
public Set getPostset(P place);
/**
* Get postset of given places.
*
* @param places Places.
* @return Postset of the given places.
*/
public Set getPostsetTransitions(Collection places);
/**
* Get postset of a given node.
*
* @param node Node.
* @return Postset of the given node.
*/
public Set getPostset(N node);
/**
* Get postset of given nodes.
*
* @param nodes Nodes.
* @return Postset of given nodes.
*/
public Set getPostset(Collection nodes);
/**
* Get preset of a given transition.
*
* @param transition Transition.
* @return Preset of the given transition.
*/
public Set getPreset(T transition);
/**
* Get preset of given transitions.
*
* @param transitions Transitions.
* @return Preset of given transitions.
*/
public Set
getPresetPlaces(Collection transitions);
/**
* Get preset of a given place.
*
* @param place Place.
* @return Preset of the given place.
*/
public Set getPreset(P place);
/**
* Get preset of given places.
*
* @param places Places.
* @return Preset of the given places.
*/
public Set getPresetTransitions(Collection places);
/**
* Get preset of a given node.
*
* @param node Node.
* @return Preset of the given node.
*/
public Set getPreset(N node);
/**
* Get preset of the given nodes.
*
* @param nodes Nodes.
* @return Preset of the given nodes.
*/
public Set getPreset(Collection nodes);
/**
* Get source nodes of this net.
* A node is a source node if it has empty preset.
*
* @return Source nodes of this net.
*/
public Set getSourceNodes();
/**
* Get source places of this net.
* A place is a source place if it has empty preset.
*
* @return Source places of this net.
*/
public Set getSourcePlaces();
/**
* Get source transitions of this net.
* A transition is a source transition if it has empty preset.
*
* @return Source transitions of this net.
*/
public Set getSourceTransitions();
/**
* Get sink nodes of this net.
* A node is a sink node if it has empty postset.
*
* @return Sink nodes of this net.
*/
public Set getSinkNodes();
/**
* Get sink places of this net.
* A place is a sink place if it has empty postset.
*
* @return Sink places of this net.
*/
public Set getSinkPlaces();
/**
* Get sink transitions of this net.
* A transition is a sink transition if it has empty postset.
*
* @return Sink transitions of this net.
*/
public Set getSinkTransitions();
/**
* Get minimal nodes of this net (alias of {@link getSourceNodes}).
*
* @return Minimal nodes of this net.
*/
public Set getMin();
/**
* Get maximal nodes of this net (alias of {@link getSinkNodes}).
*
* @return Maximal nodes of this net.
*/
public Set getMax();
/**
* Factory method to provide a transition of the Petri net implementation.
*
* @return A fresh transition.
*/
public T createTransition();
/**
* Factory method to provide a place of the Petri net implementation.
*
* @return A fresh place.
*/
public P createPlace();
/**
* Clear this net.
*/
public void clear();
/**
* Clone this Petri net.
*/
public IPetriNet clone();
/**
* Clone this Petri net. The set map is a map from nodes of the original net to nodes of the cloned net.
*/
public IPetriNet clone(Map map);
}