openfluid::core::SpatialRepository Class Reference

List of all members.

Public Member Functions
	SpatialRepository ()
	~SpatialRepository ()
bool	addSU (SurfaceUnit *SU)
SurfaceUnit *	getSUByID (int ID)
bool	addRS (ReachSegment *RS)
ReachSegment *	getRSByID (int ID)
bool	addGU (GroundwaterUnit *GU)
GroundwaterUnit *	getGUByID (int ID)
bool	buildProcessOrders ()

---

Detailed Description

Management class for spatial objects and data

Author:

Jean-Christophe FABRE <fabrejc@ensam.inra.fr>

---

Constructor & Destructor Documentation

openfluid::core::SpatialRepository::SpatialRepository

(

)

Constructeur

openfluid::core::SpatialRepository::~SpatialRepository

(

)

Destructeur

---

Member Function Documentation

bool openfluid::core::SpatialRepository::addSU

(

SurfaceUnit *

SU

)

Adds a Surface Unit to the SUs collection

Parameters:

SU

the surface unit to add

SurfaceUnit* openfluid::core::SpatialRepository::getSUByID

(

int

ID

)

Returns SU object corresponding to the ID

Parameters:

ID

searched ID

Returns:

found SU, NULL otherwise

bool openfluid::core::SpatialRepository::addRS

(

ReachSegment *

RS

)

Adds a Reach Segment to the RSs collection

Parameters:

RS

the reach segment to add

ReachSegment* openfluid::core::SpatialRepository::getRSByID

(

int

ID

)

Returns RS object corresponding to the ID

Parameters:

ID

searched ID

Returns:

found RU, NULL otherwise

bool openfluid::core::SpatialRepository::addGU

(

GroundwaterUnit *

GU

)

Adds a groundwater Unit to the GUs collection

Parameters:

GU

the groundwater unit to add

GroundwaterUnit* openfluid::core::SpatialRepository::getGUByID

(

int

ID

)

Returns GU object corresponding to the ID

Parameters:

ID

searched ID

Returns:

found GU, NULL otherwise

bool openfluid::core::SpatialRepository::buildProcessOrders

(

)

Builds ordered lists for each kind of objects (SU,RS,GU)

!! commentaire a revoir !!

Regroupe les objets hydrologiques definissant l'espace etudie par classe d'ordre de traitement. Cette methode cree 3 vecteurs (un pour chaque type d'objet). Chacun de ces vecteurs contient un ensemble de vecteurs indexes par le numero d'ordre de traitement [0,ordre-1]. Ainsi l'ensemble des objets hydrologiques indexes [2] ont un ordre de traitement de 3.

Returns:

true si la constitution par classe a bien fonctionne