sortie.data.funcgroups.nci.NCIEffect Class Reference

This class provides a class for NCI effects with organizing information. More...

Classes
enum	crowding_effect
	Flag values for which crowding effect term is desired. More...
enum	damage_effect
	Flag values for which damage effect term is desired. More...
enum	effectType
	Identifier for different types of effects. More...
enum	infection_effect
	Flag values for which infection effect term is desired. More...
enum	nci_term
	Flag values for which NCI term is desired. More...
enum	nitrogen_effect
	Flag values for which nitrogen effect term is desired. More...
enum	precipitation_effect
	Flag values for which precipitation effect term is desired. More...
enum	shading_effect
	Flag values for which shading effect term is desired. More...
enum	size_effect
	Flag values for which size effect term is desired. More...
enum	temperature_effect
	Flag values for which temperature effect term is desired. More...

Public Member Functions
	NCIEffect (Class<? extends Behavior > oClass, String sDescriptor, int iEffectNum)
	Constructor. More...
	NCIEffect (Class<? extends Behavior > oClass, String sDescriptor, int iEffectNum, boolean bRequiresDiameter)
	Constructor. More...
boolean	requiresDiameter ()
String	getDescriptor ()
int	getEffectNum ()
Behavior	createBehavior (GUIManager oManager, BehaviorTypeBase oParent) throws ModelException
	Creates an instance of this behavior's class. More...

Private Attributes
boolean	m_bRequiresDiameter = false
	Whether this behavior requires a target diameter to function. More...
Class<? extends Behavior >	m_oClass
	Behavior class. More...
String	m_sDescriptor
	This is what will be displayed as the name of a given behavior in the GUI. More...
int	m_iEffectNum
	Corresponds to an effect enum. More...

Detailed Description

This class provides a class for NCI effects with organizing information.

Author

LORA

Constructor & Destructor Documentation

NCIEffect() [1/2]

sortie.data.funcgroups.nci.NCIEffect.NCIEffect	(	Class<? extends Behavior >	oClass,
		String	sDescriptor,
		int	iEffectNum
	)

Constructor.

Parameters

oClass	Behavior class.
sDescriptor	The name of the behavior for the user.
iEffectNum	Enum value of the effect.

NCIEffect() [2/2]

sortie.data.funcgroups.nci.NCIEffect.NCIEffect	(	Class<? extends Behavior >	oClass,
		String	sDescriptor,
		int	iEffectNum,
		boolean	bRequiresDiameter
	)

Constructor.

Parameters

oClass	Behavior class.
sDescriptor	The name of the behavior for the user.
iEffectNum	The number of the effect being assigned.
bRequiresDiameter	Whether this effect requires a target diameter to function.

Member Function Documentation

createBehavior()

Behavior sortie.data.funcgroups.nci.NCIEffect.createBehavior	(	GUIManager	oManager,
		BehaviorTypeBase	oParent
	)		throws ModelException

Creates an instance of this behavior's class.

Parameters

oManager	GUI Manager.
oParent	Managing behavior group object.

Returns

New behavior object.

Exceptions

ModelException

If there is a problem with the instantiation.

getDescriptor()

String sortie.data.funcgroups.nci.NCIEffect.getDescriptor

(

)

getEffectNum()

int sortie.data.funcgroups.nci.NCIEffect.getEffectNum

(

)

requiresDiameter()

boolean sortie.data.funcgroups.nci.NCIEffect.requiresDiameter

(

)

Returns

the bRequiresDiameter

Member Data Documentation

m_bRequiresDiameter

boolean sortie.data.funcgroups.nci.NCIEffect.m_bRequiresDiameter = false

private

Whether this behavior requires a target diameter to function.

m_iEffectNum

int sortie.data.funcgroups.nci.NCIEffect.m_iEffectNum

private

Corresponds to an effect enum.

This is what goes in the parameter file.

m_oClass

Class<? extends Behavior> sortie.data.funcgroups.nci.NCIEffect.m_oClass

private

Behavior class.

m_sDescriptor

String sortie.data.funcgroups.nci.NCIEffect.m_sDescriptor

private

This is what will be displayed as the name of a given behavior in the GUI.

Shouldn't be too long - max 5 words or so

---

The documentation for this class was generated from the following file:

• NCIEffect.java