Globals.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 Globals.h
   
  \brief A singleton class with global definitions.
 */

#ifndef __TERRALIB_XERCES_INTERNAL_GLOBALS_H
#define __TERRALIB_XERCES_INTERNAL_GLOBALS_H

// TerraLib
#include "../common/Singleton.h"
#include "Config.h"

// STL
#include <string>

namespace te
{
  namespace xerces
  {
    /*!
      \class Globals

      \brief A singleton class with global definitions.
     */
    class TEXERCESEXPORT Globals : public te::common::Singleton<Globals>
    {
      friend class te::common::Singleton<Globals>;

      public:

        /*!
          \brief It returns the OGR driver identifier.

          \return The OGR driver identifier.
         */
        const std::string& getDriverID() const 
        {
          return m_driverIdentifier;
        }

        /* \brief Destructor. */
        ~Globals();

      protected:

        /*! \brief The singleton constructor is not callable outside the class. */
        Globals();

      private:

        const std::string m_driverIdentifier;  //!< The Xerces driver identifier.
    };

  } // end namespace xerces
}   // end namespace te

#endif  // __TERRALIB_XERCES_INTERNAL_GLOBALS_H