Changeset 43 in pacpusframework for trunk

Timestamp:

01/08/13 21:53:01 (11 years ago)

Author:

sgosseli

Message:

Minor: add some documentation, update the license header, update the coding style.

Location:

trunk

Files:

• include/Pacpus/kernel/ComponentFactoryBase.h (modified) (2 diffs)
• src/PacpusLib/ComponentFactoryBase.cpp (modified) (4 diffs)

trunk/include/Pacpus/kernel/ComponentFactoryBase.h

@@ -1 +1 @@
 /**
  *
- * 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
- *
+ * This file is part of the PACPUS framework distributed under the 
+ * CECILL-C License, Version 1.0.
+ * 
+ * @author  Gerald Dherbomez
+ * @date    December, 2012
+ * @version $Id$
+ * @copyright Copyright (c) UTC/CNRS Heudiasyc 2005 - 2013. All rights reserved.
+ * 
  */
 
@@ -27 +29 @@
 {
     friend class ComponentManager;
-
 public:
-        ComponentFactoryBase();
-        virtual ~ComponentFactoryBase();
+    /** Ctor of ComponentFactoryBase. */
+    ComponentFactoryBase();
+    /** Dtor of ComponentFactoryBase. */
+    virtual ~ComponentFactoryBase();
 
 protected:
-    virtual ComponentBase * instantiateComponent(const QString & name) = 0;
-    void addFactory(ComponentFactoryBase * addr, const QString & type);
-    void addComponent(const QString & name);
+    /** Create a new component having @em name as component name.
+     * @param name Name of the instantiated component.
+     * @return Pointer on the newly created component, you become the owner of its lifetime.
+     */
+    virtual ComponentBase * instantiateComponent(const QString& name) = 0;
+    
+    /** Register a new factory.
+     * @param addr Address of the factory.
+     * @param type Name of the type created by the factory.
+     */
+    void addFactory(ComponentFactoryBase* addr, const QString& type);
+    
+    /** Add a new component.
+     * @param name Name of the new component.
+     */
+    void addComponent(const QString& name);
 
 private:
-    ComponentManager * mgr_;
+    ComponentManager* mgr_;
 };
 

trunk/src/PacpusLib/ComponentFactoryBase.cpp

@@ -1 +1 @@
 /**
  *
- * 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
- *
+ * This file is part of the PACPUS framework distributed under the 
+ * CECILL-C License, Version 1.0.
+ * 
+ * @author  Gerald Dherbomez
+ * @date    December, 2012
+ * @version $Id$
+ * @copyright Copyright (c) UTC/CNRS Heudiasyc 2005 - 2013. All rights reserved.
+ * 
  */
 
@@ -22 +24 @@
 
 ComponentFactoryBase::ComponentFactoryBase()
+    : mgr_(NULL)
 {
     LOG_TRACE("constructor");
-
     // get the adress of the ComponentManager instance
     mgr_ = ComponentManager::getInstance();
@@ -34 +36 @@
 }
 
-void ComponentFactoryBase::addFactory(ComponentFactoryBase * addr, const QString & type)
+void ComponentFactoryBase::addFactory(ComponentFactoryBase* addr, const QString& type)
 {
     LOG_DEBUG("addFactory(type="<< type << ")");
@@ -48 +50 @@
 }
 
-void ComponentFactoryBase::addComponent(const QString & name)
+void ComponentFactoryBase::addComponent(const QString& name)
 {
     LOG_DEBUG("addComponent(" << name << ")");