org.jbpt.petri

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

All Superinterfaces:

Cloneable, Comparable<IGObject>, IDirectedGraph<F,N>, IDirectedHyperGraph<F,N>, IEntity, IEntityModel<N>, IGObject, IGraph<F,N>, IHyperGraph<F,N>

All Known Subinterfaces:

INetSystem<F,N,P,T,M>, IOccurrenceNet<BPN,C,E,F,N,P,T,M>

All Known Implementing Classes:

AbstractNetSystem, AbstractOccurrenceNet, AbstractPetriNet, NetSystem, OccurrenceNet, PetriNet

public interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>
extends IDirectedGraph<F,N>

Interface to a Petri net.

Author:

Artem Polyvyanyy, Matthias Weidlich

Method Summary

Methods

Modifier and Type	Method and Description
F	addFlow(N from, N to) Add flow to this net.
F	addFlow(P place, T transition) Add flow to this net.
F	addFlow(T transition, P place) Add flow to this net.
N	addNode(N node) Add node to this net.
Collection<N>	addNodes(Collection<N> nodes) Add nodes to this net.
P	addPlace(P place) Add place to this net.
Collection<P>	addPlaces(Collection<P> places) Add places to this net.
T	addTransition(T transition) Add transition to this net.
Collection<T>	addTransitions(Collection<T> transitions) Add transitions to this net.
void	clear() Clear this net.
IPetriNet<F,N,P,T>	clone() Clone this Petri net.
IPetriNet<F,N,P,T>	clone(Map<N,N> map) Clone this Petri net.
P	createPlace() Factory method to provide a place of the Petri net implementation.
T	createTransition() Factory method to provide a transition of the Petri net implementation.
Set<F>	getFlow() Get flow relation of this net.
Set<N>	getMax() Get maximal nodes of this net (alias of getSinkNodes).
Set<N>	getMin() Get minimal nodes of this net (alias of getSourceNodes).
Set<N>	getNodes() Get nodes of this net.
Set<T>	getObservableTransitions() Get observable transitions of this net.
Set<P>	getPlaces() Get places of this net.
Set<N>	getPostset(Collection<N> nodes) Get postset of given nodes.
Set<N>	getPostset(N node) Get postset of a given node.
Set<T>	getPostset(P place) Get postset of a given place
Set<P>	getPostset(T transition) Get postset of a given transition.
Set<P>	getPostsetPlaces(Collection<T> transitions) Get postset of given transitions.
Set<T>	getPostsetTransitions(Collection<P> places) Get postset of given places.
Set<N>	getPreset(Collection<N> nodes) Get preset of the given nodes.
Set<N>	getPreset(N node) Get preset of a given node.
Set<T>	getPreset(P place) Get preset of a given place.
Set<P>	getPreset(T transition) Get preset of a given transition.
Set<P>	getPresetPlaces(Collection<T> transitions) Get preset of given transitions.
Set<T>	getPresetTransitions(Collection<P> places) Get preset of given places.
Set<T>	getSilentTransitions() Get silent transitions of this net.
Set<N>	getSinkNodes() Get sink nodes of this net.
Set<P>	getSinkPlaces() Get sink places of this net.
Set<T>	getSinkTransitions() Get sink transitions of this net.
Set<N>	getSourceNodes() Get source nodes of this net.
Set<P>	getSourcePlaces() Get source places of this net.
Set<T>	getSourceTransitions() Get source transitions of this net.
Set<T>	getTransitions() Get transitions of this net.
Collection<F>	removeFlow(Collection<F> flow) Remove flow from this net.
F	removeFlow(F flow) Remove flow from this net.
N	removeNode(N node) Remove node from this net.
Collection<N>	removeNodes(Collection<N> nodes) Remove nodes from this net.
P	removePlace(P place) Remove place from this net.
Collection<P>	removePlaces(Collection<P> places) Remove places from this net.
T	removeTransition(T transition) Remove transition from this net.
Collection<T>	removeTransitions(Collection<T> transitions) Remove transitions from this net.

Methods inherited from interface org.jbpt.graph.abs.IDirectedGraph

getDirectedEdge

Methods inherited from interface org.jbpt.hypergraph.abs.IDirectedHyperGraph

