ABE::FMUnit Class Reference

The FMUnit represents a management unit, i.e. More...

#include <fmunit.h>

Public Member Functions
	FMUnit (const Agent *agent)
	~FMUnit ()
void	setId (const QString &id)
const QString &	id () const
Scheduler *	scheduler ()
const Scheduler *	constScheduler () const
const Agent *	agent () const
double	area () const
	total area of the unit (ha) More...
int	numberOfStands () const
	the total number of stands More...
void	setNumberOfStands (int new_number)
	set the number of stands More...
double	volume () const
	total volume of the unit (m3/ha) More...
double	annualIncrement () const
	mean annual increment (m3/ha) More...
void	resetHarvestCounter ()
double	U () const
	rotation period (years) More...
int	thinningIntensity () const
	thinning intensity (class); 1: low, 2: medium, 3: high More...
int	targetSpeciesIndex () const
	species composition key More...
const QString &	harvestMode () const
void	setU (const double rotation_length)
void	setThinningIntensity (const int th_class)
void	setTargetSpeciesCompositionIndex (const int index)
void	setHarvestMode (const QString new_mode)
void	setAverageMAI (const double avg_mai)
double	averageMAI () const
void	managementPlanUpdate ()
	update decadal management objectives for the planning unit. More...
void	setForceUpdateManagementPlan ()
	tell the unit to update management plan next year More...
bool	forceUpdateManagementPlan () const
void	runAgent ()
	run the agent main function More...
void	updatePlanOfCurrentYear ()
	update objectives of the current year. More...
void	addRealizedHarvest (const double harvest_m3)
	record realized harvests on the unit (all harvests) More...
void	aggregate ()
QStringList	info () const

Friends
class	UnitOut

Detailed Description

The FMUnit represents a management unit, i.e.

The FMUnit class encapsulates a forest management unit, comprised of forest stands.

a collection of stands.

Units are the base level at which the scheduling works.

Constructor & Destructor Documentation

FMUnit()

ABE::FMUnit::FMUnit

(

const Agent *

agent

)

~FMUnit()

ABE::FMUnit::~FMUnit

(

)

Member Function Documentation

addRealizedHarvest()

void ABE::FMUnit::addRealizedHarvest ( const double  harvest_m3 )

inline

record realized harvests on the unit (all harvests)

agent()

const Agent * ABE::FMUnit::agent ( ) const

inline

aggregate()

void ABE::FMUnit::aggregate

(

)

annualIncrement()

double ABE::FMUnit::annualIncrement ( ) const

inline

mean annual increment (m3/ha)

area()

double ABE::FMUnit::area ( ) const

inline

total area of the unit (ha)

averageMAI()

double ABE::FMUnit::averageMAI ( ) const

inline

constScheduler()

const Scheduler * ABE::FMUnit::constScheduler ( ) const

inline

forceUpdateManagementPlan()

bool ABE::FMUnit::forceUpdateManagementPlan ( ) const

inline

harvestMode()

const QString & ABE::FMUnit::harvestMode ( ) const

inline

id()

const QString & ABE::FMUnit::id ( ) const

inline

info()

QStringList ABE::FMUnit::info

(

)

const

managementPlanUpdate()

void ABE::FMUnit::managementPlanUpdate

(

)

update decadal management objectives for the planning unit.

numberOfStands()

int ABE::FMUnit::numberOfStands ( ) const

inline

the total number of stands

resetHarvestCounter()

void ABE::FMUnit::resetHarvestCounter

(

)

runAgent()

void ABE::FMUnit::runAgent

(

)

run the agent main function

scheduler()

Scheduler * ABE::FMUnit::scheduler ( )

inline

setAverageMAI()

void ABE::FMUnit::setAverageMAI ( const double  avg_mai )

inline

setForceUpdateManagementPlan()

void ABE::FMUnit::setForceUpdateManagementPlan ( )

inline

tell the unit to update management plan next year

setHarvestMode()

void ABE::FMUnit::setHarvestMode ( const QString  new_mode )

inline

setId()

void ABE::FMUnit::setId

(

const QString &

id

)

setNumberOfStands()

void ABE::FMUnit::setNumberOfStands ( int  new_number )

inline

set the number of stands

setTargetSpeciesCompositionIndex()

void ABE::FMUnit::setTargetSpeciesCompositionIndex ( const int  index )

inline

setThinningIntensity()

void ABE::FMUnit::setThinningIntensity ( const int  th_class )

inline

setU()

void ABE::FMUnit::setU ( const double  rotation_length )

inline

targetSpeciesIndex()

int ABE::FMUnit::targetSpeciesIndex ( ) const

inline

species composition key

thinningIntensity()

int ABE::FMUnit::thinningIntensity ( ) const

inline

thinning intensity (class); 1: low, 2: medium, 3: high

U()

double ABE::FMUnit::U ( ) const

inline

rotation period (years)

updatePlanOfCurrentYear()

void ABE::FMUnit::updatePlanOfCurrentYear

(

)

update objectives of the current year.

volume()

double ABE::FMUnit::volume ( ) const

inline

total volume of the unit (m3/ha)

Friends And Related Function Documentation

UnitOut

friend class UnitOut

friend

---

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

• C:/dev/iland/src/abe/fmunit.h
• C:/dev/iland/src/abe/fmunit.cpp