Merge remote branch 'origin/feature/6758_DataService'

Code/Mantid/Framework/API/CMakeLists.txt

@@ -95,6 +95,7 @@ set ( SRC_FILES
 	src/Run.cpp
 	src/Sample.cpp
 	src/SampleEnvironment.cpp
+	src/SelectionNotificationService.cpp
 	src/ScriptRepository.cpp
 	src/ScriptRepositoryFactory.cpp
 	src/SpectraAxis.cpp
@@ -239,6 +240,7 @@ set ( INC_FILES
 	inc/MantidAPI/SampleEnvironment.h
 	inc/MantidAPI/ScriptRepository.h
 	inc/MantidAPI/ScriptRepositoryFactory.h
+	inc/MantidAPI/SelectionNotificationService.h
 	inc/MantidAPI/SingleValueParameter.h
 	inc/MantidAPI/SingleValueParameterParser.h
 	inc/MantidAPI/SpecialCoordinateSystem.h
@@ -315,6 +317,7 @@ set ( TEST_FILES
 	RunTest.h
 	SampleEnvironmentTest.h
 	SampleTest.h
+	SelectionNotificationServiceTest.h
 	SpectraAxisTest.h
 	SpectraDetectorMapTest.h
 	TextAxisTest.h

Code/Mantid/Framework/API/inc/MantidAPI/SelectionNotificationService.h

+/*
+ * SelectionNotificationService.h
+ *
+ *  Created on: Mar 21, 2013
+ *      Author: ruth
+ */
+
+/**
+ * The singleton version of this class is intended to be used for messages between the
+ * Single Crystal Reduction Interface and Visual elements of the data with peaks.  Some examples
+ * of possible information that can be shared are points in space( in Qlab, hkl,...)and regions in
+ * space.  This information could be selected or show selection.
+ *
+ */
+#ifndef SELECTIONNOTIFICATIONSERVICE_H_
+#define SELECTIONNOTIFICATIONSERVICE_H_
+
+
+#include "MantidKernel/DataService.h"
+#include "MantidAPI/DllConfig.h"
+#include "MantidKernel/SingletonHolder.h"
+
+namespace Mantid
+{
+
+namespace API
+{
+
+class  DLLExport SelectionNotificationServiceImpl : public Kernel::DataService<std::vector<double>>
+{
+
+private:
+
+  /// Constructor
+  SelectionNotificationServiceImpl();
+  /// Private, unimplemented copy constructor
+ // SelectionNotificationServiceImpl(const SelectionNotificationServiceImpl&);
+  friend struct Mantid::Kernel::CreateUsingNew<SelectionNotificationServiceImpl>;
+  /// Private destructor
+  virtual ~SelectionNotificationServiceImpl();
+
+};
+
+
+///Forward declaration of a specialisation of SingletonHolder for SelectionNotificationServiceImpl (needed for dllexport/dllimport) and a typedef for it.
+#ifdef _WIN32
+  // this breaks new namespace declaraion rules; need to find a better fix
+  template class MANTID_API_DLL Mantid::Kernel::SingletonHolder<SelectionNotificationServiceImpl>;
+#endif /* _WIN32 */
+  typedef MANTID_API_DLL Mantid::Kernel::SingletonHolder<SelectionNotificationServiceImpl> SelectionNotificationService;
+
+} // Namespace API
+} // Namespace Mantid
+
+#endif /* SELECTIONNOTIFICATIONSERVICE_H_ */

Code/Mantid/Framework/API/src/SelectionNotificationService.cpp

+#include "MantidAPI/SelectionNotificationService.h"
+#include "MantidKernel/DataService.h"
+/*
+ * SelectionNotificationService.cpp
+ *
+ *  Created on: Mar 21, 2013
+ *      Author: ruth
+ */
+
+namespace Mantid
+{
+  namespace API
+  {
+
+
+    SelectionNotificationServiceImpl::SelectionNotificationServiceImpl():
+              Mantid::Kernel::DataService<std::vector<double> >("SelectionNotificationService")
+      {
+      }
+
+    SelectionNotificationServiceImpl:: ~SelectionNotificationServiceImpl()
+    {
+
+    }
+
+  } // Namespace API
+ } // Namespace Mantid
+
+
+

Code/Mantid/Framework/API/test/SelectionNotificationServiceTest.h

+/*
+ * SelectionNotificationServiceTest.h
+ *
+ *  Created on: Mar 24, 2013
+ *      Author: Ruth Mikkelson
+ */
+
+#ifndef SELECTIONNOTIFICATIONSERVICETEST_H_
+#define SELECTIONNOTIFICATIONSERVICETEST_H_
+
+#include <cxxtest/TestSuite.h>
+#include "MantidKernel/CPUTimer.h"
+#include "MantidKernel/System.h"
+#include "MantidKernel/Timer.h"
+#include <iomanip>
+#include <iosfwd>
+#include <iostream>
+#include <Poco/NObserver.h>
+
+#include "MantidKernel/MultiThreaded.h"
+#include "MantidAPI/SelectionNotificationService.h"
+
+using namespace Mantid;
+using namespace API;
+
+class SelectionNotificationServiceTest: public CxxTest::TestSuite
+{
+public:
+
+  std::vector<int> vector;
+  Poco::Mutex m_vectorMutex;
+
+  void setUp()
+  {
+    SelectionNotificationService::Instance().clear();
+  }
+
+  void test_add()
+  {
+    TS_ASSERT_EQUALS(SelectionNotificationService::Instance().size(), 0);
+
+    boost::shared_ptr<std::vector<double>> one(new std::vector<double>());
+    one->push_back(3.0);
+    one->push_back(5.0);
+    one->push_back(7.0);
+
+    // Add and check that it is in there
+        TS_ASSERT_THROWS_NOTHING( SelectionNotificationService::Instance().add("one", one); );
+
+        TS_ASSERT_EQUALS( SelectionNotificationService::Instance().size(), 1);
+        TS_ASSERT( SelectionNotificationService::Instance().doesExist("one"));
+        TS_ASSERT(SelectionNotificationService::Instance().retrieve("one") == one);
+
+        // Can't re-add the same name
+        TS_ASSERT_THROWS_ANYTHING( SelectionNotificationService::Instance().add("one", one); );
+        // Can't add blank name
+        TS_ASSERT_THROWS_ANYTHING( SelectionNotificationService::Instance().add("", one); );
+      }
+
+      void test_remove()
+      {
+        boost::shared_ptr<std::vector<double>> one(new std::vector<double>());
+        one->push_back(3.0);
+        one->push_back(5.0);
+        one->push_back(7.0);
+        TS_ASSERT_THROWS_NOTHING( SelectionNotificationService::Instance().add("one", one); );
+        TS_ASSERT_EQUALS(SelectionNotificationService::Instance().size(), 1);
+        TS_ASSERT_THROWS_NOTHING( SelectionNotificationService::Instance().remove("one"); );
+        TS_ASSERT_EQUALS( SelectionNotificationService::Instance().size(), 0);
+
+      }
+
+      void test_addOrReplace()
+      {
+        TS_ASSERT_EQUALS( SelectionNotificationService::Instance().size(), 0);
+        boost::shared_ptr<std::vector<double>> one(new std::vector<double>());
+        one->push_back(3.0);
+        one->push_back(5.0);
+        one->push_back(7.0);
+        TS_ASSERT_THROWS_NOTHING( SelectionNotificationService::Instance().add("one", one); );
+        TS_ASSERT_EQUALS( SelectionNotificationService::Instance().size(), 1);
+
+        // Does it replace?
+        boost::shared_ptr<std::vector<double>> two(new std::vector<double>());
+        two->push_back(1.0);
+        two->push_back(2.0);
+        two->push_back(3.0);
+        TS_ASSERT_THROWS_NOTHING( SelectionNotificationService::Instance().addOrReplace("one", two); );
+        TS_ASSERT_EQUALS( SelectionNotificationService::Instance().size(), 1);
+        TS_ASSERT( SelectionNotificationService::Instance().doesExist("one"));
+
+        // Was the name replaced? One equals two, what funny math!!!
+        TS_ASSERT( SelectionNotificationService::Instance().retrieve("one") == two);
+        boost::shared_ptr<std::vector<double> > Res =SelectionNotificationService::Instance().retrieve("one");
+        std::vector<double> T = *Res;
+
+        TS_ASSERT_DELTA( T.at(1) , 2.0,.001);
+
+      }
+
+      // Handler for an observer, called each time an object is added
+      void handleAddNotification(const Poco::AutoPtr<SelectionNotificationServiceImpl::AddNotification> & x )
+      {
+        m_vectorMutex.lock();
+        vector.push_back(123);
+        std::cout<<"name="<<x->object_name()<<", object="<<x->object()->at(0)<<std::endl;
+        m_vectorMutex.unlock();
+      }
+
+      void test_threadSafety()
+      {
+        Poco::NObserver<SelectionNotificationServiceTest, SelectionNotificationServiceImpl::AddNotification> observer(*this, &SelectionNotificationServiceTest::handleAddNotification);
+        SelectionNotificationService::Instance().notificationCenter.addObserver(observer);
+        vector.clear();
+
+        boost::shared_ptr<std::vector<double>> object1(new std::vector<double>());
+        object1->push_back(82.0);
+        SelectionNotificationService::Instance().add("object1", object1);
+
+        int num = 50;
+
+        PARALLEL_FOR_NO_WSP_CHECK()
+        for (int i=0; i<num; i++)
+        {
+          boost::shared_ptr<std::vector<double> > object(new std::vector<double>());
+          object->push_back(i+23.0);
+          object->push_back(i+30.0);
+
+          std::ostringstream mess; mess << "item" << i;
+
+          // Adding/replacing some items
+          SelectionNotificationService::Instance().addOrReplace( mess.str(), object);
+
+          // And retrieving some at the same time
+          boost::shared_ptr<std::vector<double>> retrieved = SelectionNotificationService::Instance().retrieve("object1");
+          std::vector<double> T=*retrieved;
+          TS_ASSERT_DELTA( T.at(0), 82.0,.001);
+
+          // Also add then remove another object
+          std::string otherName = "other_" + mess.str();
+          boost::shared_ptr<std::vector<double>> other(new std::vector<double>());
+          other->push_back(i+40);
+          other->push_back(i+50);
+          SelectionNotificationService::Instance().add( otherName, other);
+          SelectionNotificationService::Instance().remove( otherName );
+        }
+
+        TS_ASSERT_EQUALS ( SelectionNotificationService::Instance().size(), size_t(num+1) );
+
+        // Vector was append twice per loop
+        TS_ASSERT_EQUALS ( vector.size(), size_t(num*2+1) );
+
+        // Try a few random items, check that they are there
+        TS_ASSERT_EQUALS( (*SelectionNotificationService::Instance().retrieve("item19")).at(0), 19+23);
+        TS_ASSERT_EQUALS( (*SelectionNotificationService::Instance().retrieve("item25")).at(1), 30+25);
+      }
+
+    };
+
+
+#endif /* SELECTIONNOTIFICATIONSERVICETEST_H_ */