WATERSHED::POUR Class Reference

This class is designed to provide pouring hydrological feature. More...

#include <mi32/watermdl.h>

List of all members.

Classes
struct	RECORD
Public Types
enum	TYPE { TYPE_None = 0, TYPE_Single = 1, TYPE_Double = 2 }
Public Member Functions
	POUR (const POUR &rhs)
	POUR (const TYPE type, const POURCANDIDATE &pourcandidate, const INT32 id)
	POUR ()
	~POUR ()
const INT32	GetElementIDOfVectorPoint () const
const INT32	GetLeftWatershed () const
const DPOINT3D &	GetPoint () const
const INT32	GetRightWatershed () const
const TYPE	GetType () const
void	Init (const TYPE type, const POURCANDIDATE &pourcandidate, const INT32 id)
POUR &	operator= (const POUR &rhs)
Private Attributes
RECORD	m_Record

---

Detailed Description

This class is designed to provide pouring hydrological feature.

It defines location on boundary between two watersheds where water pours only from one to another or in both directions. It is base class and provides get methods only.

---

Member Enumeration Documentation

enum WATERSHED::POUR::TYPE

Enumerator:

TYPE_None	Type of pour point. Point is not pour point
TYPE_Single	Pour point pours water only in specified direction.
TYPE_Double	Pour point pours water in both directions.

---

Constructor & Destructor Documentation

WATERSHED::POUR::POUR

(

)

[inline]

WATERSHED::POUR::POUR	(	const TYPE	type,
		const POURCANDIDATE &	pourcandidate,
		const INT32	id
	)			[inline]

Parameters:

	type	Constructor by location and neighbors watershed type of pour point
	pourcandidate	pour candidate
	id	vector point id

WATERSHED::POUR::POUR

(

const POUR &

rhs

)

[inline]

Parameters:

rhs

Copy constructor

WATERSHED::POUR::~POUR

(

)

[inline]

---

Member Function Documentation

const INT32 WATERSHED::POUR::GetElementIDOfVectorPoint

(

)

const [inline]

Get element ID of vector point in VectorWatershed object.

Returns:

Element ID

const INT32 WATERSHED::POUR::GetLeftWatershed

(

)

const [inline]

Get left watershed ID.

It is usally watershed where water pours from.

Returns:

Watershed ID

const DPOINT3D& WATERSHED::POUR::GetPoint

(

)

const [inline]

Get location of pour point as DPOINT3D in Original DEM coordinates.

Returns:

DPOINT3D

const INT32 WATERSHED::POUR::GetRightWatershed

(

)

const [inline]

Get left watershed ID.

It is usally watershed where water pours to.

Returns:

Watershed ID or -1 if on boundary of DEM

const TYPE WATERSHED::POUR::GetType

(

)

const [inline]

Get type of pour point.

Returns:

TYPE

void WATERSHED::POUR::Init	(	const TYPE	type,
		const POURCANDIDATE &	pourcandidate,
		const INT32	id
	)			[inline]

Parameters:

	type	type of pour point
	pourcandidate	pour candidate
	id	vector point id

POUR& WATERSHED::POUR::operator=

(

const POUR &

rhs

)

[inline]

Parameters:

rhs

Assignment operator

---

Member Data Documentation

RECORD WATERSHED::POUR::m_Record [private]

---

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

• mi32/watermdl.h