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

Information about a spatial line graph: its id and the interned constraint values shared across identical graphs. More...

#include <FMTGraphInfo.h>

Public Member Functions

 FMTGraphInfo ()=default
 Default constructor for FMTGraphInfo.
 
 FMTGraphInfo (size_t Id)
 Construct a FMTGraphInfo from a graph id.
 
const std::vector< double > & getValues (size_t p_ConstraintId) const
 Return the values of a constraint for the graph.
 
size_t getGraphId () const
 Return the graph id.
 
void setValues (size_t p_ConstraintId, const std::shared_ptr< const FMTGraphValues > &p_Values)
 Set the interned values of a constraint for the graph.
 
void setValuesSize (size_t p_ValuesSize)
 Reserve the number of constraint value vectors of the graph.
 
bool isEmpty () const
 Return true if the graph info has no values.
 

Detailed Description

Information about a spatial line graph: its id and the interned constraint values shared across identical graphs.

Constructor & Destructor Documentation

◆ FMTGraphInfo() [1/2]

Spatial::FMTGraphInfo::FMTGraphInfo ( )
default

Default constructor for FMTGraphInfo.

◆ FMTGraphInfo() [2/2]

Spatial::FMTGraphInfo::FMTGraphInfo ( size_t  Id)

Construct a FMTGraphInfo from a graph id.

Parameters
[in]Idthe graph id.

Member Function Documentation

◆ getGraphId()

size_t Spatial::FMTGraphInfo::getGraphId ( ) const
inline

Return the graph id.

Returns
the graph id.

◆ getValues()

const std::vector< double > & Spatial::FMTGraphInfo::getValues ( size_t  p_ConstraintId) const

Return the values of a constraint for the graph.

Parameters
[in]p_ConstraintIdthe constraint id.
Returns
the constraint values.

◆ isEmpty()

bool Spatial::FMTGraphInfo::isEmpty ( ) const

Return true if the graph info has no values.

Returns
true if the graph info is empty else false.

◆ setValues()

void Spatial::FMTGraphInfo::setValues ( size_t  p_ConstraintId,
const std::shared_ptr< const FMTGraphValues > &  p_Values 
)

Set the interned values of a constraint for the graph.

Parameters
[in]p_ConstraintIdthe constraint id.
[in]p_Valuesthe interned values.

◆ setValuesSize()

void Spatial::FMTGraphInfo::setValuesSize ( size_t  p_ValuesSize)

Reserve the number of constraint value vectors of the graph.

Parameters
[in]p_ValuesSizethe number of constraints.

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