Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/lib/lang/base_object.h @ 9912

Last change on this file since 9912 was 9869, checked in by bensch, 18 years ago

orxonox/trunk: merged the new_class_id branche back to the trunk.
merged with command:
svn merge https://svn.orxonox.net/orxonox/branches/new_class_id trunk -r9683:HEAD
no conflicts… puh..

File size: 4.4 KB
Line 
1/*!
2 * @file base_object.h
3 * @brief Definition of the BaseObject class.
4 *
5 * This is a global handler for all classes Object and Class names
6 *
7 * BaseObject is the class, that handles object registration and
8 * is the only write-access member of ClassList, where the Objects
9 * References are stored.
10 */
11
12
13#ifndef __BASE_OBJECT_H_
14#define __BASE_OBJECT_H_
15
16#include "object_list.h"
17#include "util/sigslot/slot.h"
18
19#include <string>
20
21class TiXmlNode;
22class TiXmlElement;
23class ClassList;
24
25//! A class all other classes are derived from
26class BaseObject : public sigslot::has_slots<>
27{
28  //! Declare an ObjectList for this Class.
29  ObjectListDeclaration(BaseObject);
30public:
31  BaseObject (const std::string& objectName = "");
32
33  virtual ~BaseObject ();
34
35  virtual void loadParams(const TiXmlElement* root);
36  void setName (const std::string& newName);
37  /** returns the Name of this Object */
38  inline const std::string& getName() const { return this->objectName; };
39  /** returns the Name of this Object as a C-compliant string (const char*) */
40  inline const char* getCName() const { return this->objectName.c_str(); };
41  /** @returns the XML-Element with whicht this Object was loaded */
42  inline TiXmlNode* getXmlElem() const { return this->xmlElem; };
43
44  //  /** @returns the className of the corresponding Object */
45  //inline const std::string& getClassName() const { return this->className; }
46  /** @returns the className of the corresponding Object as a C-compliant string (const char*) */
47  inline const char* getClassCName() const { return _classes.front()._objectList->name().c_str(); };
48  /** @returns the ClassName of the Topmost Object of the ClassStack */
49  inline const std::string& getClassName() const { return _classes.front()._objectList->name(); };
50
51  /** @returns the ClassID of this Object */
52  inline const ClassID& getClassID() const { return _classes.front()._objectList->identity(); }
53  /** @returns the ID of the Topmost object of the ClassStack */
54  inline const int& getLeafClassID() const { return _classes.front()._objectList->identity().id(); }
55
56  bool isA(const ObjectListBase& objectList) const;
57  bool isA(const ClassID& classID) const;
58  bool isA(int classID) const;
59  bool isA(const std::string& className) const;
60
61  void listInheritance() const;
62
63  /** @param classID comparer for a ClassID @returns true on match, false otherwise */
64  bool operator==(int classID) const  { return this->isA(classID); };
65  /** @param objectName: the name to check. * @returns true on match, false otherwise. */
66  bool operator==(const std::string& objectName) const { return this->objectName == objectName;};
67
68protected:
69  template<class T> void registerObject(T* object, ObjectList<T>& list);
70
71protected:
72  std::string        objectName;       //!< The name of this object
73
74private:
75
76  TiXmlNode*         xmlElem;          //!< The XML Element with wich this Object was loaded(saved).
77
78  //////////////////////////////
79  //// Type Definition Part ////
80  //////////////////////////////
81  //! A ClassEntry so we can store Classes inside of Objects
82  struct ClassEntry
83  {
84    /** Simple Constuctor @param objectList the ObjectList, @param iterator the (intrusive) Iterator inside of the ObjectList */
85    inline ClassEntry (ObjectListBase* objectList, ObjectListBase::IteratorBase* iterator) : _objectList(objectList), _iterator(iterator) {}
86    ObjectListBase*                _objectList;  //!< An ObjectList this Object is part of
87    ObjectListBase::IteratorBase*  _iterator;    //!< An iterator pointing to the position of the Object inside of the List.
88  };
89  typedef std::list<ClassEntry>       ClassEntries;   //!< Type definition for the List.
90
91  std::string                         className;    //!< the name of the class
92  ClassEntries                        _classes;     //!< All Classes this object is part of.
93};
94
95
96/**
97 * @brief Registeres an Object of Type T to objectList
98 * @param object The Object to append to the objectList.
99 * @param objectList The ObjectList to append the Object to.
100 *
101 * This function is essential to integrate objects into their designated ObjectList.
102 * Remember if you do not want objects to be stored in Lists (less overhead),
103 * do not attempt to call this function.
104 */
105template<class T>
106inline void BaseObject::registerObject(T* object, ObjectList<T>& objectList)
107{
108  this->_classes.push_front(ClassEntry(&objectList, objectList.registerObject(object)));
109}
110
111#endif /* __BASE_OBJECT_H_ */
Note: See TracBrowser for help on using the repository browser.