Detailed Description

This class is the class to use for raw I/O operations. It is responsible for transparently loading the plugins and it follows the interface defined by the IOInterface class with the addition of a few convenience methods.

#include <IOHandler.h>

Public Member Functions
	IOHandler (const IOHandler &)

	IOHandler (const Config &)

virtual	~IOHandler () throw ()

IOHandler &	operator= (const IOHandler &)
	Assignement operator. More...

virtual void	read2DGrid (Grid2DObject &out_grid, 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	read3DGrid (Grid3DObject &grid_out, const std::string &i_filename="")
	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	readDEM (DEMObject &dem_out)
	Parse the DEM (Digital Elevation Model) into the Grid2DObject. More...

virtual void	readLanduse (Grid2DObject &landuse_out)
	Parse the landuse model into the Grid2DObject. More...

virtual void	readStationData (const Date &date, STATIONS_SET &vecStation)

virtual void	writeMeteoData (const std::vector< METEO_SET > &vecMeteo, const std::string &name="")

virtual void	readMeteoData (const Date &dateStart, const Date &dateEnd, std::vector< METEO_SET > &vecMeteo)

virtual void	readAssimilationData (const Date &, 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	write2DGrid (const Grid2DObject &grid_in, const std::string &name)
	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...

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...

const std::string	toString () const

Public Member Functions inherited from mio::IOInterface
virtual	~IOInterface ()

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...

Constructor & Destructor Documentation

mio::IOHandler::IOHandler ( const IOHandler & aio )

mio::IOHandler::IOHandler ( const Config & cfgreader )

mio::IOHandler::~IOHandler	(	)
throw	(
	)

virtual

Member Function Documentation

IOHandler & mio::IOHandler::operator= ( const IOHandler & source )

Assignement operator.

void mio::IOHandler::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_out	A Grid2DObject instance
parameter	A std::string representing some information for the function on what grid to retrieve

Reimplemented from mio::IOInterface.

void mio::IOHandler::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_out	A Grid2DObject instance
parameter	The meteo parameter grid type to return (ie: air temperature, wind component, etc)
date	date of the data to read

Reimplemented from mio::IOInterface.

void mio::IOHandler::read3DGrid	(	Grid3DObject &	grid_out,
		const std::string &	parameter = `""`
	)

virtual

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.

Parameters

grid_out	A Grid3DObject instance
parameter	A std::string representing some information for the function on what grid to retrieve

Reimplemented from mio::IOInterface.

void mio::IOHandler::read3DGrid	(	Grid3DObject &	grid_out,
		const MeteoGrids::Parameters &	parameter,
		const Date &	date
	)

virtual

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.

Parameters

grid_out	A Grid3DObject instance
parameter	The meteo parameter grid type to return (ie: air temperature, wind component, etc)
date	date of the data to read

Reimplemented from mio::IOInterface.

void mio::IOHandler::readAssimilationData	(	const Date &	date_in,
		Grid2DObject &	da_out
	)

virtual

Parse the assimilation data into a Grid2DObject for a certain date represented by the Date object.

Example Usage:

Grid2DObject adata;
Date d1(2008,06,21,11,00);       //21.6.2008 11:00
IOHandler io1("io.ini");
io1.readAssimilationData(d1, adata);

Parameters

date_in	A Date object representing the date of the assimilation data
da_out	A Grid2DObject that holds the assimilation data for every grid point

Reimplemented from mio::IOInterface.

void mio::IOHandler::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_out A Grid2DObject that holds the DEM

Reimplemented from mio::IOInterface.

void mio::IOHandler::readLanduse ( Grid2DObject & landuse_out )

virtual

Parse the landuse model into the Grid2DObject.

Example Usage:

Grid2DObject landuse;
IOHandler io1("io.ini");
io1.readLanduse(landuse);

Parameters

landuse_out A Grid2DObject that holds the landuse model

Reimplemented from mio::IOInterface.

void mio::IOHandler::readMeteoData	(	const Date &	dateStart,
		const Date &	dateEnd,
		std::vector< METEO_SET > &	vecMeteo
	)

virtual

void mio::IOHandler::readPOI ( std::vector< Coords > & pts )

virtual

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.

Parameters

pts	(std::vector<Coords>) A vector of points coordinates

Reimplemented from mio::IOInterface.

void mio::IOHandler::readStationData	(	const Date &	date,
		STATIONS_SET &	vecStation
	)

virtual

const std::string mio::IOHandler::toString ( ) const

void mio::IOHandler::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::IOHandler::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
parameter	The meteo parameter grid type of the provided grid object (ie: air temperature, wind component, etc)
date	date of the data to write

Reimplemented from mio::IOInterface.

void mio::IOHandler::write3DGrid	(	const Grid3DObject &	grid_out,
		const std::string &	options
	)

virtual

Write a Grid3DObject The filename is specified relative to GRID3DPATH for most plugins.

Parameters

grid_out	(Grid3DObject) 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::IOHandler::write3DGrid	(	const Grid3DObject &	grid_out,
		const MeteoGrids::Parameters &	parameter,
		const Date &	date
	)

virtual

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

Parameters

grid_out	(Grid3DObject) The grid to write
parameter	The meteo parameter grid type of the provided grid object (ie: air temperature, wind component, etc)
date	date of the data to write

Reimplemented from mio::IOInterface.

void mio::IOHandler::writeMeteoData	(	const std::vector< METEO_SET > &	vecMeteo,
		const std::string &	name = `""`
	)

virtual

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

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation