EnumScaleType.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 EnumTemplateType.h
   
  \brief Class to represent a scale type enumeration. Ex.: hollow scale bar, etc.

  \ingroup layout
*/

#ifndef __TERRALIB_LAYOUT_INTERNAL_ENUM_SCALE_TYPE_H 
#define __TERRALIB_LAYOUT_INTERNAL_ENUM_SCALE_TYPE_H

// TerraLib
#include "AbstractEnum.h"
#include "../Config.h"

namespace te
{
  namespace layout
  {
    class EnumType;

    /*!
      \brief Class to represent a scale type enumeration. Ex.: hollow scale bar, etc.
    
      \ingroup layout

      \sa te::layout::AbstractEnum
    */
    class TELAYOUTEXPORT EnumScaleType : public AbstractEnum
    {
      public:

        /*!
          \brief Constructor
        */
        EnumScaleType(); 

        /*!
          \brief Destructor
        */ 
        virtual ~EnumScaleType();

        /*!
          \brief Returns value that represents none type belonging to enumeration.
      
          \return enum value      
        */
        virtual EnumType* getNoneType() const;
        
        /*!
          \brief Returns value that represents alternating scale bar type belonging to enumeration.
      
          \return enum value      
        */
        virtual EnumType* getAlternatingScaleBarType() const;

        /*!
          \brief Returns value that represents double alternating scale bar type belonging to enumeration.
      
          \return enum value      
        */
        virtual EnumType* getDoubleAlternatingScaleBarType() const;

        /*!
          \brief Returns value that represents hollow scale bar type belonging to enumeration.
      
          \return enum value      
        */
        virtual EnumType* getHollowScaleBarType() const;

      protected:

        /*!
          \brief Reimplemented from AbstractEnum
        */
        virtual void init();

      protected:

        EnumType* m_noneType; //!< value that represents none type belonging to enumeration
        EnumType* m_alternatingScaleBarType; //!< value that represents json type belonging to enumeration
        EnumType* m_doubleAlternatingScaleBarType; //!< value that represents json type belonging to enumeration
        EnumType* m_hollowScaleBarType; //!< value that represents json type belonging to enumeration
    };
  }
}

#endif