WSL/SLF GitLab Repository

Commit fc76f7f6 authored by Mathias Bavay's avatar Mathias Bavay
Browse files

A small formatting bug has been fixed in SNIO.

Most of the doxygen issues have been fixed. A few are still left (and we lost the inheritance structure in doxygen).
parent a3284276
......@@ -25,6 +25,7 @@
#include "IOExceptions.h"
#define NOSAFECHECKS
namespace mio {
/**
* @class Array
......@@ -33,7 +34,6 @@
* @author Thomas Egger
* @date 2009-05-02
*/
namespace mio {
template<class T> class Array {
public:
......
......@@ -31,6 +31,8 @@
#include <vector>
#include <string>
namespace mio {
/**
* @class BufferedIOHandler
* @brief This class serves as a wrapper around all children of IOInterface. It internally handles
......@@ -39,7 +41,6 @@
* @author Thomas Egger
* @date 2009-07-25
*/
namespace mio {
class MeteoFilter;
......
......@@ -26,6 +26,9 @@
#include <string>
#include <map>
namespace mio {
/**
* @class ConfigReader
* @brief A class that reads a key/value file. These files (typically named *.ini) have the following structure:
......@@ -41,7 +44,6 @@
* @author Thomas Egger
* @date 2008-11-30
*/
namespace mio {
namespace IOUtils {
void toUpper(std::string& str);
......
......@@ -63,13 +63,13 @@ using namespace mio::IOUtils;
*
*/
const struct Coords::ELLIPSOID Coords::ellipsoids[] = {
{ 6378137., 6356752.3142 }, //E_WGS84
{ 6378137., 6356752.3141 }, //E_GRS80
{ 6377563.396, 6356256.909 }, //E_AIRY
{ 6378388., 6356911.946 }, //E_INTL1924
{ 6378249.145, 6356514.86955 }, //E_CLARKE1880
{ 6378160., 6356774.719 } //E_GRS67
const struct mio::Coords::ELLIPSOID Coords::ellipsoids[] = {
{ 6378137., 6356752.3142 }, ///< E_WGS84
{ 6378137., 6356752.3141 }, ///< E_GRS80
{ 6377563.396, 6356256.909 }, ///< E_AIRY
{ 6378388., 6356911.946 }, ///< E_INTL1924
{ 6378249.145, 6356514.86955 }, ///< E_CLARKE1880
{ 6378160., 6356774.719 } ///< E_GRS67
};
/**
......
......@@ -22,6 +22,12 @@
#include "Grid2DObject.h"
#include "IOUtils.h"
namespace mio {
#ifdef _POPC_
class DEMObjectDummy {}; //HACK for POPC
#endif
/**
* @class DEMObject
* @brief A class to represent DEMs: reads elevation grids, computes local slope, azimuth, curvature.
......@@ -29,10 +35,6 @@
* @author Gaël Rosset - Mathias Bavay
* @date 2009-07-20
*/
namespace mio {
class DEMObjectDummy {}; //HACK for POPC
class DEMObject : public Grid2DObject {
public:
Array2D<double> slope;
......
......@@ -31,6 +31,8 @@
///Using the following namespace for the comparison operator overloading
//using namespace rel_ops;
namespace mio {
/**
* @class Date
* @brief A class to handle timestamps.
......@@ -57,11 +59,10 @@
* @author Mathias Bavay
* @date 2010-04-15
*/
namespace mio {
#ifdef _POPC_
class DateDummy {}; //HACK for POPC
#ifdef _POPC_
class Date : POPBase {
public:
void Serialize(POPBuffer &buf, bool pack);
......
......@@ -32,6 +32,9 @@
#include <cstdlib>
#endif
namespace mio {
/**
* @class PluginObject
* @brief The PluginObject is an interface for all dynamically loadable Objects, its main task is to register a callback destructor function
......@@ -40,8 +43,6 @@
* @author Thomas Egger
* @date 2009-03-10
*/
namespace mio {
class PluginObject {
private:
// Callback function that should be called to delete dynamic object
......
......@@ -26,18 +26,18 @@
*
* @section filters_available Available filters
* The filters that are currently available are the following:
* - rate: rate of change filter, see FilterAlgorithms::RateFilter
* - min_max: range check filter, see FilterAlgorithms::MinMaxFilter
* - min: minimum check filter, see FilterAlgorithms::MinValueFilter
* - max: maximum check filter, see FilterAlgorithms::MaxValueFilter
* - mad: median absolute deviation, see FilterAlgorithms::MedianAbsoluteDeviationFilter
* - rate: rate of change filter, see mio::FilterAlgorithms::RateFilter
* - min_max: range check filter, see mio::FilterAlgorithms::MinMaxFilter
* - min: minimum check filter, see mio::FilterAlgorithms::MinValueFilter
* - max: maximum check filter, see mio::FilterAlgorithms::MaxValueFilter
* - mad: median absolute deviation, see mio::FilterAlgorithms::MedianAbsoluteDeviationFilter
*
* A few data transformations are also supported besides filtering:
* - accumulate: data accumulates over a given period, see FilterAlgorithms::AccumulateProcess
* - resample: linear data resampling, FilterAlgorithms::LinResamplingProcess
* - median_avg: running median average over a given window, see FilterAlgorithms::MedianAvgProcess
* - mean_avg: running mean average over a given window, see FilterAlgorithms::MeanAvgProcess
* - wind_avg: vector average over a given window, see FilterAlgorithms::WindAvgProcess
* - accumulate: data accumulates over a given period, see mio::FilterAlgorithms::AccumulateProcess
* - resample: linear data resampling, mio::FilterAlgorithms::LinResamplingProcess
* - median_avg: running median average over a given window, see mio::FilterAlgorithms::MedianAvgProcess
* - mean_avg: running mean average over a given window, see mio::FilterAlgorithms::MeanAvgProcess
* - wind_avg: vector average over a given window, see mio::FilterAlgorithms::WindAvgProcess
*/
using namespace std;
......
......@@ -31,14 +31,14 @@
#include <cmath>
#include <map>
namespace mio {
/**
* @class FilterAlgorithms
* @brief
* @author Thomas Egger
* @date 2009-11-03
*/
namespace mio {
class FilterAlgorithms {
public:
......
......@@ -23,6 +23,8 @@
#include "IOExceptions.h"
#include "Coords.h"
namespace mio {
/**
* @class Grid2DObject
* @brief A class to represent 2D Grids. Typical application as DEM or Landuse Model.
......@@ -30,11 +32,10 @@
* @author Thomas Egger
* @date 2008-12-20
*/
namespace mio {
#ifdef _POPC_
class Grid2DObjetctDummy {}; //HACK for POPC
#ifdef _POPC_
class Grid2DObject : POPBase {
public:
/**
......
......@@ -23,6 +23,8 @@
#include "IOExceptions.h"
#include "Coords.h"
namespace mio {
/**
* @class Grid3DObject
* @brief A class to represent 3D Grids. Typical application: wind field
......@@ -30,11 +32,10 @@
* @author Thomas Egger
* @date 2009-07-20
*/
namespace mio {
#ifdef _POPC_
class Grid3DObjetctDummy {}; //HACK for POPC
#ifdef _POPC_
class Grid3DObject : POPBase {
public:
void Serialize(POPBuffer &buf, bool pack);
......
......@@ -31,13 +31,14 @@
#define TOSTRING(x) STRINGIFY(x)
#define AT __FILE__ ":" TOSTRING(__LINE__)
namespace mio {
/**
* @class IOException
* @brief The basic exception class adjusted for the needs of SLF software
*
* @author Thomas Egger
*/
namespace mio {
#ifdef _POPC_
class IOException : public POPException {
......
......@@ -36,7 +36,7 @@ typedef std::map<std::string, IOPlugin::IOPlugin>::iterator PLUGIN_ITERATOR;
/**
* @file IOHandler.h
* The is the class implementing the interface as defined by the IOInterface class.
* The is the class implementing the interface as defined by the mio::IOInterface class.
* This class is responsible for loading the necessary plugins and getting the data through them.
*/
......
......@@ -29,6 +29,8 @@
#include <vector>
namespace mio {
/**
* @page dev_plugins Plugins developement guide
* The data access is handled by a system of plugins. They all offer the same interface, meaning that a plugin can transparently be replaced by another one. This means that plugins should follow some common rules, which are described in this guide.
......@@ -62,7 +64,6 @@
* The internal documentation of the plugin can remain as normal C++ comments (since they are addressed to the maintainer of the plugin).
*/
/**
* @class IOInterface
* @brief An abstract class representing the IO Layer of the software Alpine3D. For each type of IO (File, DB, Webservice, etc)
......@@ -72,8 +73,6 @@
* @author Thomas Egger
* @date 2009-01-08
*/
namespace mio {
class IOInterface : public PluginObject {
public:
......
......@@ -21,6 +21,8 @@
#include "DynamicLibrary.h"
#include "IOInterface.h"
namespace mio {
/**
* @class IOPlugin
* @brief A helper class representing a MeteoIO plugin in the context of the dynamic loading as implemented in class
......@@ -32,8 +34,6 @@
* @author Thomas Egger
* @date 2009-08-11
*/
namespace mio {
class IOPlugin {
public:
std::string libname; ///< A string representing the file to be loaded, e.g. "libgeotopio.so", can be empty
......
......@@ -26,6 +26,8 @@
#include <vector>
#include <map>
namespace mio {
/**
* @class Meteo2DInterpolator
* @brief A class to spatially interpolate meteo parameters. For more, see \ref interpol2d
......@@ -33,7 +35,6 @@
* @author Mathias Bavay and Thomas Egger
* @date 2010-01-14
*/
namespace mio {
#ifdef _POPC_
class Meteo2DInterpolator : POPBase {
......
......@@ -24,6 +24,8 @@
#include <sstream>
#include <iomanip>
namespace mio {
/**
* @class MeteoData
* @brief A class to represent a singular measurement received from one station at a certain time (represented by the Date object)
......@@ -31,7 +33,6 @@
* @author Thomas Egger
* @date 2008-12-05
*/
namespace mio {
#ifdef _POPC_
class MeteoData : POPBase {
......
......@@ -28,13 +28,14 @@
#include <string>
#include <vector>
namespace mio {
/**
* @class MeteoFilter
* @brief A class that can filter (i.e. clean, resample, ...) MeteoData objects
* @author Thomas Egger
* @date 2009-11-01
*/
namespace mio {
class MeteoFilter {
public:
......
......@@ -24,6 +24,8 @@
#include <sstream>
#include <iomanip>
namespace mio {
/**
* @class StationData
* @brief A class to represent meteo stations with attributes like longitude, latitude, etc.
......@@ -31,7 +33,6 @@
* @author Thomas Egger
* @date 2008-11-29
*/
namespace mio {
#ifdef _POPC_
class StationData :POPBase {
......
......@@ -32,6 +32,8 @@
#define GRAVITY 9.80665 // (m s-2)
#define GAS_CONSTANT_AIR 287. // (J kg-1 K-1)
namespace mio {
/**
* @class Interpol2D
* @brief A class to perform 2D spatial interpolations.
......@@ -44,8 +46,6 @@
typedef double (*LapseRateProjectPtr)(const double& value, const double& altitude,
const double& new_altitude, const std::vector<double>& coeffs);
namespace mio {
class Interpol2D {
public:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment