PreAlgorithm.hh

Go to the documentation of this file.

#ifndef PRE_ALGORITHM_HH
  #define PRE_ALGORITHM_HH

  #include <openmodeller/om.hh>
  #include "PreParameters.hh"
  #include <map>

 // adapted from Terralib PDI (Digital Image Processing) to OM Pre-analysis (Missae & Emiliano - DPI/INPE)
  class dllexp PreAlgorithm
  {
    public :

      //Default Destructor
      virtual ~PreAlgorithm();

      //return a default object.
      static PreAlgorithm* DefaultObject( const PreParameters& params )
    {throw;};

      virtual string getDescription() const = 0;

      bool apply();

      bool reset( const PreParameters& params );

       void resetState( PreParameters& params );
 
      virtual bool checkParameters( const PreParameters& parameters ) const = 0;

      //Returns a reference to the current internal parameters.
      const PreParameters& getParameters() const;

      //get input information
      typedef std::map<string, string> stringMap;
      virtual void getAcceptedParameters( stringMap& info) = 0;

      //get output information
      virtual void getLayersetResultSpec ( stringMap& info) = 0;
     
      //get output information for each layer
      virtual void getLayerResultSpec ( stringMap& info) = 0;
      
      void getLayerResult( const string layer_id, PreParameters& result );

    protected :

      //Internal parameters reference
      mutable PreParameters params_;

      // Layer id => PreParams obj whose keys can be discovered by calling getLayerResultSpec
      mutable std::map<string, PreParameters> result_by_layer_;

      //Default Constructor
      PreAlgorithm();

      virtual bool runImplementation() = 0;

      bool checkInternalParameters() const;
      
    private :
    
      PreAlgorithm( const PreAlgorithm& );
    
      const PreAlgorithm& operator=( const PreAlgorithm& external );
  };

#endif //PREALGORITHM_HPP