MeteoIODoc  MeteoIODoc-2.6.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
mio::PGMIO Class Reference

Detailed Description

This class writes 2D grids as Portable Grey Map file format.

Author
Mathias Bavay
Date
2010-06-17

#include <PGMIO.h>

Public Member Functions

 PGMIO (const std::string &configfile)
 
 PGMIO (const PGMIO &)
 
 PGMIO (const Config &cfgreader)
 
virtual void read2DGrid (Grid2DObject &grid_out, const std::string &parameter="")
 A generic function for parsing 2D grids into a Grid2DObject. The string parameter shall be used for addressing the specific 2D grid to be parsed into the Grid2DObject, relative to GRID2DPATH for most plugins. More...
 
virtual void read2DGrid (Grid2DObject &grid_out, const MeteoGrids::Parameters &parameter, const Date &date)
 Read the given meteo parameter into a Grid2DObject. Each plugin has its own logic for finding the requested meteo parameter grid relative to GRID2DPATH for most plugins. More...
 
virtual void readDEM (DEMObject &dem_out)
 Parse the DEM (Digital Elevation Model) into the Grid2DObject. More...
 
virtual void write2DGrid (const Grid2DObject &grid_in, const std::string &filename)
 Write a Grid2DObject The filename is specified relative to GRID2DPATH for most plugins. More...
 
virtual void write2DGrid (const Grid2DObject &grid_in, const MeteoGrids::Parameters &parameter, const Date &date)
 Write a Grid2DObject comtaining a known meteorological parameter A filename is build relative to GRID2DPATH for most plugins. More...
 
- Public Member Functions inherited from mio::IOInterface
virtual ~IOInterface ()
 
virtual void read3DGrid (Grid3DObject &grid_out, const std::string &parameter="")
 A generic function for parsing 3D grids into a Grid3DObject. The string parameter shall be used for addressing the specific 3D grid to be parsed into the Grid3DObject, relative to GRID3DPATH for most plugins. More...
 
virtual void read3DGrid (Grid3DObject &grid_out, const MeteoGrids::Parameters &parameter, const Date &date)
 Read the given meteo parameter into a Grid3DObject. Each plugin has its own logic for finding the requested meteo parameter grid relative to GRID3DPATH for most plugins. More...
 
virtual void readLanduse (Grid2DObject &landuse_out)
 Parse the landuse model into the Grid2DObject. More...
 
virtual void readStationData (const Date &date, std::vector< StationData > &vecStation)
 Fill vecStation with StationData objects for a certain date of interest. More...
 
virtual void readMeteoData (const Date &dateStart, const Date &dateEnd, std::vector< std::vector< MeteoData > > &vecMeteo)
 Fill vecMeteo with a time series of objects corresponding to the interval indicated by dateStart and dateEnd. More...
 
virtual void writeMeteoData (const std::vector< std::vector< MeteoData > > &vecMeteo, const std::string &name="")
 Write vecMeteo time series to a certain destination. More...
 
virtual void readAssimilationData (const Date &date_in, Grid2DObject &da_out)
 Parse the assimilation data into a Grid2DObject for a certain date represented by the Date object. More...
 
virtual void readPOI (std::vector< Coords > &pts)
 Read a list of points by their grid coordinates This allows for example to get a list of points where to produce more detailed outputs. More...
 
virtual void write3DGrid (const Grid3DObject &grid_out, const std::string &options="")
 Write a Grid3DObject The filename is specified relative to GRID3DPATH for most plugins. More...
 
virtual void write3DGrid (const Grid3DObject &grid_out, const MeteoGrids::Parameters &parameter, const Date &date)
 Write a Grid3DObject comtaining a known meteorological parameter A filename is build relative to GRID3DPATH for most plugins. More...
 

Constructor & Destructor Documentation

mio::PGMIO::PGMIO ( const std::string &  configfile)
mio::PGMIO::PGMIO ( const PGMIO )
mio::PGMIO::PGMIO ( const Config cfgreader)

Member Function Documentation

void mio::PGMIO::read2DGrid ( Grid2DObject grid_out,
const std::string &  parameter = "" 
)
virtual

A generic function for parsing 2D grids into a Grid2DObject. The string parameter shall be used for addressing the specific 2D grid to be parsed into the Grid2DObject, relative to GRID2DPATH for most plugins.

Parameters
grid_outA Grid2DObject instance
parameterA std::string representing some information for the function on what grid to retrieve

Reimplemented from mio::IOInterface.

void mio::PGMIO::read2DGrid ( Grid2DObject grid_out,
const MeteoGrids::Parameters parameter,
const Date date 
)
virtual

Read the given meteo parameter into a Grid2DObject. Each plugin has its own logic for finding the requested meteo parameter grid relative to GRID2DPATH for most plugins.

Parameters
grid_outA Grid2DObject instance
parameterThe meteo parameter grid type to return (ie: air temperature, wind component, etc)
datedate of the data to read

Reimplemented from mio::IOInterface.

void mio::PGMIO::readDEM ( DEMObject dem_out)
virtual

Parse the DEM (Digital Elevation Model) into the Grid2DObject.

Example Usage:

Grid2DObject dem;
IOHandler io1("io.ini");
io1.readDEM(dem);
Parameters
dem_outA Grid2DObject that holds the DEM

Reimplemented from mio::IOInterface.

void mio::PGMIO::write2DGrid ( const Grid2DObject grid_out,
const std::string &  options 
)
virtual

Write a Grid2DObject The filename is specified relative to GRID2DPATH for most plugins.

Parameters
grid_out(Grid2DObject) The grid to write
options(string) Identifier usefull for the output plugin (it could become part of a file name, a db table, etc)

Reimplemented from mio::IOInterface.

void mio::PGMIO::write2DGrid ( const Grid2DObject grid_out,
const MeteoGrids::Parameters parameter,
const Date date 
)
virtual

Write a Grid2DObject comtaining a known meteorological parameter A filename is build relative to GRID2DPATH for most plugins.

Parameters
grid_out(Grid2DObject) The grid to write
parameterThe meteo parameter grid type of the provided grid object (ie: air temperature, wind component, etc)
datedate of the data to write

Reimplemented from mio::IOInterface.


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