stepInterface.h

Go to the documentation of this file.

/* -*- Mode: c++ -*- */
/*
 *  this is part of Spm
 *
 *  Copyright (c) 2005 Guillaume Chevallereau
 *
 *  This program is free software. You can redistribute it and/or modify it 
 *  under the terms of the GNU General Public License as published by the 
 *  Free Software Foundation. Either version 2 of the license or (at your 
 *  option) any later version.
 *
 *  This program is distributed in the hope that it will be usefull but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for 
 *  more details.
 *
 *  You should have received a copy of the GNU General Public License along 
 *  with this program; if not, write to the Free Software Foundation, Inc., 
 *  59 Temple Place - Suite 330, Boston, MA  02111-1307, USA
 */
#ifndef __STEP_INTERFACE_H__
#define __STEP_INTERFACE_H__

#include "interface.h"
#include <list>
#include <util/def.h>
#include <boost/filesystem/path.hpp>
#include <util/utilException.h>

#define SPM_STEP_PLUGIN(plugin)                 \
  extern "C"                                    \
  {                                                           \
    Spm::Plugin::pluginDescription_t getSpmPluginDescription () \
    {                                                           \
      return plugin ().getDescription ();               \
    }                                                           \
                                                                        \
    plugin * getSpmPlugin (const Spm::Util::PropertyList & pOptions)    \
    {                                                                   \
      return new plugin (pOptions);                                     \
    }                                                                   \
                                                                        \
    plugin * getSpmPluginInfo ()                                        \
    {                                                                   \
      return new plugin ();                                             \
    }                                                                   \
  }

namespace Spm
{
  namespace Plugin
  {
    class InstallException : public Exception
    {
    protected:
      InstallException ()
      {
      }

    public :
      InstallException (const miniXml::ustring & msg)
      {
        errMsg_ = msg;
      }
    };    

    class StepInterface : public Interface
    {
    protected :
      miniXml::ustring stepDescription_;
      double fractionDone_;
      std::map<miniXml::ustring,
               miniXml::ustring> __usedOptions;

      StepInterface (const Util::PropertyList & pList) : Interface (pList)
      {
        fractionDone_ = -1;
      }
      
      StepInterface ()
      {
        fractionDone_ = -1;
      }

    public :
      virtual ~StepInterface (){};
      virtual void run (const boost::filesystem::path & dir) = 0;

      const miniXml::ustring & getStepDescription ()
      {
        return stepDescription_;
      }

      const miniXml::ustring & getStepDescription () const
      {
        return stepDescription_;
      }

      virtual double getFractionDone ()
      {
        return fractionDone_;
      }
      
      virtual double getFractionDone () const
      {
        return fractionDone_;
      }

      bool handle (const miniXml::ustring & uri)
      {
        return true;
      }

      const std::map<miniXml::ustring,
                     miniXml::ustring> & getOptions ()
      {
        return __usedOptions;
      }
      
      virtual std::list<boost::filesystem::path> getListOfFiles () = 0;
    };
  }
}

#endif

---