A Curve with additional, river specific data. More...
#include <HydroCurve.h>
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. |
A Curve with additional, river specific data.
An HydroCurve can be of 2 different types:
HydroCurve Type.
proland::HydroCurve::HydroCurve | ( | Graph * | owner | ) |
Creates a new HydroCurve.
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.
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.
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.
river | the Curve's Id. |
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.