Core::FMTGCBMTransition Class Reference

Simple container for a GCBM transition, only useful when working with GCBM. More...

#include <FMTGCBMTransition.h>

Collaboration diagram for Core::FMTGCBMTransition:

Public Member Functions
	FMTGCBMTransition ()
	Default constructor for FMTGCBMTransition.
	FMTGCBMTransition (const int &lageafter, const std::map< std::string, std::string > &lthemes, const std::string &lname)
	Construct a GCBM transition from the age after, the themes and the name.
	FMTGCBMTransition (const FMTGCBMTransition &rhs)
	Copy constructor for FMTGCBMTransition.
FMTGCBMTransition &	operator= (const FMTGCBMTransition &rhs)
	Copy assignment operator for FMTGCBMTransition.
bool	operator== (const FMTGCBMTransition &rhs) const
	Equality comparison operator of FMTGCBMTransition.
bool	operator!= (const FMTGCBMTransition &rhs) const
	Inequality comparison operator of FMTGCBMTransition.
	~FMTGCBMTransition ()=default
	Default destructor for FMTGCBMTransition.

Public Attributes
int	ageafter
	Describe the age set on the strata after the disturbance.
std::map< std::string, std::string >	themes
	Map where's the key is the theme name and the element is the new attribute set after the transition.
std::string	name
	The name of the GCBM transition.

Friends
class	boost::serialization::access
	Serialize the FMTGCBMTransition for multiprocessing across multiple cpus (pickle in Python).

Detailed Description

Simple container for a GCBM transition, only useful when working with GCBM.

Constructor & Destructor Documentation

FMTGCBMTransition() [1/3]

Core::FMTGCBMTransition::FMTGCBMTransition

(

)

Default constructor for FMTGCBMTransition.

FMTGCBMTransition() [2/3]

Core::FMTGCBMTransition::FMTGCBMTransition	(	const int &	lageafter,
		const std::map< std::string, std::string > &	lthemes,
		const std::string &	lname
	)

Construct a GCBM transition from the age after, the themes and the name.

Parameters

[in]	lageafter	the age set on the strata after the disturbance.
[in]	lthemes	the map of theme name to new attribute.
[in]	lname	the name of the transition.

FMTGCBMTransition() [3/3]

Core::FMTGCBMTransition::FMTGCBMTransition

(

const FMTGCBMTransition &

rhs

)

Copy constructor for FMTGCBMTransition.

Parameters

[in]

rhs

the FMTGCBMTransition to copy.

~FMTGCBMTransition()

Core::FMTGCBMTransition::~FMTGCBMTransition ( )

default

Default destructor for FMTGCBMTransition.

Member Function Documentation

operator!=()

bool Core::FMTGCBMTransition::operator!=

(

const FMTGCBMTransition &

rhs

)

const

Inequality comparison operator of FMTGCBMTransition.

Parameters

[in]

rhs

the transition to compare with.

Returns

true if both transitions are different else false.

operator=()

FMTGCBMTransition & Core::FMTGCBMTransition::operator=

(

const FMTGCBMTransition &

rhs

)

Copy assignment operator for FMTGCBMTransition.

Parameters

[in]

rhs

the FMTGCBMTransition to copy.

Returns

a reference to this FMTGCBMTransition.

operator==()

bool Core::FMTGCBMTransition::operator==

(

const FMTGCBMTransition &

rhs

)

const

Equality comparison operator of FMTGCBMTransition.

Parameters

[in]

rhs

the transition to compare with.

Returns

true if both transitions are equal else false.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Serialize the FMTGCBMTransition for multiprocessing across multiple cpus (pickle in Python).

Template Parameters

Archive

the archive type.

Parameters

[in,out]	ar	the archive to serialize to or from.
[in]	version	the serialization version.

Member Data Documentation

ageafter

int Core::FMTGCBMTransition::ageafter

Describe the age set on the strata after the disturbance.

name

std::string Core::FMTGCBMTransition::name

The name of the GCBM transition.

themes

std::map<std::string, std::string> Core::FMTGCBMTransition::themes

Map where's the key is the theme name and the element is the new attribute set after the transition.

---

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

• D:/FMT/Include/FMTGCBMTransition.h