embeddable.h

Go to the documentation of this file.

// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//

#ifndef BALL_CONCEPT_EMBEDDABLE_H
#define BALL_CONCEPT_EMBEDDABLE_H

#ifndef BALL_COMMON_H
# include <BALL/common.h>
#endif

#ifndef BALL_DATATYPE_STRINGHASHMAP_H
# include <BALL/DATATYPE/stringHashMap.h>
#endif

#ifndef BALL_DATATYPE_HASHMAP_H
# include <BALL/DATATYPE/hashMap.h>
#endif

#include <typeinfo>

namespace BALL 
{

  #define BALL_EMBEDDABLE(TYPE,BASE)\
    virtual void registerThis()  \
    { \
      if (typeid(*this) != typeid(TYPE))\
      {\
        Log.error() << "Warning: derived class " << typeid(*this).name() << " was derived from BALL::Embeddable, but the macro\n"\
                  << "BALL_EMBEDDABLE(...) was not specified in the class declaration!" << std::endl;\
      }\
      Embeddable::registerInstance_(typeid(TYPE), this);\
      Embeddable::registerInstance_(typeid(BASE), this);\
    }\
    \
    static TYPE* getInstance(Position index)  \
    { \
      Embeddable* ptr = Embeddable::getInstance_(typeid(TYPE), index);\
      if (ptr != 0)\
      {\
        return dynamic_cast<TYPE*>(ptr); \
      }\
      else\
      {\
        return 0;\
      }\
    }\
    static TYPE* getInstance(const String& identifier) \
    {\
      Embeddable* ptr = Embeddable::getInstance_(typeid(TYPE), identifier);\
      if (ptr != 0)\
      {\
        return dynamic_cast<TYPE*>(ptr); \
      }\
      else\
      {\
        return 0;\
      }\
    }\
    static Size countInstances()  { return (Embeddable::countInstances_(typeid(TYPE))); };
  
  class BALL_EXPORT Embeddable
  {
    public:

    typedef std::vector<Embeddable*> EmbeddableVector;


    Embeddable(const String& identifier = "<Embeddable>")
      ;
    
    Embeddable(const Embeddable& embeddable)
      ;
    
    virtual ~Embeddable()
      ;


    void setIdentifier(const String& identifier)
      ;

    const String& getIdentifier() const
      ;

    void unregisterThis()
      ;

    virtual void registerThis()
      ; 

    
    virtual void dump(std::ostream& s = std::cout, Size depth = 0) const
      ;

    protected:
    static void registerInstance_(const std::type_info& type, const Embeddable* instance)
      ;
    static void unregisterInstance_(const Embeddable* instance)
      ;
    
    static Size countInstances_(const std::type_info& type)
      ;

    static Embeddable* getInstance_(const std::type_info& type, Position index)
      ;

    static Embeddable* getInstance_(const std::type_info& type, const String& identifier)
      ;


    private:
    
    String  identifier_;

    static StringHashMap<EmbeddableVector>  instance_vectors_;

    static HashMap<Embeddable*, string>   instance_to_type_map_;
  };

} // namespace BALL

#endif // BALL_CONCEPT_EMBEDDABLE_H