Configurable.h

Go to the documentation of this file.

/********************************************************************
**                Image Component Library (ICL)                    **
**                                                                 **
** Copyright (C) 2006-2013 CITEC, University of Bielefeld          **
**                         Neuroinformatics Group                  **
** Website: www.iclcv.org and                                      **
**          http://opensource.cit-ec.de/projects/icl               **
**                                                                 **
** File   : ICLUtils/src/ICLUtils/Configurable.h                   **
** Module : ICLUtils                                               **
** Authors: Christof Elbrechter                                    **
**                                                                 **
**                                                                 **
** GNU LESSER GENERAL PUBLIC LICENSE                               **
** This file may be used under the terms of the GNU Lesser General **
** Public License version 3.0 as published by the                  **
**                                                                 **
** Free Software Foundation and appearing in the file LICENSE.LGPL **
** included in the packaging of this file.  Please review the      **
** following information to ensure the license requirements will   **
** be met: http://www.gnu.org/licenses/lgpl-3.0.txt                **
**                                                                 **
** The development of this software was supported by the           **
** Excellence Cluster EXC 277 Cognitive Interaction Technology.    **
** The Excellence Cluster EXC 277 is a grant of the Deutsche       **
** Forschungsgemeinschaft (DFG) in the context of the German       **
** Excellence Initiative.                                          **
**                                                                 **
********************************************************************/

#pragma once

#include <ICLUtils/CompatMacros.h>
#include <ICLUtils/Exception.h>
#include <ICLUtils/SmartPtr.h>
#include <ICLUtils/Any.h>
#include <ICLUtils/Function.h>
#include <ICLUtils/UncopiedInstance.h>
#include <ICLUtils/Mutex.h>

#include <vector>
#include <string>
#include <algorithm>
#include <map>

namespace icl{
  namespace utils{
  

    class ICLUtils_API Configurable{
      public:
      struct Property{
        Property():configurable(0),volatileness(0){}
        Property(Configurable *parent,
                 const std::string &name, const std::string &type, const std::string &info, const std::string &value,
                 int volatileness, const std::string &tooltip):configurable(parent),name(name),type(type),info(info),value(value),
          volatileness(volatileness), tooltip(tooltip){}
        Configurable *configurable; 
        std::string name;  
        std::string type;  
        std::string info;  
        std::string value; 
        int volatileness;  
        std::string tooltip; 
        std::string childPrefix;
        bool operator==(const std::string &name) const { return this->name == name; }
      };
  
      private:
      
      typedef std::map<std::string,Property> PropertyMap;
  
      PropertyMap m_properties;

      bool m_isOrdered;
      std::map<int,std::string> m_ordering;

      std::map<const Configurable*, std::string> m_childConfigurables;

      Configurable* m_elderConfigurable;
      
      std::string m_ID;
  
      static std::map<std::string,Configurable*> m_instances;
      
      std::vector<std::string> m_deactivated;
  

      mutable UncopiedInstance<Mutex> m_mutex;

      protected:
      

      void addProperty(const std::string &name, const std::string &type, 
                       const std::string &info, const Any &value=Any(), 
                       const int volatileness=0, const std::string &tooltip=std::string()) throw (ICLException);
      

      void addChildConfigurable(Configurable *configurable, const std::string &childPrefix="");
      
      void removeChildConfigurable(Configurable *configurable);
      

      Property &prop(const std::string &propertyName) throw (ICLException);
  

      const Property &prop(const std::string &propertyName) const throw (ICLException);
      

      Configurable(const std::string &ID="", bool ordered=true) throw (ICLException);
      
      public:
      
      virtual ~Configurable(){}
  

      Configurable(const Configurable &other);
      

      Configurable &operator=(const Configurable &other);
  

      void setConfigurableID(const std::string &ID) throw (ICLException);
      
      inline const std::string &getConfigurableID() const{
        return m_ID;
      }
  

      void deactivateProperty(const std::string &pattern);
  

      void deleteDeactivationPattern(const std::string &pattern);
      
      std::vector<std::string> getPropertyListWithoutDeactivated() const;
  

      virtual void adaptProperty(const std::string &name, const std::string &newType, 
                                 const std::string &newInfo, const std::string &newToolTip) throw (ICLException);
  
  

      static std::string create_default_ID(const std::string &prefix);
  
  
      typedef Function<void,const Property&> Callback;
      
      void registerCallback(const Callback &cb){
        callbacks.push_back(cb);
      }
      
      void removedCallback(const Callback &cb);
  

      void syncChangesTo(Configurable *others, int num=1);
      
      protected:
      std::vector<Callback> callbacks;
  

      void call_callbacks(const std::string &propertyName,const Configurable* caller) const;
  
      public:
  
      static const std::vector<std::string> EMPTY_VEC;
      

      static Configurable* get(const std::string &id);
      
      

      virtual void setPropertyValue(const std::string &propertyName, const Any &value) throw (ICLException);
      

      virtual std::vector<std::string> getPropertyList() const;
       

      virtual bool supportsProperty(const std::string &propertyName) const;
       

      virtual void saveProperties(const std::string &filename, const std::vector<std::string> &propertiesToSkip=EMPTY_VEC) const;
  

      virtual void loadProperties(const std::string &filename,const std::vector<std::string> &propertiesToSkip=EMPTY_VEC);
  

      virtual std::string getPropertyType(const std::string &propertyName) const{
        return prop(propertyName).type;
      }
       

      virtual std::string getPropertyInfo(const std::string &propertyName) const{
        return prop(propertyName).info;
      }
  

      virtual Any getPropertyValue(const std::string &propertyName) const;
      
      virtual std::string getPropertyToolTip(const std::string &propertyName) const{
        return prop(propertyName).tooltip;
      }
  

      virtual int getPropertyVolatileness(const std::string &propertyName) const{
        return prop(propertyName).volatileness;
      }
      

      static void register_configurable_type(const std::string &classname, Function<Configurable*> creator) throw (ICLException);
      

      static std::vector<std::string> get_registered_configurables();
      

      static Configurable *create_configurable(const std::string &classname) throw (ICLException);
    };
  

  #define REGISTER_CONFIGURABLE(NAME,CREATE)                              \
    struct StaticConfigurableRegistrationFor_##NAME{ \
      typedef StaticConfigurableRegistrationFor_##NAME This;              \
      static Configurable *create(){                                      \
        CREATE;                                                           \
      }                                                                   \
      StaticConfigurableRegistrationFor_##NAME(){                         \
        Configurable::register_configurable_type(#NAME, &This::create);   \
      }                                                                   \
    } staticConfigurableRegistrationFor_##NAME;
  
    

  #define REGISTER_CONFIGURABLE_DEFAULT(NAME) REGISTER_CONFIGURABLE(NAME,return new NAME)
    
  } // namespace utils
}