Changeset 4487 in orxonox.OLD for orxonox/trunk/src/util/loading/factory.h

Timestamp:

Jun 3, 2005, 12:56:57 AM (19 years ago)

Author:

bensch

Message:

orxonox/trunk: more doxygen-tags in util

File:

• orxonox/trunk/src/util/loading/factory.h (modified) (5 diffs)

orxonox/trunk/src/util/loading/factory.h

@@ -16 +16 @@
 /*! 
   \file factory.h
-  \brief philosophy stuff
+  \brief A loadable object handler
 */
 
@@ -34 +34 @@
 */
 #define CREATE_FACTORY(CLASS_NAME) tFactory<CLASS_NAME>* global_##CLASS_NAME##Factory = new tFactory<CLASS_NAME>(#CLASS_NAME)           
-//! The Factory is
+
+//! The Factory is a loadable object handler
 class Factory {
 
  public:
-  Factory (const char* name = NULL);
+  Factory (const char* factoryName = NULL);
   ~Factory ();
   
@@ -45 +46 @@
   void initialize();
   void registerFactory( Factory* factory);
-  void setFactoryName(const char* name);
-  const char* getFactoryName() {return factoryName;};
-  void setNext( Factory* factory) {next = factory;}
-  Factory* getNext() {return next;}
+  void setFactoryName(const char* factoryName);
+  /** \returns the name of the factory */
+  const char* getFactoryName() { return this->factoryName; };
+  /** \brief sets the Next factory in the list \param nextFactory the next factory */
+  inline void setNext( Factory* nextFactory) { this->next = nextFactory; };
+  /** \returns the next factory */
+  Factory* getNext(void) const { return this->next; };
         
+ protected:
+  char*         factoryName;          //!< the name of the factory
  private:
-  char* factoryName;
-        
-  Factory* next;
+  Factory*      next;                 //!< pointer to the next factory.
 };
 
+/**
+   \brief a factory that is able to load any kind of Object
+   (this is a Functor)
+*/
 template<class T> class tFactory : public Factory
 {
  public:
-  tFactory(const char* name);
+  tFactory(const char* factoryName);
   virtual ~tFactory();
   
@@ -66 +74 @@
 };
 
+/**
+   \brief construnts a factory with
+   \param factoryName the name of the factory
+*/
 template<class T>
-tFactory<T>::tFactory(const char* name) : Factory(name)
+tFactory<T>::tFactory(const char* factoryName) : Factory(factoryName)
 {
-  PRINTF(5)("fileName: %s\n", name);
+  PRINTF(5)("fileName: %s loadable\n", this->factoryName);
 }
   
@@ -90 +102 @@
 // helper function
 
-const char* grabParameter(const TiXmlElement* root, const char* name);
+const char* grabParameter(const TiXmlElement* root, const char* parameterName);
 
 #endif /* _FACTORY_H */