Package megamek.common.containers

Class MunitionTree

java.lang.Object

megamek.common.containers.MunitionTree

public class MunitionTree
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final List<String>	AC_MUNITION_NAMES
static final List<String>	ARROW_MUNITION_NAMES
static final List<String>	ARTILLERY_CANNON_MUNITION_NAMES
static final List<String>	ARTILLERY_MUNITION_NAMES
static final List<String>	ATM_MUNITION_NAMES
static final List<String>	BOMB_MUNITION_NAMES
static final List<String>	iATM_MUNITION_NAMES
static final List<String>	LRM_MUNITION_NAMES
static final List<String>	MORTAR_MUNITION_NAMES
static final List<String>	NARC_MUNITION_NAMES
static final List<String>	SRM_MUNITION_NAMES

Constructor Summary

Constructors

Constructor	Description
MunitionTree()
MunitionTree(String fName)	Constructor for reading in files containing load out imperatives.
MunitionTree(MunitionTree mt)

Method Summary

Modifier and Type	Method	Description
int	getCountOfAmmoForKey(String chassis, String variant, String pilot, String binType, String ammoType)	Return the actual, or effective, desired count of ammo bins for the given binType and ammoType
HashMap<String,Integer>	getCountsOfAmmunitionForKey(String chassis, String variant, String pilot, String binType)
String	getEffectiveImperative(String chassis, String variant, String pilot, String binType)	Deprecated, for removal: This API element is subject to removal in a future version.
List<String>	getPriorityList(String chassis, String variant, String pilot, String binType)
void	insertImperative(String chassis, String variant, String pilot, String binType, String... ammoTypes)
void	insertImperatives(String chassis, String variant, String pilot, HashMap<String,String> imperatives)
void	insertMangledImperatives(String chassis, String variant, String pilot, HashMap<String,String> imperatives)	Deprecated, for removal: This API element is subject to removal in a future version.
void	loadEntityList(List<Entity> el)	Convert List of Entities into a set of specific imperatives for each unit.
void	readFromADF(BufferedReader br)
void	writeToADFFilename(String fName)
void	writeToADFFormat(BufferedWriter bw)

Methods inherited from class java.lang.Object

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

Field Details

LRM_MUNITION_NAMES

public static final List<String> LRM_MUNITION_NAMES

SRM_MUNITION_NAMES

public static final List<String> SRM_MUNITION_NAMES

AC_MUNITION_NAMES

public static final List<String> AC_MUNITION_NAMES

ATM_MUNITION_NAMES

public static final List<String> ATM_MUNITION_NAMES

iATM_MUNITION_NAMES

public static final List<String> iATM_MUNITION_NAMES

ARROW_MUNITION_NAMES

public static final List<String> ARROW_MUNITION_NAMES

ARTILLERY_MUNITION_NAMES

public static final List<String> ARTILLERY_MUNITION_NAMES

ARTILLERY_CANNON_MUNITION_NAMES

public static final List<String> ARTILLERY_CANNON_MUNITION_NAMES

MORTAR_MUNITION_NAMES

public static final List<String> MORTAR_MUNITION_NAMES

NARC_MUNITION_NAMES

public static final List<String> NARC_MUNITION_NAMES

BOMB_MUNITION_NAMES

public static final List<String> BOMB_MUNITION_NAMES

Constructor Details

MunitionTree

public MunitionTree()

MunitionTree

public MunitionTree(MunitionTree mt)

MunitionTree

public MunitionTree(String fName)
             throws IllegalArgumentException

Constructor for reading in files containing load out imperatives.

Parameters:

fName - file name

Throws:

IllegalArgumentException

Method Details

readFromADF

public void readFromADF(BufferedReader br)
                 throws IOException

Throws:

IOException

writeToADFFilename

public void writeToADFFilename(String fName)

writeToADFFormat

public void writeToADFFormat(BufferedWriter bw)
                      throws IOException

Throws:

IOException

loadEntityList

public void loadEntityList(List<Entity> el)

Convert List of Entities into a set of specific imperatives for each unit. Used for backing up original load out.

Parameters:

el - Entity list

insertImperative

public void insertImperative(String chassis,
 String variant,
 String pilot,
 String binType,
 String... ammoTypes)
                      throws IllegalArgumentException

Throws:

IllegalArgumentException

insertImperatives

public void insertImperatives(String chassis,
 String variant,
 String pilot,
 HashMap<String,String> imperatives)

insertMangledImperatives

@Deprecated(since="0.51.0",
            forRemoval=true)
public void insertMangledImperatives(String chassis,
 String variant,
 String pilot,
 HashMap<String,String> imperatives)

Deprecated, for removal: This API element is subject to removal in a future version.

getCountsOfAmmunitionForKey

public HashMap<String,Integer> getCountsOfAmmunitionForKey(String chassis,
 String variant,
 String pilot,
 String binType)

getPriorityList

public List<String> getPriorityList(String chassis,
 String variant,
 String pilot,
 String binType)

getEffectiveImperative

@Deprecated(since="0.51.0",
            forRemoval=true)
public String getEffectiveImperative(String chassis,
 String variant,
 String pilot,
 String binType)

Deprecated, for removal: This API element is subject to removal in a future version.

Returns:

entire imperative string that would act on the provided key set

getCountOfAmmoForKey

public int getCountOfAmmoForKey(String chassis,
 String variant,
 String pilot,
 String binType,
 String ammoType)

Return the actual, or effective, desired count of ammo bins for the given binType and ammoType

Returns:

int count of bins requested for this binType:ammoType set.