Containerize.h

Go to the documentation of this file.

#ifndef  _GAMS_UTILITY_CONTAINERIZE_H_
#define  _GAMS_UTILITY_CONTAINERIZE_H_

#include "gams/GamsExport.h"

#include <string>

#include "madara/knowledge/KnowledgeBase.h"

namespace gams
{
  namespace utility
  {
    class GAMS_EXPORT Containerize
    {
    public:
      Containerize (const std::string& n = "");

      virtual ~Containerize ();

      std::string get_name () const;

      void set_name (const std::string& n);

      void set_knowledge_base (madara::knowledge::KnowledgeBase* kb);

      void modify();

      void to_container (const std::string& name = "");

      void to_container (madara::knowledge::KnowledgeBase& kb, 
        const std::string& name = "");

      bool from_container (const std::string& name = "");

      bool from_container (
        madara::knowledge::KnowledgeBase& kb, 
        const std::string& name = "");

    protected:
      const static std::string object_type_suffix_;

      std::string name_;

      madara::knowledge::KnowledgeBase* prev_kb_;

      enum Class_ID
      {
        REGION_TYPE_ID                  = 0x00000001,
        PRIORITIZED_REGION_TYPE_ID      = 0x00000002,
        SEARCH_AREA_TYPE_ID             = 0x00000004,
        INVALID                         = 0x80000000,
      };

      bool is_valid_type (madara::knowledge::KnowledgeBase& kb,
        const std::string& name, const Class_ID& expected) const;

      static Class_ID get_type (madara::knowledge::KnowledgeBase& kb,
        const std::string& name);

    private:
      virtual bool check_valid_type (
        madara::knowledge::KnowledgeBase& kb,
        const std::string& name) const = 0;

      virtual void to_container_impl (
        madara::knowledge::KnowledgeBase& kb, 
        const std::string& name) = 0;

      virtual bool from_container_impl (
        madara::knowledge::KnowledgeBase& kb, 
        const std::string& name) = 0;
    };
  }
}

#endif // _GAMS_UTILITY_CONTAINERIZE_H_