Package org.kigalisim.engine.state

Class PriorEquipmentBases

java.lang.Object
org.kigalisim.engine.state.PriorEquipmentBases
public class PriorEquipmentBases extends Object
State supporting cumulative retirement / recharge base tracking (prior equip).

State manager tracking population bases and applied amounts across multiple retire/recharge commands within a timestep to enable cumulative calculations.

  • Constructor Details

    • PriorEquipmentBases

      public PriorEquipmentBases()
      Create a new PriorEquipmentBases instance with default values.

  • Method Details

    • getRetirementBasePopulation

      public Optional<EngineNumber> getRetirementBasePopulation()
      Get the retirement base population.
      Returns:
      The base population, or empty if not yet captured this step

    • setRetirementBasePopulation

      public void setRetirementBasePopulation(EngineNumber value)
      Set the retirement base population.
      Parameters:
      value - The base population value

    • getAppliedRetirementAmount

      public Optional<EngineNumber> getAppliedRetirementAmount()
      Get the applied retirement amount.
      Returns:
      The total amount already retired this step

    • setAppliedRetirementAmount

      public void setAppliedRetirementAmount(EngineNumber value)
      Set the applied retirement amount.
      Parameters:
      value - The total amount retired this step

    • getHasReplacementThisStep

      public boolean getHasReplacementThisStep()
      Get whether replacement was used in this step's retire commands.
      Returns:
      true if with replacement, false if without replacement

    • setHasReplacementThisStep

      public void setHasReplacementThisStep(boolean value)
      Set whether replacement is used in this step's retire commands.
      Parameters:
      value - true for with replacement, false for without replacement

    • getRetireCalculatedThisStep

      public boolean getRetireCalculatedThisStep()
      Get whether retire has been calculated this step.
      Returns:
      true if retire was calculated, false otherwise

    • setRetireCalculatedThisStep

      public void setRetireCalculatedThisStep(boolean calculated)
      Set whether retire has been calculated this step.
      Parameters:
      calculated - true if retire was calculated, false otherwise

    • getRechargeBasePopulation

      public Optional<EngineNumber> getRechargeBasePopulation()
      Get the recharge base population.
      Returns:
      The base population, or empty if not yet captured this step

    • setRechargeBasePopulation

      public void setRechargeBasePopulation(EngineNumber value)
      Set the recharge base population.
      Parameters:
      value - The base population value

    • getAppliedRechargeAmount

      public Optional<EngineNumber> getAppliedRechargeAmount()
      Get the applied recharge amount.
      Returns:
      The total amount already recharged this step in kg

    • setAppliedRechargeAmount

      public void setAppliedRechargeAmount(EngineNumber value)
      Set the applied recharge amount.
      Parameters:
      value - The total amount recharged this step in kg

    • getRecyclingCalculatedThisStep

      public boolean getRecyclingCalculatedThisStep()
      Get whether recycling has been calculated this step.
      Returns:
      true if recycling was calculated, false otherwise

    • setRecyclingCalculatedThisStep

      public void setRecyclingCalculatedThisStep(boolean calculated)
      Set whether recycling has been calculated this step.
      Parameters:
      calculated - true if recycling was calculated, false otherwise

    • resetStateAtTimestep

      public void resetStateAtTimestep()
      Reset all tracking state at the beginning of a timestep.