net.java

Rakiura JFern是一个非常轻型的带有模拟器的Petri网络框架

// This is copyrighted source file, part of Rakiura JFern package. 
// See the file LICENSE for copyright information and the terms and conditions
// for copying, distributing and modifications of Rakiura JFern package.
// Copyright (C) 1999-2002 by Mariusz Nowostawski and others  [http://www.rakiura.org]

package org.rakiura.cpn;

/**/
import java.util.List;
import org.rakiura.cpn.event.PlaceListener;
import org.rakiura.cpn.event.TransitionListener;

/**
 * Represents a Colour Petri Net. Represents a complete graph
 * of a given CPN.
 * 
 *<br><br>
 * Net.java<br>
 * Created: Tue Sep 26 15:33:55 2000<br>
 *
 *@author  <a href="[e-mail]">Mariusz Nowostawski</a>
 *@version 2.1.0 $Revision: 1.6 $
 *@since 1.0
 */
public interface Net extends NetElement {

  /**
   * Adds given PlaceListener to all Places in this net.
   *@param aListener a <code>PlaceListener</code> to be 
   *  registered with all the places in this net.
   *@since 2.0
   */
  void addPlaceListener(final PlaceListener aListener);

  /**
   * Adds given TransitionListener to all Transitions in this net.
   *@param aListener a <code>TransitionListener</code> to be 
   *  registered with all the transitions in this net.
   *@since 2.0
   */
  void addTransitionListener(final TransitionListener aListener);



  /** 
   * Adds a node to the net.
   *@param aNode NetElement to be added to the net.
   *@return this net. 
   */
  Net add(final NetElement aNode);

  /**
   * Removes the specified node from the net.
   *@param aNode NetElement to be removed.
   *@return null if there was no such element in the net, or the
   * removed node. 
   */
  NetElement remove(final NetElement aNode);

  /**
   * Looks up a node by its ID.
   *@param anId ID of the node.
   *@return the node object or null if not found. 
   */
  NetElement forID(final String anId);

  /**
   * Looks up a node by its name. 
   *@param aName Name of the node.
   *@return the node object or null if not found. 
   */
  NetElement forName(final String aName);

  /**
   * Returns all the transitions from this net.
   *@return list with all the transitions. 
   */
  List transitions();

  /**
   * Returns all the places from this net.
   *@return list with all the places. 
   */
  List places();
  
  /**
   * Returns the current marking of the net.
   *@return current marking of the net. 
   */
  Marking marking();

  /**
   * Sets new marking for the entire net. If some places are not
   * referenced in the new marking, the existing marking is left
   * unchanged.
   *@see #resetMarking
   *@param aMarking new Marking for the entire net.
   *@return previous marking of the net. 
   */
   Marking setMarking(final Marking aMarking);

  /**
   * Resets the marking in the entire net.
   *@return previous marking of the net. 
   */
  Marking resetMarking();

  /**
   * Rehash names of this Petri Net. This method can be used
   * to dynamically rehash the internal net datastructures to 
   * reflect any dynamic name changes.
   */
  void rehash();


} // Net
//////////////////// end of file ////////////////////