org.jbpt.petri

Class AbstractNetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

java.lang.Object

org.jbpt.hypergraph.abs.GObject

org.jbpt.hypergraph.abs.AbstractGraphNotifier<E,V>

org.jbpt.hypergraph.abs.AbstractMultiHyperGraph<E,V>

org.jbpt.hypergraph.abs.AbstractMultiDirectedHyperGraph<E,V>

org.jbpt.graph.abs.AbstractMultiDirectedGraph<E,V>

org.jbpt.graph.abs.AbstractDirectedGraph<F,N>

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

org.jbpt.petri.AbstractNetSystem<F,N,P,T,M>

All Implemented Interfaces:

Cloneable, Comparable<IGObject>, IDirectedGraph<F,N>, IGraph<F,N>, IDirectedHyperGraph<F,N>, IEntity, IEntityModel<N>, IGObject, IHyperGraph<F,N>, INetSystem<F,N,P,T,M>, IPetriNet<F,N,P,T>

Direct Known Subclasses:

NetSystem

public abstract class AbstractNetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>
extends AbstractPetriNet<F,N,P,T>
implements INetSystem<F,N,P,T,M>

Implementation of a net system.

Author:

Artem Polyvyanyy

Field Summary

Fields

Modifier and Type	Field and Description
protected M	marking

Fields inherited from class org.jbpt.hypergraph.abs.AbstractGraphNotifier

edges, vertices

Constructor Summary

Constructors

Constructor and Description
AbstractNetSystem()

Method Summary

Methods

Modifier and Type	Method and Description
INetSystem<F,N,P,T,M>	clone() Clone this Petri net.
INetSystem<F,N,P,T,M>	clone(Map<N,N> map) Clone this Petri net.
IMarking<F,N,P,T>	createMarking() Create a marking of this net system.
boolean	fire(T transition) Fire a transition in this net system.
Set<T>	getEnabledTransitions() Get enabled transitions of this net system.
Set<T>	getEnabledTransitions(Set<T> lastEnabled, T lastFired) Get enabled transitions of this net system more efficiently by providing details on last step in terms of previously enabled transitions and the one last fired.
Set<T>	getEnabledTransitionsAtMarking(M marking) Get enabled transitions of this net system at a given marking
Set<P>	getMarkedPlaces() Get marked places of this net system.
M	getMarking() Get marking of this net system.
Integer	getTokens(P p) Get number of tokens at a place.
boolean	isEnabled(T t) Check if a given transition is enabled.
boolean	isMarked(P p) Check if a given place is marked, i.e., contains at least one token.
void	loadMarking(M newMarking) Changes marking of this net system to the given one.
void	loadNaturalMarking() Changes marking of the net system to its natural initial marking, i.e., the marking which put one token at each source place of the net system and no tokens elsewhere.
Integer	putTokens(P p, Integer tokens) Put tokens at a given place.
N	removeNode(N n) Remove node from this net.
Collection<N>	removeNodes(Collection<N> ns) Remove nodes from this net.
P	removePlace(P p) Remove place from this net.
Collection<P>	removePlaces(Collection<P> ps) Remove places from this net.
String	toDOT()

Methods inherited from class org.jbpt.petri.AbstractPetriNet

addFlow, addFlow, addNode, addNodes, addPlace, addPlaces, addTransition, addTransitions, clear, createPlace, createTransition, getFlow, getMax, getMin, getNodes, getObservableTransitions, getPlaces, getPostset, getPostset, getPostset, getPostset, getPostsetPlaces, getPostsetTransitions, getPreset, getPreset, getPreset, getPreset, getPresetPlaces, getPresetTransitions, getSilentTransitions, getSinkNodes, getSinkPlaces, getSinkTransitions, getSourceNodes, getSourcePlaces, getSourceTransitions, getTransitions, removeFlow, removeFlow, removeTransition, removeTransitions

Methods inherited from class org.jbpt.graph.abs.AbstractDirectedGraph

addEdge, isMultiGraph

Methods inherited from class org.jbpt.graph.abs.AbstractMultiDirectedGraph

addEdge, areAdjacent, getDirectedEdge, getEdge, getEdges, getEdgesWithSources, getEdgesWithSourcesAndTargets, getEdgesWithTargets, removeVertex, removeVertices

Methods inherited from class org.jbpt.hypergraph.abs.AbstractMultiDirectedHyperGraph

addEdge, addEdge, checkEdge, getDirectPredecessors, getDirectPredecessors, getDirectSuccessors, getDirectSuccessors, getEdgesWithSource, getEdgesWithSourceAndTarget, getEdgesWithTarget, getFirstDirectPredecessor, getFirstDirectSuccessor, getFirstIncomingEdge, getFirstOutgoingEdge, getIncomingEdges, getOutgoingEdges

Methods inherited from class org.jbpt.hypergraph.abs.AbstractMultiHyperGraph

addVertex, addVertices, areAdjacent, checkEdge, contains, contains, contains, countEdges, countVertices, getAdjacent, getConnectedVertices, getDisconnectedVertices, getEdges, getEdges, getEdges, getEntities, getFreshVertex, getVertices, removeEdge, removeEdges, toString

Methods inherited from class org.jbpt.hypergraph.abs.AbstractGraphNotifier

addIndex, addIndex, clearMembers, removeIndex, removeIndex

Methods inherited from class org.jbpt.hypergraph.abs.GObject

compareTo, equals, getDescription, getId, getLabel, getName, getTag, hashCode, setDescription, setId, setName, setTag

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jbpt.petri.IPetriNet

