SVDStates Class Reference

#include <svdstate.h>

Public Types
enum	EStructureClassification { Structure4m , Structure2m }
enum	EFunctioningClassification { Functioning3Classes , Functioning5Classes }

Public Member Functions
	SVDStates ()
int	evaluateState (ResourceUnit *ru)
	calculate and returns the Id ofthe state that the resource unit is currently in More...
const SVDState &	state (int index) const
	access the state with the id 'index' More...
bool	isStateValid (int state) const
	return true if 'state' is a valid state Id More...
int	count () const
	return the number of states More...
void	evaluateNeighborhood (ResourceUnit *ru)
	evaluate the species composition in the neighborhood of the cell this is executed in parallel. More...
QString	compositionString (int index)
	get a string with the main species on the resource unit dominant species is uppercase, all other lowercase More...
QString	stateLabel (int index)
	create a human readable string representation of the string More...

Member Enumeration Documentation

EFunctioningClassification

enum SVDStates::EFunctioningClassification

Enumerator
Functioning3Classes
Functioning5Classes

EStructureClassification

enum SVDStates::EStructureClassification

Enumerator
Structure4m
Structure2m

Constructor & Destructor Documentation

SVDStates()

SVDStates::SVDStates

(

)

Member Function Documentation

compositionString()

QString SVDStates::compositionString ( int  index )

inline

get a string with the main species on the resource unit dominant species is uppercase, all other lowercase

count()

int SVDStates::count ( ) const

inline

return the number of states

evaluateNeighborhood()

void SVDStates::evaluateNeighborhood

(

ResourceUnit *

ru

)

evaluate the species composition in the neighborhood of the cell this is executed in parallel.

evaluateState()

int SVDStates::evaluateState

(

ResourceUnit *

ru

)

calculate and returns the Id ofthe state that the resource unit is currently in

isStateValid()

bool SVDStates::isStateValid ( int  state ) const

inline

return true if 'state' is a valid state Id

state()

const SVDState & SVDStates::state ( int  index ) const

inline

access the state with the id 'index'

stateLabel()

QString SVDStates::stateLabel

(

int

index

)

create a human readable string representation of the string

---

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

• C:/dev/iland/src/core/svdstate.h
• C:/dev/iland/src/core/svdstate.cpp