From a1dfa3c4c3e8ed6d9a147dc02ecd31ce7c3b2e1a Mon Sep 17 00:00:00 2001
From: Russell Taylor <taylorrj@ornl.gov>
Date: Thu, 26 Jun 2008 11:55:29 +0000
Subject: [PATCH] UnitFactory now only creates a single instance of each unit
and hands out a pointer to that instance each time the unit is requested. Re
#153.
---
.../Kernel/inc/MantidKernel/UnitFactory.h | 28 ++++++++++++-------
Code/Mantid/Kernel/src/UnitFactory.cpp | 26 +++++++++++++++--
Code/Mantid/Kernel/test/UnitFactoryTest.h | 27 ++++++++++++++++++
3 files changed, 69 insertions(+), 12 deletions(-)
create mode 100644 Code/Mantid/Kernel/test/UnitFactoryTest.h
diff --git a/Code/Mantid/Kernel/inc/MantidKernel/UnitFactory.h b/Code/Mantid/Kernel/inc/MantidKernel/UnitFactory.h
index f7a3ab3237a..c1023f1f562 100644
--- a/Code/Mantid/Kernel/inc/MantidKernel/UnitFactory.h
+++ b/Code/Mantid/Kernel/inc/MantidKernel/UnitFactory.h
@@ -1,11 +1,11 @@
#ifndef MANTID_KERNEL_UNITFACTORYIMPL_H_
#define MANTID_KERNEL_UNITFACTORYIMPL_H_
-/* Used to register unit classes into the factory. creates a global object in an
+/* Used to register unit classes into the factory. creates a global object in an
* anonymous namespace. The object itself does nothing, but the comma operator
- * is used in the call to its constructor to effect a call to the factory's
+ * is used in the call to its constructor to effect a call to the factory's
* subscribe method.
- *
+ *
* The second operation that this macro performs is to provide the definition
* of the unitID method for the concrete unit.
*/
@@ -38,11 +38,14 @@ class Logger;
/** Creates instances of concrete units.
The factory is a singleton that hands out shared pointers to the base Unit class.
+ It overrides the base class DynamicFactory::create method so that only a single
+ instance of a given unit is ever created, and a pointer to that same instance
+ is passed out each time the unit is requested.
@author Russell Taylor, Tessella Support Services plc
@date 13/03/2008
- Copyright © 2008 STFC Rutherford Appleton Laboratories
+ Copyright © 2008 STFC Rutherford Appleton Laboratory
This file is part of Mantid.
@@ -59,16 +62,19 @@ class Logger;
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
- File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
+ File change history is stored at: <https://svn.mantidproject.org/mantid/trunk/Code/Mantid>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class EXPORT_OPT_MANTID_KERNEL UnitFactoryImpl : public DynamicFactory<Unit>
{
+public:
+ virtual boost::shared_ptr<Unit> create(const std::string& className) const;
+
private:
friend struct CreateUsingNew<UnitFactoryImpl>;
/// Private Constructor for singleton class
- UnitFactoryImpl();
+ UnitFactoryImpl();
/// Private copy constructor - NO COPY ALLOWED
UnitFactoryImpl(const UnitFactoryImpl&);
/// Private assignment operator - NO ASSIGNMENT ALLOWED
@@ -76,9 +82,11 @@ private:
///Private Destructor
virtual ~UnitFactoryImpl();
- ///static reference to the logger class
- Kernel::Logger& g_log;
+ /// Stores pointers to already created unit instances, with their name as the key
+ mutable std::map< std::string, boost::shared_ptr<Unit> > m_createdUnits;
+ /// Reference to the logger class
+ Kernel::Logger& m_log;
};
///Forward declaration of a specialisation of SingletonHolder for AlgorithmFactoryImpl (needed for dllexport/dllimport) .
@@ -89,7 +97,7 @@ private:
/// The specialisation of the SingletonHolder class that holds the UnitFactory
typedef SingletonHolder<UnitFactoryImpl> UnitFactory;
-}
-}
+} // namespace Kernel
+} // namespace Mantid
#endif /*MANTID_KERNEL_UNITFACTORYIMPL_H_*/
diff --git a/Code/Mantid/Kernel/src/UnitFactory.cpp b/Code/Mantid/Kernel/src/UnitFactory.cpp
index a21ec841d55..9e8fd0d2291 100644
--- a/Code/Mantid/Kernel/src/UnitFactory.cpp
+++ b/Code/Mantid/Kernel/src/UnitFactory.cpp
@@ -6,7 +6,8 @@ namespace Mantid
namespace Kernel
{
-UnitFactoryImpl::UnitFactoryImpl() : Kernel::DynamicFactory<Unit>(), g_log(Kernel::Logger::get("UnitFactory"))
+UnitFactoryImpl::UnitFactoryImpl() :
+ DynamicFactory<Unit>(), m_createdUnits(), m_log(Kernel::Logger::get("UnitFactory"))
{
}
@@ -14,5 +15,26 @@ UnitFactoryImpl::~UnitFactoryImpl()
{
}
+/** Returns an instance of the class with the given name. Overrides the base class method.
+ * If an instance already exists, a pointer to it is returned, otherwise
+ * a new instance is created by the DynamicFactory::create method.
+ * @param className The name of the class to be created
+ * @return A shared pointer to the instance of the requested unit
+ */
+boost::shared_ptr<Unit> UnitFactoryImpl::create(const std::string& className) const
+{
+ std::map< std::string, boost::shared_ptr<Unit> >::const_iterator it = m_createdUnits.find(className);
+ if ( it != m_createdUnits.end() )
+ {
+ // If an instance has previously been created, just return a pointer to it
+ return it->second;
+ }
+ else
+ {
+ // Otherwise create & return a new instance and store the pointer in the internal map for next time
+ return m_createdUnits[className] = DynamicFactory<Unit>::create(className);
+ }
}
-}
+
+} // namespace Kernel
+} // namespace Mantid
diff --git a/Code/Mantid/Kernel/test/UnitFactoryTest.h b/Code/Mantid/Kernel/test/UnitFactoryTest.h
new file mode 100644
index 00000000000..7ebaf5f9142
--- /dev/null
+++ b/Code/Mantid/Kernel/test/UnitFactoryTest.h
@@ -0,0 +1,27 @@
+#ifndef UNITFACTORYTEST_H_
+#define UNITFACTORYTEST_H_
+
+#include <cxxtest/TestSuite.h>
+
+#include "MantidKernel/UnitFactory.h"
+#include "MantidKernel/Unit.h"
+#include <boost/shared_ptr.hpp>
+
+using namespace Mantid::Kernel;
+
+class UnitFactoryTest : public CxxTest::TestSuite
+{
+public:
+ void testCreate()
+ {
+ boost::shared_ptr<Unit> first;
+ TS_ASSERT_THROWS_NOTHING( first = UnitFactory::Instance().create("TOF") )
+ // Test that asking for the same unit again gives the same pointer
+ TS_ASSERT_EQUALS( UnitFactory::Instance().create("TOF"), first )
+ // And that asking for a different unit gives a different pointer
+ TS_ASSERT_DIFFERS( UnitFactory::Instance().create("Wavelength"), first )
+ }
+
+};
+
+#endif /*UNITFACTORYTEST_H_*/
--
GitLab