Changeset 15 in pacpusframework for trunk/include/Pacpus

Timestamp:

Jan 8, 2013, 1:47:28 AM (12 years ago)

Author:

sgosseli

Message:

Many improvement (documentation and coding style).

File:

• trunk/include/Pacpus/kernel/ComponentFactory.h (modified) (2 diffs)

trunk/include/Pacpus/kernel/ComponentFactory.h

@@ -1 @@
-// ********************************************************************
-//  created:    2006/02/14 - 15:39
-//  filename:   ComponentFactory.h
-//
-//  author:     Gerald Dherbomez
-//
-//  purpose:    Template class ComponentFactory.
-//              Use it to interface your components with the application
-// *********************************************************************
+/**
+ *
+ * Distributed under the UTC Heudiascy Pacpus License, Version 1.0.
+ * Copyright (c) UTC Heudiasyc 2010 - 2013. All rights reserved.
+ *
+ * See the LICENSE file for more information or a copy at:
+ *   http://www.hds.utc.fr/~kurdejma/LICENSE_1_0.txt
+ *
+ */
 
 #ifndef COMPONENTFACTORY_H
 #define COMPONENTFACTORY_H
 
+#include <cassert>
+
 #include "ComponentFactoryBase.h"
 
+#include <QtGlobal>
 #include <QString>
 
@@ -23 +26 @@
   static pacpus::ComponentFactory<className> sFactory(factoryName)
 
-namespace pacpus {
+namespace pacpus
+{
+  /** ComponentFactory
+   * @brief Use it to interface your components with the application.
+   *
+   * @example
+   *   REGISTER_COMPONENT("DummyComponent", DummyComponent);
+   */
+  template <typename T>
+  class ComponentFactory
+    : public ComponentFactoryBase
+  {
+    public:
+      /** Ctor of ComponentFactory, initialize the factory of the components of type @em T.
+       * @param type Name of the type of the components.
+       */
+      ComponentFactory(const QString& type);
+      
+      /** Dtor of ComponentFactory. */
+      virtual ~ComponentFactory();
 
-template <typename T>
-class ComponentFactory
-        : public ComponentFactoryBase
-{
-public:
-    ComponentFactory(QString type);
-    virtual ~ComponentFactory();
+      /** Get the name of the type of the components.
+       * @return Name of the type of the components.
+       */
+      const QString& getType() const;
 
-    const QString & getType() const;
+    protected:
+      virtual ComponentBase* instantiateComponent(const QString& name);
+      
+    private:
+      QString mType;
+  };
 
-protected:
-    virtual ComponentBase * instantiateComponent(const QString & name);
 
-private:
-    QString mType;
-};
+  template <typename T>
+  ComponentFactory<T>::ComponentFactory(const QString& type)
+    : mType(type)
+  {
+    assert(!type.isEmpty());
+    addFactory(this, mType);
+  }
 
-////////////////////////////////////////////////////////////////////////////////
-template <typename T>
-ComponentFactory<T>::ComponentFactory(QString type)
-    : mType(type)
-{
-    addFactory(this, mType);
+  template<typename T>
+  ComponentFactory<T>::~ComponentFactory()
+  {
+  }
+
+  template <typename T>
+  const QString& ComponentFactory<T>::getType() const
+  {
+    return mType;
+  }
+
+  template<typename T>
+  ComponentBase* ComponentFactory<T>::instantiateComponent(const QString& name)
+  {
+    return new T(name);
+  }
 }
 
-template<typename T>
-ComponentFactory<T>::~ComponentFactory()
-{
-}
-
-template <typename T>
-const QString & ComponentFactory<T>::getType() const
-{
-    return mType;
-}
-
-template<typename T>
-ComponentBase * ComponentFactory<T>::instantiateComponent(const QString & name)
-{
-    T * component = new T(name);
-    return component;
-}
-
-} // namespace pacpus
-
 #endif // COMPONENTFACTORY_H