2.0.0b10
catchment modelling framework
Loading...
Searching...
No Matches
RainfallStationList Class Reference

A list of rainfall stations. More...

Detailed Description

A list of rainfall stations.

Public Member Functions

RainfallStation::ptr add (std::string Name, cmf::math::timeseries Data, cmf::geometry::point Position)
 Creates a new RainfallStation and adds it to the list.
 
RainfallStation::ptr operator[] (ptrdiff_t index)
 Returns the station at index.
 
const RainfallStation::ptr operator[] (ptrdiff_t index) const
 Returns the station at index.
 
void remove (ptrdiff_t index)
 Removes the station at index from this list.
 
size_t size () const
 Returns the number of rainfall stations.
 

Member Function Documentation

◆ add()

RainfallStation::ptr add ( std::string Name,
cmf::math::timeseries Data,
cmf::geometry::point Position )

Creates a new RainfallStation and adds it to the list.

Usage:

project.rainfall_stations.add("Station name", cmf.timeseries.from_file('rainfall.bin'), (65124,78009,187))
RainfallStation::ptr add(std::string Name, cmf::math::timeseries Data, cmf::geometry::point Position)
Creates a new RainfallStation and adds it to the list.
Definition precipitation.h:172
The study area, holding all cells, outlets and streams.
Definition project.h:53
cmf::atmosphere::RainfallStationList rainfall_stations
The rainfall stations of the project.
Definition project.h:75
The main namespace of the model framework. Contains the other namespaces and the project class.
Definition __init__.py:1

The position of the rainfall station will be used as identifier

Returns
A new rainfall station
Parameters
NameName of the station
DataRainfall timeseries
PositionSpatial position of the new station