fpmas 1.6
Public Member Functions | Protected Attributes | List of all members
fpmas::model::ReachableCell Class Reference

#include <graph.h>

Inheritance diagram for fpmas::model::ReachableCell:
Inheritance graph
[legend]

Public Member Functions

const std::set< DistributedId > & reachableCells () const
 
void addReachableCell (DistributedId id)
 
void removeReachableCell (DistributedId id)
 
void clearReachableCells ()
 

Protected Attributes

std::set< DistributedIdreachable_cells
 

Detailed Description

A cell base class that can be used to implement SpatialModels based on a generic and abstract graph.

A reachable_cells collection is maintained to specify direct neighbors of this Cell, even if the Cell is DISTANT from the current process.

As a reminder, the neighbor list of a DISTANT node can't be accessed directly within a DistributedGraph instance.

Member Function Documentation

◆ reachableCells()

const std::set< DistributedId > & fpmas::model::ReachableCell::reachableCells ( ) const
inline

Returns a set containing ids of cells reachable from this cell.

◆ addReachableCell()

void fpmas::model::ReachableCell::addReachableCell ( DistributedId  id)
inline

Adds the provided id to the reachable_cells collection.

Parameters
idid of a cell reachable from this cell

◆ removeReachableCell()

void fpmas::model::ReachableCell::removeReachableCell ( DistributedId  id)
inline

Removes the provided if from the reachable_cells collection.

Parameters
idid of a cell previously reachable from this cell

◆ clearReachableCells()

void fpmas::model::ReachableCell::clearReachableCells ( )
inline

Clears the reachable_cells collection.

Member Data Documentation

◆ reachable_cells

std::set<DistributedId> fpmas::model::ReachableCell::reachable_cells
protected

Ids of direct neighbors of this cell on the CELL_SUCCESSOR layer.

This collection must be built with addReachableCell().


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