FMT 1.2.0
Forest management tools for forest planning
Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
Core::FMTLifespans Class Reference

List holding the maximum age of aggregates of developments. More...

#include <FMTLifespans.h>

Inheritance diagram for Core::FMTLifespans:
[legend]
Collaboration diagram for Core::FMTLifespans:
[legend]

Public Member Functions

void swap (FMTLifespans &rhs)
 Swap this FMTLifespans with another.
 
 FMTLifespans ()
 Default constructor for FMTLifespans.
 
 ~FMTLifespans ()=default
 Default destructor for FMTLifespans.
 
 FMTLifespans (const FMTLifespans &rhs)
 Copy constructor for FMTLifespans.
 
FMTLifespansoperator= (const FMTLifespans &rhs)
 Copy assignment operator for FMTLifespans.
 
bool operator== (const FMTLifespans &rhs) const
 Equality comparison operator of FMTLifespans.
 
bool operator!= (const FMTLifespans &rhs) const
 Inequality comparison operator of FMTLifespans.
 
 operator std::string () const
 Return a string representation of the FMTLifespans section (.lif).
 
void update () override
 Override the FMTList update function, to be called after any change to the list.
 
FMTLifespans preSolve (const FMTMaskFilter &filter, const std::vector< FMTTheme > &originalthemes, std::vector< FMTTheme > &newthemes, bool compressdata=false) const
 Presolve the lifespans by eliminating list elements and presolving the masks.
 

Friends

class boost::serialization::access
 Serialize the FMTLifespans through its base FMTList<int> for multiprocessing across multiple cpus (pickle in Python).
 

Detailed Description

List holding the maximum age of aggregates of developments.

Derived from FMTList<int>, each element is a maximum age for a FMTMask. Used by the parser and to generate the default _DEATH action and transition.

Constructor & Destructor Documentation

◆ FMTLifespans() [1/2]

Core::FMTLifespans::FMTLifespans ( )

Default constructor for FMTLifespans.

◆ ~FMTLifespans()

Core::FMTLifespans::~FMTLifespans ( )
default

Default destructor for FMTLifespans.

◆ FMTLifespans() [2/2]

Core::FMTLifespans::FMTLifespans ( const FMTLifespans rhs)

Copy constructor for FMTLifespans.

Parameters
[in]rhsthe FMTLifespans to copy.

Member Function Documentation

◆ operator std::string()

Core::FMTLifespans::operator std::string ( ) const

Return a string representation of the FMTLifespans section (.lif).

Returns
the string representation of the FMTLifespans.

◆ operator!=()

bool Core::FMTLifespans::operator!= ( const FMTLifespans rhs) const

Inequality comparison operator of FMTLifespans.

Parameters
[in]rhsthe FMTLifespans to compare with.
Returns
true if both are different else false.

◆ operator=()

FMTLifespans & Core::FMTLifespans::operator= ( const FMTLifespans rhs)

Copy assignment operator for FMTLifespans.

Parameters
[in]rhsthe FMTLifespans to copy.
Returns
a reference to this FMTLifespans.

◆ operator==()

bool Core::FMTLifespans::operator== ( const FMTLifespans rhs) const

Equality comparison operator of FMTLifespans.

Parameters
[in]rhsthe FMTLifespans to compare with.
Returns
true if both are equal else false.

◆ preSolve()

FMTLifespans Core::FMTLifespans::preSolve ( const FMTMaskFilter filter,
const std::vector< FMTTheme > &  originalthemes,
std::vector< FMTTheme > &  newthemes,
bool  compressdata = false 
) const

Presolve the lifespans by eliminating list elements and presolving the masks.

Parameters
[in]filterthe mask filter.
[in]originalthemesthe original themes.
[in,out]newthemesthe presolved themes.
[in]compressdataif true compresses the data.
Returns
the presolved FMTLifespans.

◆ swap()

void Core::FMTLifespans::swap ( FMTLifespans rhs)

Swap this FMTLifespans with another.

Parameters
[in,out]rhsthe FMTLifespans to swap with.

◆ update()

void Core::FMTLifespans::update ( )
override

Override the FMTList update function, to be called after any change to the list.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

Serialize the FMTLifespans through its base FMTList<int> for multiprocessing across multiple cpus (pickle in Python).

Template Parameters
Archivethe archive type.
Parameters
[in,out]arthe archive to serialize to or from.
[in]versionthe serialization version.

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