Package megamek.common.strategicBattleSystems

Class BaseFormationConverter<T extends SBFFormation>

java.lang.Object

megamek.common.strategicBattleSystems.BaseFormationConverter<T>

Direct Known Subclasses:

EntityAsFormation, EntityAsUnit, LowestForceAsUnit, SBFFormationConverter

public abstract class BaseFormationConverter<T extends SBFFormation>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final Force	force
protected T	formation
protected final IGame	game
protected final CalculationReport	report

Constructor Summary

Constructors

Constructor	Description
BaseFormationConverter(Force force, IGame game, T formation)
BaseFormationConverter(Force force, IGame game, T formation, CalculationReport report)

Method Summary

Modifier and Type	Method	Description
protected void	calcSbfFormationStats()	Calculates the SBF Formation stats for the SBF Units it must already contain.
static boolean	canConvertToSbfFormation(Force force, IGame game)	Returns true if the given force can be converted to an SBF Formation.
abstract T	convert()	Returns an SBF Formation formed from the given force.

Methods inherited from class java.lang.Object

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

Field Details

force

protected final Force force

game

protected final IGame game

report

protected final CalculationReport report

formation

protected T extends SBFFormation formation

Constructor Details

BaseFormationConverter

public BaseFormationConverter(Force force,
 IGame game,
 T formation)

BaseFormationConverter

public BaseFormationConverter(Force force,
 IGame game,
 T formation,
 CalculationReport report)

Method Details

canConvertToSbfFormation

public static boolean canConvertToSbfFormation(Force force,
 IGame game)

Returns true if the given force can be converted to an SBF Formation.

convert

public abstract T convert()

Returns an SBF Formation formed from the given force. When the force cannot be converted to an SBF Formation according to the rules, returns null. The given force must be approximately company-shaped to work, i.e. it has to contain some subForces with some entities in each sub force but no further subForces.

calcSbfFormationStats

protected void calcSbfFormationStats()

Calculates the SBF Formation stats for the SBF Units it must already contain.