Module.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/ws/ogc/wcs/dataaccess/Module.h

  \brief The TerraLib OGC WCS driver as a plugin.

    \author Vinicius Campanha
*/

#ifndef __TERRALIB_OGC_WCS_INTERNAL_MODULE_H
#define __TERRALIB_OGC_WCS_INTERNAL_MODULE_H

// TerraLib
#include "../../../../core/plugin/CppPlugin.h"
#include "Config.h"

namespace te
{
  namespace ws
  {
    namespace ogc
    {
      namespace wcs
      {
        namespace da
        {
          /*!
            \class Module

            \brief The TerraLib OGC WCS driver as a plugin.
          */
          class TEOGCWCSDATAACCESSEXPORT Module : public te::core::CppPlugin
          {
          public:

            /*!
              \brief Plugin constructor.

              \param pInfo Basic information provided to initialize this module through the plugin API.
            */
            Module(const te::core::PluginInfo& pluginInfo);

            /*! \brief Destructor. */
            ~Module();

            //@}

              /** @name Re-Implmentation from Plugin Interface
              *  Re-Implementation from Plugin Interface.
              */
            //@{

            /*!
              \brief This method will be called by TerraLib to startup some plugin's functionality.

              \exception Exception It throws an exception if the plugin can not be started.
            */
            void startup();

            /*!
              \brief This method will be called by TerraLib to shutdown plugin's functionality.

              \exception Exception It throws an exception if the plugin can not be shutdown.
            */
            void shutdown();

            //@}
          };
        }
      } // end namespace wcs
    }
  }
}   // end namespace te

#endif  // __TERRALIB_OGC_WCS_INTERNAL_MODULE_H