WATERSHED::ATTRIBUTE Class Reference

This class is designed to provide hydrological features. More...

#include <mi32/watermdl.h>

Public Member Functions
	ATTRIBUTE (const UINT32 NumberRasterPolygons)
	~ATTRIBUTE ()
ERRVALUE	AddArea (const INT32 watershed, const double area)
ERRVALUE	AddDepressionArea (const INT32 watershed, const double area)
ERRVALUE	AddDepressionData (const INT32 watershed, const double area, const double volume)
ERRVALUE	AddDepressionVolume (const INT32 watershed, const double volume)
ERRVALUE	AddLink (const INT32 watershed, const INT32 VectorPolygon)
ERRVALUE	AddLowerPour (const INT32 watershed, const INT32 LowerPour)
ERRVALUE	AddPerimeter (const INT32 watershed, const double perimeter)
ERRVALUE	AddPour (const POUR &pour)
ERRVALUE	AddPourCandidate (const POURCANDIDATE &pourcandidate)
ERRVALUE	AddUpperPour (const INT32 watershed, const INT32 UpperPour)
ERRVALUE	AddVectorPolygon (const INT32 watershed, const INT32 VectorPolygon)
ERRVALUE	CheckBoundaryElevation (const INT32 watershed, const double z, const double rawZ)
ERRVALUE	CheckElevationAndAddArea (const INT32 watershed, const double elevation, const double area)
ERRVALUE	CheckInternalElevation (const INT32 watershed, const double elevation)
ERRVALUE	DefinePours (RVC::VECTOR &vector)
const INT32	GetIDOfWatershedPolygonForVectorPolygon (const INT32 index)
const INT32	GetNumberOfDoublePours () const
const INT32	GetNumberOfPourCandidates () const
const INT32	GetNumberOfPours () const
const INT32	GetNumberOfVectorPolygons () const
const INT32	GetNumberOfWatershedPolygons () const
const INT32	GetNumberOfWatershedPolygonsWithDepression () const
bool	GetPour (const INT32 index, POUR &pour)
bool	GetPourCandidate (const INT32 index, POURCANDIDATE &pourcandidate)
bool	GetWatershedPolygon (const INT32 index, POLYGON &polygon)
const double	GetWatershedZ (const INT32 watershed)
const bool	HasDepression (const INT32 watershed)
const bool	HasDepressions () const
ERRVALUE	Init (const INT32 NumPolys, const INT32 NumLines, const INT32 NumNodes)
void	RisePourType (POUR::TYPE &type)
ERRVALUE	SaveAsVectorPoint (RVC::VECTOR &vector, const DPOINT3D &point, const INT32 id)

Detailed Description

This class is designed to provide hydrological features.

It computes and defines watersheds, depressions and pour points.

Constructor & Destructor Documentation

WATERSHED::ATTRIBUTE::ATTRIBUTE ( const UINT32 NumberRasterPolygons )

Parameters:

NumberRasterPolygons

Constructor by number of polygons in Watershed raster Number of polygons in Watershed raster

WATERSHED::ATTRIBUTE::~ATTRIBUTE ( )

Member Function Documentation

ERRVALUE WATERSHED::ATTRIBUTE::AddArea	(	const INT32	watershed,
		const double	area
	)

Add area to watershed.

Parameters:

	watershed	Watershed ID
	area	area

ERRVALUE WATERSHED::ATTRIBUTE::AddDepressionArea	(	const INT32	watershed,
		const double	area
	)

Add depression area to watershed.

Parameters:

	watershed	Watershed ID
	area	area

ERRVALUE WATERSHED::ATTRIBUTE::AddDepressionData	(	const INT32	watershed,
		const double	area,
		const double	volume
	)

Add depression area and volume to watershed.

Parameters:

	watershed	Watershed ID
	area	area
	volume	volume

ERRVALUE WATERSHED::ATTRIBUTE::AddDepressionVolume	(	const INT32	watershed,
		const double	volume
	)

Add depression volume to watershed.

Parameters:

	watershed	Watershed ID
	volume	volume

ERRVALUE WATERSHED::ATTRIBUTE::AddLink	(	const INT32	watershed,
		const INT32	VectorPolygon
	)

Add link between watershed and vector polygon.

Parameters:

	watershed	Watershed ID
	VectorPolygon	Vector polygon element ID

ERRVALUE WATERSHED::ATTRIBUTE::AddLowerPour	(	const INT32	watershed,
		const INT32	LowerPour
	)

Add given pour point ID to collection of lower pour points for watershed.

Parameters:

	watershed	Watershed ID
	LowerPour	Pour point ID

ERRVALUE WATERSHED::ATTRIBUTE::AddPerimeter	(	const INT32	watershed,
		const double	perimeter
	)

Add perimeter to watershed.

Parameters:

	watershed	Watershed ID
	perimeter	perimeter

ERRVALUE WATERSHED::ATTRIBUTE::AddPour ( const POUR & pour )

Add pour to collection of pours.

Parameters:

pour

Pour object

ERRVALUE WATERSHED::ATTRIBUTE::AddPourCandidate ( const POURCANDIDATE & pourcandidate )

Add pour candidate to collection of pour candidates.

Parameters:

pourcandidate

Pour candidate object