addEdge, addEdge, getDirectPredecessors, getDirectPredecessors, getDirectSuccessors, getDirectSuccessors, getEdgesWithSource, getEdgesWithSourceAndTarget, getEdgesWithSources, getEdgesWithSourcesAndTargets, getEdgesWithTarget, getEdgesWithTargets, getFirstDirectPredecessor, getFirstDirectSuccessor, getFirstIncomingEdge, getFirstOutgoingEdge, getIncomingEdges, getOutgoingEdges

Methods inherited from interface org.jbpt.graph.abs.IGraph

areAdjacent, getEdge, getEdges, toDOT

Methods inherited from interface org.jbpt.hypergraph.abs.IHyperGraph

addEdge, addEdge, addVertex, addVertices, areAdjacent, contains, contains, countEdges, countVertices, getAdjacent, getConnectedVertices, getDisconnectedVertices, getEdges, getEdges, getEdges, getFreshVertex, getVertices, isMultiGraph, removeEdge, removeEdges, removeVertex, removeVertices

Methods inherited from interface org.jbpt.hypergraph.abs.IGObject

getDescription, getId, getName, getTag, setDescription, setId, setName, setTag

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.jbpt.hypergraph.abs.IEntity

getLabel

Methods inherited from interface org.jbpt.hypergraph.abs.IEntityModel

getEntities

Method Detail

addFlow

F addFlow(N from,
        N to)

Add flow to this net. This method ensures net stays bipartite.

Parameters:

from - Source node.

to - Target node.

Returns:

Flow added to this net; null if no flow was added.

addFlow

F addFlow(P place,
        T transition)

Add flow to this net.

Parameters:

place - Source place.

transition - Target transition.

Returns:

Flow added to this net; null if no flow was added.

addFlow

F addFlow(T transition,
        P place)

Add flow to this net.

Parameters:

transition - Source transition.

place - Target place.

Returns:

Flow added to this net; null if no flow was added.

addNode

N addNode(N node)

Add node to this net.

Parameters:

node - Node to add.

Returns:

Node added to this net; null if no node was added.

addNodes

Collection<N> addNodes(Collection<N> nodes)

Add nodes to this net.

Parameters:

nodes - Nodes to add.

Returns:

Nodes added to this net.

addPlace

P addPlace(P place)

Add place to this net.

Parameters:

place - Place to add.

Returns:

Place added to this net; null if no place was added.

addPlaces

Collection<P> addPlaces(Collection<P> places)

Add places to this net.

Parameters:

places - Places to add.

Returns:

Places added to this net.

addTransition

T addTransition(T transition)

Add transition to this net.

Parameters:

transition - Transition to add.

Returns:

Transition added to this net; null if no transition was added.

addTransitions

Collection<T> addTransitions(Collection<T> transitions)

Add transitions to this net.

Parameters:

transitions - Transitions to add.

Returns:

Transitions added to this net.

removeNode

N removeNode(N node)

Remove node from this net.

Parameters:

node - Node to remove.

Returns:

Node removed from this net; null if node was not removed.

removeNodes

Collection<N> removeNodes(Collection<N> nodes)

Remove nodes from this net.

Parameters:

nodes - Nodes to remove.

Returns:

Nodes removed from this net.

removePlace

P removePlace(P place)

Remove place from this net.

Parameters:

place - Place to remove.

Returns:

Place removed from this net; null if place was not removed.

removePlaces

Collection<P> removePlaces(Collection<P> places)

Remove places from this net.

Parameters:

places - Places to remove.

Returns:

Places removed from this net.

removeTransition

T removeTransition(T transition)

Remove transition from this net.

Parameters:

transition - Transition to remove.

Returns:

Transition removed from this net; null if transition was not removed.

removeTransitions

Collection<T> removeTransitions(Collection<T> transitions)

Remove transitions from this net.

Parameters:

transitions - Transitions to remove.

Returns:

Transitions removed from this net.

removeFlow

F removeFlow(F flow)

Remove flow from this net.

Parameters:

flow - Flow to remove.

Returns:

Flow removed from this net; null if no flow was removed.

removeFlow

Collection<F> removeFlow(Collection<F> flow)

Remove flow from this net.

Parameters:

flow - Flow to remove.

Returns:

Flow removed from this net.

getNodes

Set<N> getNodes()

Get nodes of this net.

Returns:

