core/GeoRasterValue.hpp

Go to the documentation of this file.

/*

  This file is part of OpenFLUID software
  Copyright(c) 2007, INRA - Montpellier SupAgro


 == GNU General Public License Usage ==

  OpenFLUID is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  OpenFLUID is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OpenFLUID. If not, see <http://www.gnu.org/licenses/>.


 == Other Usage ==

  Other Usage means a use of OpenFLUID that is inconsistent with the GPL
  license, and requires a written agreement between You and INRA.
  Licensees for Other Usage of OpenFLUID may use this file in accordance
  with the terms contained in the written agreement between You and INRA.
  
*/

/**
 \file GeoRasterValue.hpp
 \brief Header of ...

 \author Aline LIBRES <libres@supagro.inra.fr>
 */

#ifndef __GEORASTERVALUE_HPP__
#define __GEORASTERVALUE_HPP__

#include <openfluid/core/GeoValue.hpp>
#include <openfluid/dllexport.hpp>

#include "gdal_priv.h"
#include "cpl_conv.h" // for CPLMalloc()

namespace openfluid {
namespace core {

/**
 * @brief Container class for geospatial raster data,
 * represented by a GDAL dataset.
 */
class DLLEXPORT GeoRasterValue: public openfluid::core::GeoValue
{

  protected:

    /**
     * @brief The GDALDataset associated to this GeoRasterValue.
     */
    GDALDataset* mp_Data;

    /**
     * @brief Open the GDALDataset of this GeoRasterValue.
     * @throw openfluid::base::OFException if GDAL doesn't succeed to open the datasource.
     *
     */
    void tryToOpenSource();

  public:

    /**
     * @brief Creates a new value.
     *
     * The <tt>FileName</tt> may be the name of a .jpeg, .tiff, .img or .asc file...
     *
     * It doesn't open the associated GDAL dataset.
     *
     * @param FilePath The path of the file(s).
     * @param FileName The name or the relative path of the file to open.
     */
    GeoRasterValue(std::string FilePath, std::string FileName);

    /**
     * @brief Closes the opened GDAL dataset.
     */
    ~GeoRasterValue();

    /**
     * @brief Returns the type of this GeoRasterValue.
     * @return An openfluid::core::UnstructuredValue::UnstructuredType.
     */
    openfluid::core::UnstructuredValue::UnstructuredType getType() const;

    /**
     * @brief Gets the associated opened GDAL dataset in read-only access.
     *
     * If the dataset is not already opened, tries to open it first.
     *
     * @return The opened GDAL dataset.
     * @throw openfluid::base::OFException if GDAL doesn't succeed to open the dataset.
     */
    GDALDataset* get();

    /**
     * @brief Returns the absolute Path of this GeoRasterValue.
     *
     */
    std::string getAbsolutePath();
};

}
} // namespaces
#endif /* __GEORASTERVALUE_HPP__ */