ERRVALUE WATERSHED::ATTRIBUTE::AddUpperPour	(	const INT32	watershed,
		const INT32	UpperPour
	)

Add given pour point ID to collection of upper pour points for watershed.

Parameters:

	watershed	Watershed ID
	UpperPour	Pour point ID

ERRVALUE WATERSHED::ATTRIBUTE::AddVectorPolygon	(	const INT32	watershed,
		const INT32	VectorPolygon
	)

Add given vector polygon element ID to collection of vector polygons for watershed.

Parameters:

	watershed	Watershed ID
	VectorPolygon	Vector polygon element ID

ERRVALUE WATERSHED::ATTRIBUTE::CheckBoundaryElevation	(	const INT32	watershed,
		const double	z,
		const double	rawZ
	)

Check minimum z value on boundary of watershed for given elevation.

Parameters:

	watershed	Watershed ID
	z	Elevation for checking
	rawZ	Raw Elevation for checking

ERRVALUE WATERSHED::ATTRIBUTE::CheckElevationAndAddArea	(	const INT32	watershed,
		const double	elevation,
		const double	area
	)

Check minimum and maximum z value inside watershed for given elevation and add area.

Parameters:

	watershed	Watershed ID
	elevation	Elevation for checking
	area	area

ERRVALUE WATERSHED::ATTRIBUTE::CheckInternalElevation	(	const INT32	watershed,
		const double	elevation
	)

Check minimum and maximum z value inside watershed for given elevation.

Parameters:

	watershed	Watershed ID
	elevation	Elevation for checking

ERRVALUE WATERSHED::ATTRIBUTE::DefinePours ( RVC::VECTOR & vector )

Define real pour points in collection of pour candidates and save them in given vector object.

Returns:: ERRVALUE

const INT32 WATERSHED::ATTRIBUTE::GetIDOfWatershedPolygonForVectorPolygon ( const INT32 index )

Get watershed polygon ID in watershed system for given vector polygon element ID that belongs to this watershed.

Returns:: Watershed polygon ID

Parameters:

index

Vector polygon element ID

const INT32 WATERSHED::ATTRIBUTE::GetNumberOfDoublePours ( ) const [inline]

Get number of double pour points in watershed system.

Returns:: Number of double pour points

const INT32 WATERSHED::ATTRIBUTE::GetNumberOfPourCandidates ( ) const [inline]

Get number of pour candidate points in watershed system.

Returns:: Number of pour candidate points

const INT32 WATERSHED::ATTRIBUTE::GetNumberOfPours ( ) const [inline]

Get number of pour points in watershed system.

Returns:: Number of pour points

const INT32 WATERSHED::ATTRIBUTE::GetNumberOfVectorPolygons ( ) const [inline]

Get number of vector polygons in watershed system.

Returns:: Number of vector polygons

const INT32 WATERSHED::ATTRIBUTE::GetNumberOfWatershedPolygons ( ) const [inline]

Get number of watershed polygons in watershed system.

Returns:: Number of watershed polygons

const INT32 WATERSHED::ATTRIBUTE::GetNumberOfWatershedPolygonsWithDepression ( ) const [inline]

Get number of watershed polygons with depression in watershed system.

Returns:: Number of watershed polygons with depression

bool WATERSHED::ATTRIBUTE::GetPour	(	const INT32	index,
		POUR &	pour
	)

Get pour object in watershed system by index.

Returns:: true if valid index

Parameters:

index

Pour point ID

bool WATERSHED::ATTRIBUTE::GetPourCandidate	(	const INT32	index,
		POURCANDIDATE &	pourcandidate
	)

Get pour candidate object in watershed system by index.

Returns:: true if valid index

bool WATERSHED::ATTRIBUTE::GetWatershedPolygon	(	const INT32	index,
		POLYGON &	polygon
	)

Get watershed polygon object in watershed system by index.

Returns:: true if valid index

Parameters:

index

Watershed polygon ID

const double WATERSHED::ATTRIBUTE::GetWatershedZ ( const INT32 watershed )

Returns watershed minimum z on boundary.

Returns:: watershed z

Parameters:

watershed

Watershed ID

const bool WATERSHED::ATTRIBUTE::HasDepression ( const INT32 watershed )

Defines if watershed polygon has a depressions.

Returns:: true if has or false - otherwise

Parameters:

watershed

Watershed ID

const bool WATERSHED::ATTRIBUTE::HasDepressions ( ) const [inline]

Defines if watershed system has a depressions.

Returns:: true if has or false - otherwise

ERRVALUE WATERSHED::ATTRIBUTE::Init	(	const INT32	NumPolys,
		const INT32	NumLines,
		const INT32	NumNodes
	)

Initialization of attributes.

Parameters:

	NumPolys	Number of vector polygons
	NumLines	Number of vector lines
	NumNodes	Number of vector nodes

void WATERSHED::ATTRIBUTE::RisePourType ( POUR::TYPE & type ) [inline]

Rise type.

ERRVALUE WATERSHED::ATTRIBUTE::SaveAsVectorPoint	(	RVC::VECTOR &	vector,
		const DPOINT3D &	point,
		const INT32	id
	)

Save pour point as vector point.

Returns:: ERRVALUE

Parameters:

id

Element Id of vector point to be saved

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

mi32/watermdl.h

WATERSHED::ATTRIBUTE Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation