iLand
Public Member Functions | Properties | List of all members
ABE::ActivityObj Class Reference

The ActivityObj class encapsulates the 'activity' object in JS. More...

#include <fomescript.h>

Inheritance diagram for ABE::ActivityObj:

Public Member Functions

 ActivityObj (QObject *parent=0)
 
 ActivityObj (FMStand *stand, Activity *act, int index)
 
void setStand (FMStand *stand)
 default-case: set a forest stand as the context. More...
 
void setActivity (Activity *act)
 set an activity context (without a stand) to access base properties of activities More...
 
void setActivityIndex (const int index)
 set an activity that is not the current activity of the stand More...
 
QString name () const
 
bool enabled () const
 
void setEnabled (bool do_enable)
 
bool active () const
 
void setActive (bool activate)
 
bool finalHarvest () const
 
void setFinalHarvest (bool isfinal)
 
bool scheduled () const
 
void setScheduled (bool issched)
 

Properties

bool enabled
 
bool active
 
bool finalHarvest
 
bool scheduled
 
QString name
 

Detailed Description

The ActivityObj class encapsulates the 'activity' object in JS.

The 'activity' can be used to fine-tune the management activities (e.g., set the enable/disable flags).

Constructor & Destructor Documentation

◆ ActivityObj() [1/2]

ABE::ActivityObj::ActivityObj ( QObject *  parent = 0)
inlineexplicit

◆ ActivityObj() [2/2]

ABE::ActivityObj::ActivityObj ( FMStand stand,
Activity act,
int  index 
)
inline

Member Function Documentation

◆ active()

bool ABE::ActivityObj::active ( ) const
inline

◆ enabled()

bool ABE::ActivityObj::enabled ( ) const

◆ finalHarvest()

bool ABE::ActivityObj::finalHarvest ( ) const
inline

◆ name()

QString ABE::ActivityObj::name ( ) const

◆ scheduled()

bool ABE::ActivityObj::scheduled ( ) const
inline

◆ setActive()

void ABE::ActivityObj::setActive ( bool  activate)
inline

◆ setActivity()

void ABE::ActivityObj::setActivity ( Activity act)
inline

set an activity context (without a stand) to access base properties of activities

◆ setActivityIndex()

void ABE::ActivityObj::setActivityIndex ( const int  index)
inline

set an activity that is not the current activity of the stand

◆ setEnabled()

void ABE::ActivityObj::setEnabled ( bool  do_enable)

◆ setFinalHarvest()

void ABE::ActivityObj::setFinalHarvest ( bool  isfinal)
inline

◆ setScheduled()

void ABE::ActivityObj::setScheduled ( bool  issched)
inline

◆ setStand()

void ABE::ActivityObj::setStand ( FMStand stand)
inline

default-case: set a forest stand as the context.

Property Documentation

◆ active

bool ABE::ActivityObj::active
readwrite

◆ enabled

bool ABE::ActivityObj::enabled
readwrite

◆ finalHarvest

bool ABE::ActivityObj::finalHarvest
readwrite

◆ name

QString ABE::ActivityObj::name
read

◆ scheduled

bool ABE::ActivityObj::scheduled
readwrite

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