Package org.kigalisim.engine.recalc

Class RetireBackgroundInfo

java.lang.Object

org.kigalisim.engine.recalc.RetireBackgroundInfo

public class RetireBackgroundInfo
extends Object

Immutable container for retirement background state information.

Constructor Summary

Constructors

Constructor	Description
RetireBackgroundInfo(EngineNumber currentPrior, EngineNumber currentEquipment, EngineNumber currentRetired, EngineNumber basePopulation, boolean firstRetire)	Create a new RetireBackgroundInfo.

Method Summary

Modifier and Type	Method	Description
EngineNumber	getBasePopulation()	Get the base population for retirement calculations.
EngineNumber	getCurrentEquipment()	Get the current total equipment value.
EngineNumber	getCurrentPrior()	Get the current prior equipment value.
EngineNumber	getCurrentRetired()	Get the current retired value.
boolean	isFirstRetire()	Check if this is the first retirement operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RetireBackgroundInfo

public RetireBackgroundInfo(EngineNumber currentPrior,
 EngineNumber currentEquipment,
 EngineNumber currentRetired,
 EngineNumber basePopulation,
 boolean firstRetire)

Create a new RetireBackgroundInfo.

Parameters:

currentPrior - Current prior equipment value in units

currentEquipment - Current total equipment value in units

currentRetired - Current retired value in units

basePopulation - Base population for retirement rate calculations

firstRetire - Whether this is the first retirement operation for this scope

Method Details

getCurrentPrior

public EngineNumber getCurrentPrior()

Get the current prior equipment value.

Returns:

Current prior equipment in units

getCurrentEquipment

public EngineNumber getCurrentEquipment()

Get the current total equipment value.

Returns:

Current total equipment in units

getCurrentRetired

public EngineNumber getCurrentRetired()

Get the current retired value.

Returns:

Current cumulative retired equipment in units

getBasePopulation

public EngineNumber getBasePopulation()

Get the base population for retirement calculations.

Returns:

Base population used for converting retirement rates to absolute amounts

isFirstRetire

public boolean isFirstRetire()

Check if this is the first retirement operation.

Returns:

true if this is the first retire operation for this scope, false otherwise