/FileExtraction/Java_unseen/crisis-economics_CRISIS/CRISIS/src/eu/crisis_economics/abm/markets/clearing/heterogeneous/AbstractIterativeClearingAlgorithmStoppingCondition.java
/*
 * This file is part of CRISIS, an economics simulator.
 * 
 * Copyright (C) 2015 John Kieran Phillips
 *
 * CRISIS is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * CRISIS is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with CRISIS.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.crisis_economics.abm.markets.clearing.heterogeneous;

/** 
  * Abstract base class for iterative (counting) stopping conditions.
  * Classes derived from this type are 'throwaway' classes - each 
  * should be used only once per clearing session.
  * @author phillips
  */
abstract class AbstractIterativeClearingAlgorithmStoppingCondition
   implements MixedClearingNetworkAlgorithmStoppingCondition {
   
   private int numberOfIterationsElapsed;
   
   protected AbstractIterativeClearingAlgorithmStoppingCondition() {
      this.numberOfIterationsElapsed = 0;
   }
   
   /**
     * Increase the number of elapsed iterations by one.
     */
   protected final void incrementNumberOfIterations() {
      ++numberOfIterationsElapsed;
   }
   
   /**
     * Get the number of iterations passed to date.
     */
   public final int getNumberOfIterationsElapsed() {
      return numberOfIterationsElapsed;
   }
}
