WATERSHED::POLYGON Class Reference

This class is designed to provide 2dimensional hydrological feature. More...

#include <mi32/watermdl.h>

List of all members.

Classes
struct	NEXTRECORD
struct	RECORD
Public Member Functions
	POLYGON (const POLYGON &rhs)
	POLYGON ()
	~POLYGON ()
const double	GetArea () const
const double	GetDepressionArea () const
const double	GetDepressionVolume () const
const INT32	GetIDOfLowerPour (const UINT32 index) const
const INT32	GetIDOfUpperPour (const UINT32 index) const
const INT32	GetIDOfVectorPolygon (const UINT32 index) const
const double	GetMaxZ () const
const double	GetMinZ () const
const UINT32	GetNumberOfLowerPours () const
const INT32	GetNumberOfUpperPours () const
const INT32	GetNumberOfVectorPolygons () const
const double	GetPerimeter () const
const double	GetRawZ () const
const double	GetZ () const
const bool	HasDepression () const
POLYGON &	operator= (const POLYGON &rhs)
Private Attributes
SIMPLE_ARRAY< INT32 >	m_LowerPours
RECORD	m_Record
SIMPLE_ARRAY< INT32 >	m_UpperPours
SIMPLE_ARRAY< INT32 >	m_VectorPolygons

---

Detailed Description

This class is designed to provide 2dimensional hydrological feature.

It defines set of neighbors cell on DEM called watershed. Watershed might have a depression where water is collected from all cells in watershed or might pour water out of DEM. Watershed in vector form is collection of 1 or more vector polygons as side effect of D8 algorithm. If watershed has depression it has also at least one lower pour point where water will flow out when watershed is overflown. Watershed might also have some upper pour points where water from neighbors wateshed will flow in. It is base class and provides get methods only.

---

Constructor & Destructor Documentation

WATERSHED::POLYGON::POLYGON

(

)

[inline]

WATERSHED::POLYGON::POLYGON

(

const POLYGON &

rhs

)

[inline]

Parameters:

rhs

Copy constructor

WATERSHED::POLYGON::~POLYGON

(

)

[inline]

---

Member Function Documentation

const double WATERSHED::POLYGON::GetArea

(

)

const [inline]

Get area of watershed.

Returns:

Area of watershed

const double WATERSHED::POLYGON::GetDepressionArea

(

)

const [inline]

Get depression area of watershed with depression.

Returns:

Depression area of watershed with depression

const double WATERSHED::POLYGON::GetDepressionVolume

(

)

const [inline]

Get depression volume of watershed with depression.

Returns:

Depression volume of watershed with depression

const INT32 WATERSHED::POLYGON::GetIDOfLowerPour

(

const UINT32

index

)

const [inline]

Get ID of lower pour point in watershed by index.

Returns:

ID of lower pour point or -1 if index is invalid

Parameters:

index

Index of pour point ID

const INT32 WATERSHED::POLYGON::GetIDOfUpperPour

(

const UINT32

index

)

const [inline]

Get ID of upper pour point in watershed by index.

Returns:

ID of upper pour point or -1 if index is invalid

Parameters:

index

Index of pour point ID

const INT32 WATERSHED::POLYGON::GetIDOfVectorPolygon

(

const UINT32

index

)

const [inline]

Get element ID of vector polygon in watershed by index.

Returns:

Element ID of vector polygon or -1 if index is invalid

Parameters:

index

Index of element ID of vector polygon

const double WATERSHED::POLYGON::GetMaxZ

(

)

const [inline]

Get maximum z value inside watershed.

Returns:

Maximum z value inside watershed

const double WATERSHED::POLYGON::GetMinZ

(

)

const [inline]

Get minimum z value inside watershed.

Returns:

Minimum z value inside watershed

const UINT32 WATERSHED::POLYGON::GetNumberOfLowerPours

(

)

const [inline]

Get number of lower pour points in watershed.

Returns:

Number of lower pour points

const INT32 WATERSHED::POLYGON::GetNumberOfUpperPours

(

)

const [inline]

Get number of upper pour points in watershed.

Returns:

Number of upper pour points

const INT32 WATERSHED::POLYGON::GetNumberOfVectorPolygons

(

)

const [inline]

Get number of vector polygons in watershed.

Returns:

Number of vector polygons

const double WATERSHED::POLYGON::GetPerimeter

(

)

const [inline]

Get perimeter of watershed boundary.

Returns:

Perimeter of watershed boundary

const double WATERSHED::POLYGON::GetRawZ

(

)

const [inline]

Get minimum raw z value on watershed boundary in original units.

Returns:

Minimum raw z value on watershed boundary in original units

const double WATERSHED::POLYGON::GetZ

(

)

const [inline]

Get minimum z value on watershed boundary in meters.

Returns:

Minimum z value on watershed boundary in meters

const bool WATERSHED::POLYGON::HasDepression

(

)

const [inline]

Defines if watershed has a depression.

Returns:

true if has or false - otherwise

POLYGON& WATERSHED::POLYGON::operator=

(

const POLYGON &

rhs

)

[inline]

Parameters:

rhs

Assignment operator

---

Member Data Documentation

SIMPLE_ARRAY<INT32> WATERSHED::POLYGON::m_LowerPours [private]

Container of lower pour points ID.

RECORD WATERSHED::POLYGON::m_Record [private]

SIMPLE_ARRAY<INT32> WATERSHED::POLYGON::m_UpperPours [private]

Container of upper pour points ID.

SIMPLE_ARRAY<INT32> WATERSHED::POLYGON::m_VectorPolygons [private]

Container of vector polygons elements ID.

---

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

• mi32/watermdl.h