AlgorithmFactory.hh

Go to the documentation of this file.

#ifndef _ALGORITHM_FACTORYHH_
#define _ALGORITHM_FACTORYHH_

#include <openmodeller/os_specific.hh>
#include <openmodeller/AlgMetadata.hh>
#include <openmodeller/Sampler.hh>
#include <openmodeller/Algorithm.hh>

#include <openmodeller/Configuration.hh>

#include <string>
#include <list>

class AlgParameter;

/****************************************************************/
/*********************** Algorithm Factory **********************/

class dllexp AlgorithmFactory
{

public:

  ~AlgorithmFactory();

  static void setDefaultAlgDir( std::string const dir );

  static std::string getDefaultAlgDir();

  static int searchDefaultDirs();

  static int addDir( const std::string& dirs );

  static bool addDll( const std::string& file );

  static AlgMetadata const**availableAlgorithms();

  static int numAvailableAlgorithms();

  static AlgMetadata const *algorithmMetadata( std::string const algorithm_id );

  static AlgorithmPtr newAlgorithm( std::string const id );

  static AlgorithmPtr newAlgorithm( const ConstConfigurationPtr& );

  /*
   * Method to serialize the available algorithms
   *
   * Note that this class does not implement "Configurable" 
   * because it cannot be instantiated from outside (singleton 
   * pattern). Also the counterpart setConfiguration method is not
   * implemented in this case because it makes no sense to load
   * algorithms from XML - they can only be dynamically loaded
   * from the respective libraries.
   */
  static ConfigurationPtr getConfiguration();

  static std::string const getCurrentId( std::string const algorithm_id );

private:

  AlgorithmFactory();

  static AlgorithmFactory& getInstance();

  // Default directory to search for algorithms
  std::string _default_alg_dir;

  friend class testDLLId;
  class DLL;
  typedef ReferenceCountedPointer<DLL> DLLPtr;
  typedef std::list<DLLPtr> ListDLL;
  typedef std::list<std::string> PluginPath;

  ListDLL _dlls;
  PluginPath _pluginpath;

  int p_addDir( const std::string& dir );

  bool p_addDll( const std::string& file );

  class DLL : private ReferenceCountedObject
  {
    friend class ReferenceCountedPointer<DLL>;
  public:
    DLL();
    DLL( const std::string& file );
    ~DLL();

    operator bool() const;

    AlgorithmPtr newAlgorithm();

    AlgMetadata const *getMetadata();

  private:
    DLLHandle _handle;
    TAlgFactory _factory;
    TAlgMetadata _metadata;
    std::string _file;
  };


};


#endif