Nodes of this net.

getPlaces

Set<P> getPlaces()

Get places of this net.

Returns:

Places of this net.

getTransitions

Set<T> getTransitions()

Get transitions of this net.

Returns:

Transitions of this net.

getFlow

Set<F> getFlow()

Get flow relation of this net.

Returns:

Flow relation of this net.

getSilentTransitions

Set<T> getSilentTransitions()

Get silent transitions of this net.

Returns:

Silent transitions of this net.

getObservableTransitions

Set<T> getObservableTransitions()

Get observable transitions of this net.

Returns:

Observable transitions of this net.

getPostset

Set<P> getPostset(T transition)

Get postset of a given transition.

Parameters:

transition - Transition.

Returns:

Postset of the given transition.

getPostsetPlaces

Set<P> getPostsetPlaces(Collection<T> transitions)

Get postset of given transitions.

Parameters:

transitions - Transitions.

Returns:

Postset of the given transitions.

getPostset

Set<T> getPostset(P place)

Get postset of a given place

Parameters:

place - Place.

Returns:

Postset of the given place.

getPostsetTransitions

Set<T> getPostsetTransitions(Collection<P> places)

Get postset of given places.

Parameters:

places - Places.

Returns:

Postset of the given places.

getPostset

Set<N> getPostset(N node)

Get postset of a given node.

Parameters:

node - Node.

Returns:

Postset of the given node.

getPostset

Set<N> getPostset(Collection<N> nodes)

Get postset of given nodes.

Parameters:

nodes - Nodes.

Returns:

Postset of given nodes.

getPreset

Set<P> getPreset(T transition)

Get preset of a given transition.

Parameters:

transition - Transition.

Returns:

Preset of the given transition.

getPresetPlaces

Set<P> getPresetPlaces(Collection<T> transitions)

Get preset of given transitions.

Parameters:

transitions - Transitions.

Returns:

Preset of given transitions.

getPreset

Set<T> getPreset(P place)

Get preset of a given place.

Parameters:

place - Place.

Returns:

Preset of the given place.

getPresetTransitions

Set<T> getPresetTransitions(Collection<P> places)

Get preset of given places.

Parameters:

places - Places.

Returns:

Preset of the given places.

getPreset

Set<N> getPreset(N node)

Get preset of a given node.

Parameters:

node - Node.

Returns:

Preset of the given node.

getPreset

Set<N> getPreset(Collection<N> nodes)

Get preset of the given nodes.

Parameters:

nodes - Nodes.

Returns:

Preset of the given nodes.

getSourceNodes

Set<N> getSourceNodes()

Get source nodes of this net. A node is a source node if it has empty preset.

Returns:

Source nodes of this net.

getSourcePlaces

Set<P> getSourcePlaces()

Get source places of this net. A place is a source place if it has empty preset.

Returns:

Source places of this net.

getSourceTransitions

Set<T> getSourceTransitions()

Get source transitions of this net. A transition is a source transition if it has empty preset.

Returns:

Source transitions of this net.

getSinkNodes

Set<N> getSinkNodes()

Get sink nodes of this net. A node is a sink node if it has empty postset.

Returns:

Sink nodes of this net.

getSinkPlaces

Set<P> getSinkPlaces()

Get sink places of this net. A place is a sink place if it has empty postset.

Returns:

Sink places of this net.

getSinkTransitions

Set<T> getSinkTransitions()

Get sink transitions of this net. A transition is a sink transition if it has empty postset.

Returns:

Sink transitions of this net.

getMin

Set<N> getMin()

Get minimal nodes of this net (alias of getSourceNodes).

Returns:

Minimal nodes of this net.

getMax

Set<N> getMax()

Get maximal nodes of this net (alias of getSinkNodes).

Returns:

Maximal nodes of this net.

createTransition

T createTransition()

Factory method to provide a transition of the Petri net implementation.

Returns:

A fresh transition.

createPlace

P createPlace()

Factory method to provide a place of the Petri net implementation.

Returns:

A fresh place.

clear

void clear()

Clear this net.

clone

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

Clone this Petri net.

Specified by:

clone in interface IEntity

clone

IPetriNet<F,N,P,T> clone(Map<N,N> map)

Clone this Petri net. The set map is a map from nodes of the original net to nodes of the cloned net.