Graph::FMTBaseVertexProperties Class Reference

#include <FMTBaseVertexProperties.h>

Inheritance diagram for Graph::FMTBaseVertexProperties:

Public Member Functions
virtual	~FMTBaseVertexProperties ()=default
	Default virtual destructor for FMTBaseVertexProperties.
	FMTBaseVertexProperties ()=default
	Default constructor for FMTBaseVertexProperties.
	FMTBaseVertexProperties (const FMTBaseVertexProperties &rhs)
	Copy constructor for FMTBaseVertexProperties.
FMTBaseVertexProperties &	operator= (const FMTBaseVertexProperties &rhs)
	Copy assignment operator for FMTBaseVertexProperties.
	FMTBaseVertexProperties (const Core::FMTFuturDevelopment &p_development)
	Construct a FMTBaseVertexProperties from a futur development.
	FMTBaseVertexProperties (const Core::FMTActualDevelopment &p_development)
	Construct a FMTBaseVertexProperties from an actual development.
void	setDevlopementMask (const Core::FMTMask &p_newMask)
	Set the development mask of the vertex.
double	getBaseRhs () const
	Get the right hand side of the constraint of the vertex.
virtual int	getConstraintId () const
	Get the index of the constraint of the vertex.
const Core::FMTDevelopment &	get () const
	Get a const reference to the development of the vertex.
size_t	hash () const
	Hash the development of the vertex.
bool	operator< (const FMTBaseVertexProperties &rhs) const
	Less than operator for FMTBaseVertexProperties.
bool	operator== (const FMTBaseVertexProperties &rhs) const
	Comparison operator for FMTBaseVertexProperties.
bool	operator!= (const FMTBaseVertexProperties &rhs) const
	Comparison operator for FMTBaseVertexProperties.

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

Constructor & Destructor Documentation

~FMTBaseVertexProperties()

virtual Graph::FMTBaseVertexProperties::~FMTBaseVertexProperties ( )

virtualdefault

Default virtual destructor for FMTBaseVertexProperties.

FMTBaseVertexProperties() [1/4]

Graph::FMTBaseVertexProperties::FMTBaseVertexProperties ( )

default

Default constructor for FMTBaseVertexProperties.

FMTBaseVertexProperties() [2/4]

Graph::FMTBaseVertexProperties::FMTBaseVertexProperties

(

const FMTBaseVertexProperties &

rhs

)

Copy constructor for FMTBaseVertexProperties.

Parameters

[in]

rhs

the FMTBaseVertexProperties to copy.

FMTBaseVertexProperties() [3/4]

Graph::FMTBaseVertexProperties::FMTBaseVertexProperties

(

const Core::FMTFuturDevelopment &

p_development

)

Construct a FMTBaseVertexProperties from a futur development.

Parameters

[in]

p_development

the futur development.

FMTBaseVertexProperties() [4/4]

Graph::FMTBaseVertexProperties::FMTBaseVertexProperties

(

const Core::FMTActualDevelopment &

p_development

)

Construct a FMTBaseVertexProperties from an actual development.

Parameters

[in]

p_development

the actual development.

Member Function Documentation

get()

const Core::FMTDevelopment & Graph::FMTBaseVertexProperties::get

(

)

const

Get a const reference to the development of the vertex.

Returns

the development.

getBaseRhs()

double Graph::FMTBaseVertexProperties::getBaseRhs

(

)

const

Get the right hand side of the constraint of the vertex.

Returns

the right hand side value.

getConstraintId()

virtual int Graph::FMTBaseVertexProperties::getConstraintId ( ) const

virtual

Get the index of the constraint of the vertex.

Returns

the constraint index.

Reimplemented in Graph::FMTVertexProperties.

hash()

size_t Graph::FMTBaseVertexProperties::hash

(

)

const

Hash the development of the vertex.

Returns

the hash of the vertex.

operator!=()

bool Graph::FMTBaseVertexProperties::operator!=

(

const FMTBaseVertexProperties &

rhs

)

const

Comparison operator for FMTBaseVertexProperties.

Parameters

[in]

rhs

the FMTBaseVertexProperties to compare to.

Returns

true if both vertex properties are different else false.

operator<()

bool Graph::FMTBaseVertexProperties::operator<

(

const FMTBaseVertexProperties &

rhs

)

const

Less than operator for FMTBaseVertexProperties.

Parameters

[in]

rhs

the FMTBaseVertexProperties to compare to.

Returns

true if this vertex properties is less than the other else false.

operator=()

FMTBaseVertexProperties & Graph::FMTBaseVertexProperties::operator=

(

const FMTBaseVertexProperties &

rhs

)

Copy assignment operator for FMTBaseVertexProperties.

Parameters

[in]

rhs

the FMTBaseVertexProperties to copy.

Returns

a reference to this FMTBaseVertexProperties.

operator==()

bool Graph::FMTBaseVertexProperties::operator==

(

const FMTBaseVertexProperties &

rhs

)

const

Comparison operator for FMTBaseVertexProperties.

Parameters

[in]

rhs

the FMTBaseVertexProperties to compare to.

Returns

true if both vertex properties are equal else false.

setDevlopementMask()

void Graph::FMTBaseVertexProperties::setDevlopementMask

(

const Core::FMTMask &

p_newMask

)

Set the development mask of the vertex.

Parameters

[in]

p_newMask

the new mask of the development.

Friends And Related Function Documentation

boost::serialization::access

friend class boost::serialization::access

friend

Serialize the FMTBaseVertexProperties 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.

---

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

• D:/FMT/Include/FMTBaseVertexProperties.h