addFlow, addFlow, addFlow, addNode, addNodes, addPlace, addPlaces, addTransition, addTransitions, clear, createPlace, createTransition, getFlow, getMax, getMin, getNodes, getObservableTransitions, getPlaces, getPostset, getPostset, getPostset, getPostset, getPostsetPlaces, getPostsetTransitions, getPreset, getPreset, getPreset, getPreset, getPresetPlaces, getPresetTransitions, getSilentTransitions, getSinkNodes, getSinkPlaces, getSinkTransitions, getSourceNodes, getSourcePlaces, getSourceTransitions, getTransitions, removeFlow, removeFlow, removeTransition, removeTransitions

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

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

Field Detail

marking

protected M extends IMarking<F,N,P,T> marking

Constructor Detail

AbstractNetSystem

public AbstractNetSystem()

Method Detail

removeNode

public N removeNode(N n)

Description copied from interface: IPetriNet

Remove node from this net.

Specified by:

removeNode in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

removeNode in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

n - Node to remove.

Returns:

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

removeNodes

public Collection<N> removeNodes(Collection<N> ns)

Description copied from interface: IPetriNet

Remove nodes from this net.

Specified by:

removeNodes in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

removeNodes in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

ns - Nodes to remove.

Returns:

Nodes removed from this net.

removePlace

public P removePlace(P p)

Description copied from interface: IPetriNet

Remove place from this net.

Specified by:

removePlace in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

removePlace in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

p - Place to remove.

Returns:

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

removePlaces

public Collection<P> removePlaces(Collection<P> ps)

Description copied from interface: IPetriNet

Remove places from this net.

Specified by:

removePlaces in interface IPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Overrides:

removePlaces in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

Parameters:

ps - Places to remove.

Returns:

Places removed from this net.

getMarking

public M getMarking()

Description copied from interface: INetSystem

Get marking of this net system.

Specified by:

getMarking in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Returns:

Marking of this net system.

getMarkedPlaces

public Set<P> getMarkedPlaces()

Description copied from interface: INetSystem

Get marked places of this net system.

Specified by:

getMarkedPlaces in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Returns:

Set of all marked places of this net system.

getEnabledTransitions

public Set<T> getEnabledTransitions()

Description copied from interface: INetSystem

Get enabled transitions of this net system.

Specified by:

getEnabledTransitions in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Returns:

Enabled transitions of this net system.

getEnabledTransitions

public Set<T> getEnabledTransitions(Set<T> lastEnabled,
                           T lastFired)

Description copied from interface: INetSystem

Get enabled transitions of this net system more efficiently by providing details on last step in terms of previously enabled transitions and the one last fired.

Specified by:

getEnabledTransitions in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Returns:

Enabled transitions of this net system.

getEnabledTransitionsAtMarking

public Set<T> getEnabledTransitionsAtMarking(M marking)

Description copied from interface: INetSystem

Get enabled transitions of this net system at a given marking

Specified by:

getEnabledTransitionsAtMarking in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Parameters:

marking - Marking of this net system.

Returns:

Enabled transitions of this net system at the given marking.

isEnabled

public boolean isEnabled(T t)

Description copied from interface: INetSystem

Check if a given transition is enabled.

Specified by:

isEnabled in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Parameters:

t - Transition.

Returns:

true if transition is enabled; otherwise false.

isMarked

public boolean isMarked(P p)

Description copied from interface: INetSystem

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

Specified by:

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

Parameters:

p - Place.

Returns:

true if place is marked; otherwise false.

fire

public boolean fire(T transition)

Description copied from interface: INetSystem

Fire a transition in this net system. 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 INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Parameters:

transition - Transition to fire.

Returns:

true if firing took place; otherwise false.

toDOT

public String toDOT()

Specified by:

toDOT in interface IGraph<F extends IFlow<N>,N extends INode>

Overrides:

toDOT in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

clone

public INetSystem<F,N,P,T,M> clone()

Description copied from interface: IPetriNet

Clone this Petri net.

Specified by:

clone in interface IEntity

Specified by:

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

Specified by:

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

Overrides:

clone in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

clone

public INetSystem<F,N,P,T,M> clone(Map<N,N> map)

Description copied from interface: IPetriNet

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

Specified by:

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

Specified by:

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

Overrides:

clone in class AbstractPetriNet<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition>

putTokens

public Integer putTokens(P p,
                Integer tokens)

Description copied from interface: INetSystem

Put tokens at a given place.

Specified by:

putTokens in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Parameters:

p - Place.

tokens - Number of tokens to put.

Returns:

the previous number of tokens at the given place, or null if parameters are wrong (either are equal to null or the given place does not belong to the net system)

getTokens

public Integer getTokens(P p)

Description copied from interface: INetSystem

Get number of tokens at a place.

Specified by:

getTokens in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Parameters:

p - Place.

Returns:

Number of tokens at p.

loadNaturalMarking

public void loadNaturalMarking()

Description copied from interface: INetSystem

Changes marking of the net system to its natural initial marking, i.e., the marking which put one token at each source place of the net system and no tokens elsewhere.

Specified by:

loadNaturalMarking in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

loadMarking

public void loadMarking(M newMarking)

Description copied from interface: INetSystem

Changes marking of this net system to the given one. Note that the new marking must be associated with this net system.

Specified by:

loadMarking in interface INetSystem<F extends IFlow<N>,N extends INode,P extends IPlace,T extends ITransition,M extends IMarking<F,N,P,T>>

Parameters:

newMarking - Marking to use for this net system.

createMarking

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

Description copied from interface: INetSystem

Create a marking of this net system.

Specified by:

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

Returns:

A marking of this net system.