MapItem.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/se/MapItem.h
 
  \brief 
*/
 
#ifndef __TERRALIB_SE_INTERNAL_MAPITEM_H
#define __TERRALIB_SE_INTERNAL_MAPITEM_H
 
// TerraLib
#include "../fe/Expression.h"
#include "Config.h"
 
// STL
#include <string>
 
namespace te
{
  namespace se
  {
// Forward declaration
    class ParameterValue;
 
    /*!
      \class MapItem
      
      \brief 
 
      \sa te::fe::Expression, ParameterValue, Recode
    */
    class TESEEXPORT MapItem : public te::fe::Expression
    {
      public:
 
        /** @name Initializer Methods
         *  Methods related to instantiation and destruction.
         */
        //@{
 
        /*! \brief It initializes a new MapItem. */
        MapItem();
 
        /*! \brief Destructor. */
        ~MapItem();
 
        //@}
 
        /*!
        \brief It returns a clone of this object.
 
        \return A clone of this object.
        */
        virtual MapItem* clone() const;
 
        /*!
        \brief No copy constructor allowed.
 
        \param rhs The other MapItem.
        */
        MapItem(const MapItem& rhs);
 
        /** @name Accessor methods
         *  Methods used to get or set properties.
         */
        //@{
 
        double getData() const;
        
        void setData(const double& d);
 
        ParameterValue* getValue() const;
 
        void setValue(ParameterValue* v);
 
        std::string getTitle() const;
 
        void setTitle(const std::string& title);
 
        //@}
 
      private:
 
        /** @name Not Allowed Methods
         *  No copy allowed. 
         */
        //@{
 
        /*!
          \brief No assignment operator allowed.
 
          \param rhs The other MapItem.
 
          \return A reference for this.
        */
        MapItem& operator=(const MapItem& rhs);
 
        //@}
 
      private:
 
        double m_data;             //!< Mandatory.
        ParameterValue* m_value;   //!< Mandatory. 
        std::string m_title;
    };
 
  } // end namespace se
}   // end namespace te
 
#endif  // __TERRALIB_SE_INTERNAL_MAPITEM_H