SettingsBasin Class Reference

Inheritance diagram for SettingsBasin:

Public Member Functions
void	AddHydroUnit (int id, double area, double elevation=-9999)
void	AddLandCover (const string &name, const string &type="", double fraction=1.0)
void	AddHydroUnitPropertyDouble (const string &name, double value, const string &unit="")
void	AddHydroUnitPropertyString (const string &name, const string &value)
void	AddLateralConnection (int giverHydroUnitId, int receiverHydroUnitId, double fraction, const string &type="")
void	Clear ()
void	SelectUnit (int index)
bool	Parse (const string &path)
HydroUnitSettings	GetHydroUnitSettings (int index) const
LandCoverSettings	GetLandCoverSettings (int index) const
SurfaceComponentSettings	GetSurfaceComponentSettings (int index) const
vector< LateralConnectionSettings >	GetLateralConnections () const
int	GetHydroUnitsNb () const
int	GetLandCoversNb () const
int	GetSurfaceComponentsNb () const
int	GetLateralConnectionsNb () const
double	GetTotalArea () const

Member Function Documentation

AddHydroUnit()

void SettingsBasin::AddHydroUnit	(	int	id,
		double	area,
		double	elevation = -9999 )

Add a new hydro unit.

Parameters

id	ID of the hydro unit.
area	area of the hydro unit.
elevation	elevation of the hydro unit.

AddHydroUnitPropertyDouble()

void SettingsBasin::AddHydroUnitPropertyDouble	(	const string &	name,
		double	value,
		const string &	unit = "" )

Add a numeric property to the selected hydro unit.

Parameters

name	name of the property.
value	value of the property.
unit	unit of the property.

AddHydroUnitPropertyString()

void SettingsBasin::AddHydroUnitPropertyString	(	const string &	name,
		const string &	value )

Add a string property to the selected hydro unit.

Parameters

name	name of the property.
value	value of the property.

AddLandCover()

void SettingsBasin::AddLandCover	(	const string &	name,
		const string &	type = "",
		double	fraction = 1.0 )

Add a new land cover to the selected hydro unit.

Parameters

name	name of the land cover.
type	type of the land cover.
fraction	fraction of the land cover.

AddLateralConnection()

void SettingsBasin::AddLateralConnection	(	int	giverHydroUnitId,
		int	receiverHydroUnitId,
		double	fraction,
		const string &	type = "" )

Add a lateral connection between two hydro units.

Parameters

giverHydroUnitId	ID of the hydro unit giving the connection.
receiverHydroUnitId	ID of the hydro unit receiving the connection.
fraction	The fraction of the flow that is transferred.
type	The type of the lateral connection (optional). It is unused in the current implementation, but can be used for future extensions (for example, to differentiate between snow and groundwater).

Clear()

void SettingsBasin::Clear

(

)

Clear all hydro units.

GetHydroUnitSettings()

HydroUnitSettings SettingsBasin::GetHydroUnitSettings ( int index ) const

inline

Get hydro unit settings.

Parameters

index

index of the hydro unit.

Returns

pointer to the selected hydro unit.

GetHydroUnitsNb()

int SettingsBasin::GetHydroUnitsNb ( ) const

inline

Get the number of hydro units.

Returns

number of hydro units.

GetLandCoverSettings()

LandCoverSettings SettingsBasin::GetLandCoverSettings ( int index ) const

inline

Get land cover settings for the selected hydro unit.

Parameters

index

index of the land cover.

Returns

pointer to the selected land cover.

GetLandCoversNb()

int SettingsBasin::GetLandCoversNb ( ) const

inline

Get the number of land covers for the selected hydro unit.

Returns

number of land covers.

GetLateralConnections()

vector< LateralConnectionSettings > SettingsBasin::GetLateralConnections ( ) const

inline

Get the lateral connections settings.

Returns

vector of lateral connection settings.

GetLateralConnectionsNb()

int SettingsBasin::GetLateralConnectionsNb ( ) const

inline

Get the number of lateral connections.

Returns

number of lateral connections.

GetSurfaceComponentSettings()

SurfaceComponentSettings SettingsBasin::GetSurfaceComponentSettings ( int index ) const

inline

Get surface component settings for the selected hydro unit.

Parameters

index

index of the surface component.

Returns

pointer to the selected surface component.

GetSurfaceComponentsNb()

int SettingsBasin::GetSurfaceComponentsNb ( ) const

inline

Get the number of surface components for the selected hydro unit.

Returns

number of surface components.

GetTotalArea()

double SettingsBasin::GetTotalArea

(

)

const

Get the total area of the sub basin (all hydro units).

Returns

total area of the sub basin.

Parse()

bool SettingsBasin::Parse

(

const string &

path

)

Parse a NetCDF file to get the hydro unit settings.

SelectUnit()

void SettingsBasin::SelectUnit

(

int

index

)

Select a hydro unit.

Parameters

index

index of the hydro unit to select.

---

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

• /github/workspace/core/src/base/SettingsBasin.h
• /github/workspace/core/src/base/SettingsBasin.cpp