Core::FMTDevelopmentPath Class Reference

Development path holding a generated development and the proportion of area going to it. More...

#include <FMTDevelopmentPath.h>

Public Member Functions
	FMTDevelopmentPath ()
	Default constructor for FMTDevelopmentPath.
FMTDevelopmentPath &	operator= (const FMTDevelopmentPath &rhs)=default
	Copy assignment operator for FMTDevelopmentPath.
	FMTDevelopmentPath (const FMTDevelopmentPath &rhs)=default
	Copy constructor for FMTDevelopmentPath.
	~FMTDevelopmentPath ()=default
	Default destructor for FMTDevelopmentPath.
const FMTDevelopment &	getDevelopment () const
	Get the new development.
FMTDevelopment &	getDevelopmentReference ()
	Get the new development.
double	getProportion () const
	Get the proportion of area going to this dev.
void	setProportion (double p_proportion)
	Set the proportion of area going to this development.
	FMTDevelopmentPath (const FMTMask &p_mask, int p_age, int p_lock, int p_period, double p_proportion)
	Construct a development path from a mask, an age, a lock, a period and a proportion.

Detailed Description

Development path holding a generated development and the proportion of area going to it.

Constructor & Destructor Documentation

FMTDevelopmentPath() [1/3]

Core::FMTDevelopmentPath::FMTDevelopmentPath

(

)

Default constructor for FMTDevelopmentPath.

FMTDevelopmentPath() [2/3]

Core::FMTDevelopmentPath::FMTDevelopmentPath ( const FMTDevelopmentPath &  rhs )

default

Copy constructor for FMTDevelopmentPath.

Parameters

[in]

rhs

the FMTDevelopmentPath to copy.

~FMTDevelopmentPath()

Core::FMTDevelopmentPath::~FMTDevelopmentPath ( )

default

Default destructor for FMTDevelopmentPath.

FMTDevelopmentPath() [3/3]

Core::FMTDevelopmentPath::FMTDevelopmentPath	(	const FMTMask &	p_mask,
		int	p_age,
		int	p_lock,
		int	p_period,
		double	p_proportion
	)

Construct a development path from a mask, an age, a lock, a period and a proportion.

Parameters

[in]	p_mask	the mask.
[in]	p_age	the age.
[in]	p_lock	the lock.
[in]	p_period	the period.
[in]	p_proportion	the proportion of area going to this development.

Member Function Documentation

getDevelopment()

const FMTDevelopment & Core::FMTDevelopmentPath::getDevelopment

(

)

const

Get the new development.

Returns

a newly generated development

getDevelopmentReference()

FMTDevelopment & Core::FMTDevelopmentPath::getDevelopmentReference

(

)

Get the new development.

Returns

a newly generated development

getProportion()

double Core::FMTDevelopmentPath::getProportion

(

)

const

Get the proportion of area going to this dev.

Returns

the proportion

operator=()

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

default

Copy assignment operator for FMTDevelopmentPath.

Parameters

[in]

rhs

the FMTDevelopmentPath to copy.

Returns

a reference to this FMTDevelopmentPath.

setProportion()

void Core::FMTDevelopmentPath::setProportion

(

double

p_proportion

)

Set the proportion of area going to this development.

Parameters

[in]

p_proportion

the proportion to set.

---

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

• D:/FMT/Include/FMTDevelopmentPath.h