Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/trunk/src/util/loading/factory.cc @ 5984

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

orxonox/trunk: doxygen in Factory

File size: 4.5 KB
Line 
1/*
2   orxonox - the future of 3D-vertical-scrollers
3
4   Copyright (C) 2004 orx
5
6   This program is free software; you can redistribute it and/or modify
7   it under the terms of the GNU General Public License as published by
8   the Free Software Foundation; either version 2, or (at your option)
9   any later version.
10
11   ### File Specific:
12   main-programmer: Christian Meyer
13   co-programmer: Benjamin Grauer
14*/
15#define DEBUG_SPECIAL_MODULE DEBUG_MODULE_LOADING
16
17#include "factory.h"
18
19//#include "shell_command.h"
20
21using namespace std;
22
23//SHELL_COMMAND(create, Factory, fabricate);
24
25
26/*  --------------------------------------------------
27 *               Factory
28 *   --------------------------------------------------
29 */
30
31/**
32 *  constructor
33
34   set everything to zero and define factoryName
35*/
36Factory::Factory (const char* factoryName, ClassID classID)
37{
38  this->setClassID(CL_FACTORY, "Factory");
39  this->setName(factoryName);
40
41  this->classID = classID;
42  this->className = factoryName;
43
44  if( Factory::factoryList == NULL)
45    Factory::factoryList = new std::list<Factory*>;
46
47  Factory::factoryList->push_back(this);
48}
49
50/** a reference to the First Factory */
51std::list<Factory*>* Factory::factoryList = NULL;
52
53/**
54 *  destructor
55 *
56 * clear the Q
57 */
58Factory::~Factory ()
59{
60  //  printf("%s\n", this->factoryName);
61  //  Factory* tmpDel = this->next;
62  //  this->next = NULL;
63}
64
65/**
66 * deletes all the Factories. (cleanup)
67 */
68void Factory::deleteFactories()
69{
70  if (Factory::factoryList != NULL)
71  {
72    while(!Factory::factoryList->empty())
73    {
74      delete Factory::factoryList->front();
75      Factory::factoryList->pop_front();
76    }
77    delete Factory::factoryList;
78    Factory::factoryList = NULL;
79  }
80}
81
82/**
83 * @param classID match a classID with this classID
84 * @returns true on match, false otherwise
85 */
86bool Factory::operator==(ClassID classID) const
87{
88  return (this->classID == classID);
89}
90
91/**
92 * Compares the Factories Name against a given ClassName
93 * @param className the Name of the Class to Query
94 * @returns true on match, false otherwise.
95 */
96bool Factory::operator==(const char* className) const
97{
98  return(className != NULL && !strcmp(className, this->className));
99}
100
101
102/**
103 * Creates a new Object of type root->Value() (name)
104 * @param root the XML-Root to match for the newly created Object
105 * @returns a new Object of Type root->Value() on match, NULL otherwise
106 */
107 BaseObject* Factory::fabricate(const TiXmlElement* root)
108{
109  if (root == NULL || Factory::factoryList == NULL)
110    return NULL;
111
112  std::list<Factory*>::const_iterator factory;
113  for (factory = Factory::factoryList->begin(); factory != Factory::factoryList->end(); factory++)
114    if (*(*factory) == root->Value())
115      break;
116
117  if (factory != Factory::factoryList->end())
118  {
119    PRINTF(4)("Create a new Object of type %s\n", (*factory)->getName());
120    return (*factory)->fabricateObject(root);
121  }
122  else
123  {
124    PRINTF(2)("Could not Fabricate an Object of Class '%s'\n", root->Value());
125    return NULL;
126  }
127}
128
129
130/**
131 * Creates a new Object of type className
132 * @param className the ClassName to match for the newly created Object
133 * @returns a new Object of Type className on match, NULL otherwise
134 */
135 BaseObject* Factory::fabricate(const char* className)
136{
137  if (className == NULL || Factory::factoryList == NULL)
138    return NULL;
139
140  std::list<Factory*>::const_iterator factory;
141  for (factory = Factory::factoryList->begin(); factory != Factory::factoryList->end(); factory++)
142    if (*(*factory) == className)
143      break;
144
145  if (factory != Factory::factoryList->end())
146  {
147    PRINTF(4)("Create a new Object of type %s\n", (*factory)->getName());
148    return (*factory)->fabricateObject(NULL);
149  }
150  else
151  {
152    PRINTF(2)("Could not Fabricate an Object of Class '%s'\n", className);
153    return NULL;
154  }
155}
156
157/**
158 * Creates a new Object of type classID
159 * @param classID the ClassID to match for the newly created Object
160 * @returns a new Object of Type classID on match, NULL otherwise
161 */
162BaseObject* Factory::fabricate(ClassID classID)
163{
164  if (Factory::factoryList == NULL)
165    return NULL;
166
167  std::list<Factory*>::const_iterator factory;
168  for (factory = Factory::factoryList->begin(); factory != Factory::factoryList->end(); factory++)
169    if (*(*factory) == classID)
170      break;
171
172  if (factory != Factory::factoryList->end())
173  {
174    PRINTF(4)("Create a new Object of type %s\n", (*factory)->getName());
175    return (*factory)->fabricateObject(NULL);
176  }
177  else
178  {
179    PRINTF(2)("Could not Fabricate an Object of ClassID '%h'\n", classID);
180    return NULL;
181  }
182}
Note: See TracBrowser for help on using the repository browser.