proland::HydroCurve Class Reference
[graph]

A Curve with additional, river specific data. More...

#include <HydroCurve.h>

Inheritance diagram for proland::HydroCurve:
proland::LazyHydroCurve

List of all members.

Public Types

enum  HYDRO_CURVE_TYPE
 

HydroCurve Type.

More...

Public Member Functions

 HydroCurve (Graph *owner)
 Creates a new HydroCurve.
 HydroCurve (Graph *owner, CurvePtr c, NodePtr s, NodePtr e)
 Creates a new HydroCurve, with parameters copied from another Curve.
virtual ~HydroCurve ()
 Deletes this HydroCurve.
float getWidth () const
 Returns the width of this curve.
float getPotential () const
 Returns this Curve's potential.
void setPotential (float potential)
 Sets this curve's potential.
CurveId getRiver () const
 Returns the id of the river axis associated to this HydroCurve.
CurvePtr getRiverPtr () const
 Returns the river axis associated to this HydroCurve.
void setRiver (CurveId river)
 Sets the river axis associated to this HydroCurve.
virtual void print () const
 Display method.

Protected Attributes

CurveId river
 River axis associated to this HydroCurve.
float potential
 Value used to determine the flow between two banks.

Detailed Description

A Curve with additional, river specific data.

An HydroCurve can be of 2 different types:

Author:
Antoine Begault

Member Enumeration Documentation

HydroCurve Type.


Constructor & Destructor Documentation

proland::HydroCurve::HydroCurve ( Graph *  owner  ) 

Creates a new HydroCurve.

Parameters:
owner the graph containing this curve.
proland::HydroCurve::HydroCurve ( Graph *  owner,
CurvePtr  c,
NodePtr  s,
NodePtr  e 
)

Creates a new HydroCurve, with parameters copied from another Curve.

Parameters:
owner the graph containing this curve.
c the copied curve, from which this curve takes its data.
s the start node.
e the end node.
virtual proland::HydroCurve::~HydroCurve (  )  [virtual]

Deletes this HydroCurve.


Member Function Documentation

float proland::HydroCurve::getPotential (  )  const

Returns this Curve's potential.

Returns -1 if this Curve is a river axis.

CurveId proland::HydroCurve::getRiver (  )  const

Returns the id of the river axis associated to this HydroCurve.

NULL_ID if this Curve is a river axis.

CurvePtr proland::HydroCurve::getRiverPtr (  )  const

Returns the river axis associated to this HydroCurve.

NULL if this Curve is a river.

float proland::HydroCurve::getWidth (  )  const

Returns the width of this curve.

virtual void proland::HydroCurve::print (  )  const [virtual]

Display method.

For debug only.

void proland::HydroCurve::setPotential ( float  potential  ) 

Sets this curve's potential.

void proland::HydroCurve::setRiver ( CurveId  river  ) 

Sets the river axis associated to this HydroCurve.

Parameters:
river the Curve's Id.

Member Data Documentation

float proland::HydroCurve::potential [protected]

Value used to determine the flow between two banks.

CurveId proland::HydroCurve::river [protected]

River axis associated to this HydroCurve.


Generated on Sat May 12 09:42:58 2012 for proland by  doxygen 1.6.1