Spatial::FMTBindingSpatialAction Class Reference

Spatial binding of an action, holding the green up, adjacency, size and neighbors constraints used to test spatial operability. More...

#include <FMTBindingSpatialAction.h>

Public Member Functions
	FMTBindingSpatialAction ()=default
	Default constructor for FMTBindingSpatialAction.
	FMTBindingSpatialAction (const FMTBindingSpatialAction &rhs)=default
	Copy constructor for FMTBindingSpatialAction.
FMTBindingSpatialAction &	operator= (const FMTBindingSpatialAction &rhs)=default
	Copy assignment operator for FMTBindingSpatialAction.
	FMTBindingSpatialAction (const std::vector< int > &lneighbors, const size_t &mingreenup, const size_t &maxgreenup, const size_t &minadjacency, const size_t &maxadjacency, const size_t &minsize, const size_t &maxsize, const size_t &minnsize, const size_t &maxnsize)
	Construct a FMTBindingSpatialAction from its neighbors and its green up, adjacency, size and neighbor size bounds.
bool	isSpatiallyBinding () const
	Return true if the action is spatially binding.
bool	isSpatiallyAreaBinding () const
	Return true if the action is spatially binding on the area (size).
bool	isSpatiallyAdjacencyBinding () const
	Return true if the action is spatially binding on the adjacency.
bool	testMinimalAdjacency () const
	Return true if a minimal adjacency is set.
bool	testMaximalAdjacency () const
	Return true if a maximal adjacency is set.
const std::vector< int > &	getNeighbors () const
	Return the neighbors of the action.
const size_t &	getMinimalGreenUp () const
	Return the minimal green up.
const size_t &	getMaximalGreenUp () const
	Return the maximal green up.
const size_t &	getMinimalAdjacency () const
	Return the minimal adjacency.
const size_t &	getMaximalAdjacency () const
	Return the maximal adjacency.
const size_t &	getMinimalSize () const
	Return the minimal size.
const size_t &	getMaximalSize () const
	Return the maximal size.
const size_t &	getMinimalNeighborSize () const
	Return the minimal neighbors size.
const size_t &	getMaximalNeighborSize () const
	Return the maximal neighbors size.

Detailed Description

Spatial binding of an action, holding the green up, adjacency, size and neighbors constraints used to test spatial operability.

Constructor & Destructor Documentation

FMTBindingSpatialAction() [1/3]

Spatial::FMTBindingSpatialAction::FMTBindingSpatialAction ( )

default

Default constructor for FMTBindingSpatialAction.

FMTBindingSpatialAction() [2/3]

Spatial::FMTBindingSpatialAction::FMTBindingSpatialAction ( const FMTBindingSpatialAction &  rhs )

default

Copy constructor for FMTBindingSpatialAction.

Parameters

[in]

rhs

the FMTBindingSpatialAction to copy.

FMTBindingSpatialAction() [3/3]

Spatial::FMTBindingSpatialAction::FMTBindingSpatialAction	(	const std::vector< int > &	lneighbors,
		const size_t &	mingreenup,
		const size_t &	maxgreenup,
		const size_t &	minadjacency,
		const size_t &	maxadjacency,
		const size_t &	minsize,
		const size_t &	maxsize,
		const size_t &	minnsize,
		const size_t &	maxnsize
	)

Construct a FMTBindingSpatialAction from its neighbors and its green up, adjacency, size and neighbor size bounds.

Parameters

[in]	lneighbors	the neighbors.
[in]	mingreenup	the minimal green up.
[in]	maxgreenup	the maximal green up.
[in]	minadjacency	the minimal adjacency.
[in]	maxadjacency	the maximal adjacency.
[in]	minsize	the minimal size.
[in]	maxsize	the maximal size.
[in]	minnsize	the minimal neighbors size.
[in]	maxnsize	the maximal neighbors size.

Member Function Documentation

getMaximalAdjacency()

const size_t & Spatial::FMTBindingSpatialAction::getMaximalAdjacency ( ) const

inline

Return the maximal adjacency.

Returns

the maximal adjacency.

getMaximalGreenUp()

const size_t & Spatial::FMTBindingSpatialAction::getMaximalGreenUp ( ) const

inline

Return the maximal green up.

Returns

the maximal green up.

getMaximalNeighborSize()

const size_t & Spatial::FMTBindingSpatialAction::getMaximalNeighborSize ( ) const

inline

Return the maximal neighbors size.

Returns

the maximal neighbors size.

getMaximalSize()

const size_t & Spatial::FMTBindingSpatialAction::getMaximalSize ( ) const

inline

Return the maximal size.

Returns

the maximal size.

getMinimalAdjacency()

const size_t & Spatial::FMTBindingSpatialAction::getMinimalAdjacency ( ) const

inline

Return the minimal adjacency.

Returns

the minimal adjacency.

getMinimalGreenUp()

const size_t & Spatial::FMTBindingSpatialAction::getMinimalGreenUp ( ) const

inline

Return the minimal green up.

Returns

the minimal green up.

getMinimalNeighborSize()

const size_t & Spatial::FMTBindingSpatialAction::getMinimalNeighborSize ( ) const

inline

Return the minimal neighbors size.

Returns

the minimal neighbors size.

getMinimalSize()

const size_t & Spatial::FMTBindingSpatialAction::getMinimalSize ( ) const

inline

Return the minimal size.

Returns

the minimal size.

getNeighbors()

const std::vector< int > & Spatial::FMTBindingSpatialAction::getNeighbors ( ) const

inline

Return the neighbors of the action.

Returns

the neighbors.

isSpatiallyAdjacencyBinding()

bool Spatial::FMTBindingSpatialAction::isSpatiallyAdjacencyBinding

(

)

const

Return true if the action is spatially binding on the adjacency.

Returns

true if the action is adjacency binding else false.

isSpatiallyAreaBinding()

bool Spatial::FMTBindingSpatialAction::isSpatiallyAreaBinding

(

)

const

Return true if the action is spatially binding on the area (size).

Returns

true if the action is area binding else false.

isSpatiallyBinding()

bool Spatial::FMTBindingSpatialAction::isSpatiallyBinding

(

)

const

Return true if the action is spatially binding.

Returns

true if the action is spatially binding else false.

operator=()

FMTBindingSpatialAction & Spatial::FMTBindingSpatialAction::operator= ( const FMTBindingSpatialAction &  rhs )

default

Copy assignment operator for FMTBindingSpatialAction.

Parameters

[in]

rhs

the FMTBindingSpatialAction to copy.

Returns

a reference to this FMTBindingSpatialAction.

testMaximalAdjacency()

bool Spatial::FMTBindingSpatialAction::testMaximalAdjacency

(

)

const

Return true if a maximal adjacency is set.

Returns

true if a maximal adjacency is set else false.

testMinimalAdjacency()

bool Spatial::FMTBindingSpatialAction::testMinimalAdjacency

(

)

const

Return true if a minimal adjacency is set.

Returns

true if a minimal adjacency is set else false.

---

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

• D:/FMT/Include/FMTBindingSpatialAction.h