DataSet.h

Go to the documentation of this file.

/*  Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.

    This file is part of the TerraLib - a Framework for building GIS enabled applications.

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

    TerraLib 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with TerraLib. See COPYING. If not, write to
    TerraLib Team at <terralib-team@terralib.org>.
 */

/*!
 \file terralib/dataaccess/gdal/DataSet.h

 \brief Implementation of a DataSet for GDAL data provider.
 */

#ifndef __TERRALIB_DATAACCES_GDAL_INTERNAL_DATASET_H
#define __TERRALIB_DATAACCES_GDAL_INTERNAL_DATASET_H

// TerraLib
#include "../dataaccess/dataset/DataSet.h"
#include "../dataaccess/dataset/DataSetType.h"
#include "Config.h"


// STL
#include <map>
#include <memory>
#include <string>
#include <vector>

namespace te
{
  namespace gdal
  {
    /*!
     \class DataSet

     \brief A GDAL data set gives access to a raster file.
     */
    class TEGDALEXPORT DataSet : public te::da::DataSet
    {
    public:

      /*!
       \brief Constructor.
       \param dt     The dataset type. DataSet will take its ownership.
       \param rwRole The access policy of the dataset.
       */
      DataSet(std::auto_ptr<te::da::DataSetType> dt, te::common::AccessPolicy rwRole, std::string uri="");

      /*! \brief Destructor. */
      virtual ~DataSet();

      te::common::TraverseType getTraverseType() const { return te::common::FORWARDONLY; }

      te::common::AccessPolicy getAccessPolicy() const { return m_rwRole; }

      std::auto_ptr<te::gm::Envelope> getExtent(std::size_t i);

      std::size_t getNumProperties() const;

      int getPropertyDataType(std::size_t pos) const;

      std::string getPropertyName(std::size_t pos) const;

      std::string getDatasetNameOfProperty(std::size_t pos) const;

      bool isEmpty() const { return false; }

      std::size_t size() const { return 1; }

      bool moveNext();
      bool movePrevious();
      bool moveBeforeFirst();
      bool moveFirst();
      bool moveLast();
      bool move(std::size_t i);

      bool isAtBegin() const;
      bool isBeforeBegin() const;
      bool isAtEnd() const;
      bool isAfterEnd() const;

      char getChar(std::size_t /*i*/) const { return '\0'; }
      char getChar(const std::string& /*name*/) const { return '\0'; }

      unsigned char getUChar(std::size_t /*i*/) const { return 0; }
      unsigned char getUChar(const std::string& /*name*/) const { return 0; }

      boost::int16_t getInt16(std::size_t /*i*/) const { return 0; }
      boost::int16_t getInt16(const std::string& /*name*/) const { return 0; }

      boost::int32_t getInt32(std::size_t /*i*/) const { return 0; }
      boost::int32_t getInt32(const std::string& /*name*/) const { return 0; }

      boost::int64_t getInt64(std::size_t /*i*/) const { return 0; }
      boost::int64_t getInt64(const std::string& /*name*/) const { return 0; }

      bool getBool(std::size_t /*i*/) const { return false; }
      bool getBool(const std::string& /*name*/) const { return false; }

      float getFloat(std::size_t /*i*/) const { return 0.0; }
      float getFloat(const std::string& /*name*/) const {return 0.0; }

      double getDouble(std::size_t /*i*/) const { return 0.0; }
      double getDouble(const std::string& /*name*/) const { return 0.0; }

      std::string getNumeric(std::size_t /*i*/) const { return ""; }
      std::string getNumeric(const std::string& /*name*/) const { return ""; }

      std::string getString(std::size_t /*i*/) const { return ""; }
      std::string getString(const std::string& /*name*/) const { return ""; }

      std::auto_ptr<te::dt::ByteArray> getByteArray(std::size_t /*i*/) const
        { return std::auto_ptr<te::dt::ByteArray>(0); }

      std::auto_ptr<te::dt::ByteArray> getByteArray(const std::string& /*name*/) const
        { return std::auto_ptr<te::dt::ByteArray>(0); }

      std::auto_ptr<te::gm::Geometry> getGeometry(std::size_t /*i*/) const
        { return std::auto_ptr<te::gm::Geometry>(0); }

      std::auto_ptr<te::gm::Geometry> getGeometry(const std::string& /*name*/) const
        { return std::auto_ptr<te::gm::Geometry>(0); }

      std::auto_ptr<te::rst::Raster> getRaster(std::size_t i) const;

      std::auto_ptr<te::rst::Raster> getRaster(const std::string& name) const;

      std::auto_ptr<te::dt::DateTime> getDateTime(std::size_t /*i*/) const
        { return std::auto_ptr<te::dt::DateTime>(0); }

      std::auto_ptr<te::dt::DateTime> getDateTime(const std::string& /*name*/) const
        { return std::auto_ptr<te::dt::DateTime>(0); }

      std::auto_ptr<te::dt::Array> getArray(std::size_t /*i*/) const
        { return std::auto_ptr<te::dt::Array>(0); }

      std::auto_ptr<te::dt::Array> getArray(const std::string& /*name*/) const
        { return std::auto_ptr<te::dt::Array>(0); }

      bool isNull(std::size_t i) const { return i != 0; }

      bool isNull(const std::string& /*name*/) const { return true; }

      void setURI(const std::string& uri);

      bool isConnected() const { return false; }

    private:

      void loadTypeInfo();

    private:

      std::auto_ptr<te::da::DataSetType> m_dsType;        //!< It describes the dataset.
      std::string m_uri;
      te::common::AccessPolicy m_rwRole;    //!< Access role.
      int m_size;                           //!< For GDAL driver this will be constant: 1.
      int m_i;                              //!< Just to indicate the internal pointer movement.
    };

    typedef boost::shared_ptr<DataSet> DataSetPtr;
  } // end namespace gdal
}   // end namespace te

#endif  // __TERRALIB_GDAL_INTERNAL_DATASET_H