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

Vertex properties of a FMTGraph, extending the base vertex properties with a constraint id. More...

#include <FMTVertexProperties.h>

Inheritance diagram for Graph::FMTVertexProperties:
[legend]
Collaboration diagram for Graph::FMTVertexProperties:
[legend]

Public Member Functions

 ~FMTVertexProperties ()=default
 Default destructor for FMTVertexProperties.
 
 FMTVertexProperties ()=default
 Default constructor for FMTVertexProperties.
 
 FMTVertexProperties (const FMTVertexProperties &rhs)
 Copy constructor for FMTVertexProperties.
 
FMTVertexPropertiesoperator= (const FMTVertexProperties &rhs)=default
 Copy assignment operator for FMTVertexProperties.
 
 FMTVertexProperties (const Core::FMTFuturDevelopment &ldevelopment, const int &lconstraintID)
 Construct a FMTVertexProperties from a futur development and a constraint id.
 
 FMTVertexProperties (const Core::FMTActualDevelopment &ldevelopment, const int &lconstraintID)
 Construct a FMTVertexProperties from an actual development and a constraint id.
 
 FMTVertexProperties (const Core::FMTDevelopment &ldevelopment, const int &lconstraintID)
 Construct a FMTVertexProperties from a development and a constraint id.
 
std::string constraintName () const
 Return the name of the constraint of the vertex.
 
int getConstraintId () const override
 Return the constraint id of the vertex.
 
void setConstraintId (const int &ID)
 Set the constraint id of the vertex.
 
- Public Member Functions inherited from Graph::FMTBaseVertexProperties
virtual ~FMTBaseVertexProperties ()=default
 Default virtual destructor for FMTBaseVertexProperties.
 
 FMTBaseVertexProperties ()=default
 Default constructor for FMTBaseVertexProperties.
 
 FMTBaseVertexProperties (const FMTBaseVertexProperties &rhs)
 Copy constructor for FMTBaseVertexProperties.
 
FMTBaseVertexPropertiesoperator= (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::FMTDevelopmentget () 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
 

Detailed Description

Vertex properties of a FMTGraph, extending the base vertex properties with a constraint id.

Constructor & Destructor Documentation

◆ ~FMTVertexProperties()

Graph::FMTVertexProperties::~FMTVertexProperties ( )
default

Default destructor for FMTVertexProperties.

◆ FMTVertexProperties() [1/5]

Graph::FMTVertexProperties::FMTVertexProperties ( )
default

Default constructor for FMTVertexProperties.

◆ FMTVertexProperties() [2/5]

Graph::FMTVertexProperties::FMTVertexProperties ( const FMTVertexProperties rhs)

Copy constructor for FMTVertexProperties.

Parameters
[in]rhsthe FMTVertexProperties to copy.

◆ FMTVertexProperties() [3/5]

Graph::FMTVertexProperties::FMTVertexProperties ( const Core::FMTFuturDevelopment ldevelopment,
const int &  lconstraintID 
)

Construct a FMTVertexProperties from a futur development and a constraint id.

Parameters
[in]ldevelopmentthe futur development.
[in]lconstraintIDthe constraint id.

◆ FMTVertexProperties() [4/5]

Graph::FMTVertexProperties::FMTVertexProperties ( const Core::FMTActualDevelopment ldevelopment,
const int &  lconstraintID 
)

Construct a FMTVertexProperties from an actual development and a constraint id.

Parameters
[in]ldevelopmentthe actual development.
[in]lconstraintIDthe constraint id.

◆ FMTVertexProperties() [5/5]

Graph::FMTVertexProperties::FMTVertexProperties ( const Core::FMTDevelopment ldevelopment,
const int &  lconstraintID 
)

Construct a FMTVertexProperties from a development and a constraint id.

Parameters
[in]ldevelopmentthe development.
[in]lconstraintIDthe constraint id.

Member Function Documentation

◆ constraintName()

std::string Graph::FMTVertexProperties::constraintName ( ) const

Return the name of the constraint of the vertex.

Returns
the constraint name.

◆ getConstraintId()

int Graph::FMTVertexProperties::getConstraintId ( ) const
inlineoverridevirtual

Return the constraint id of the vertex.

Returns
the constraint id.

Reimplemented from Graph::FMTBaseVertexProperties.

◆ operator=()

FMTVertexProperties & Graph::FMTVertexProperties::operator= ( const FMTVertexProperties rhs)
default

Copy assignment operator for FMTVertexProperties.

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

◆ setConstraintId()

void Graph::FMTVertexProperties::setConstraintId ( const int &  ID)

Set the constraint id of the vertex.

Parameters
[in]IDthe constraint id.

Friends And Related Function Documentation

◆ boost::serialization::access

friend class boost::serialization::access
friend

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