Refs #8550. ScopedWorkspace: explicit remove method.

Plus fixed setting logic and test for it.
mantidproject · Dec 9, 2013 · 50a5b02 · 50a5b02
1 parent 8b16f3c
commit 50a5b02
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 15 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/ScopedWorkspace.h b/Code/Mantid/Framework/API/inc/MantidAPI/ScopedWorkspace.h
@@ -60,6 +60,9 @@ namespace API
     /// Retrieve workspace from the ADS
     Workspace_sptr retrieve() const;
 
+    /// Removes the workspace entry from the ADS
+    void remove();
+
     /// Operator for conversion to boolean
     operator bool() const;
 

diff --git a/Code/Mantid/Framework/API/src/ScopedWorkspace.cpp b/Code/Mantid/Framework/API/src/ScopedWorkspace.cpp
@@ -32,21 +32,7 @@ namespace API
    */
   ScopedWorkspace::~ScopedWorkspace()
   {
-    AnalysisDataServiceImpl& ads = AnalysisDataService::Instance();
-
-    // When destructed, remove workspace from the ADS if was added and still exists
-    if ( ads.doesExist(m_name) )
-    {
-      if ( ads.retrieveWS<WorkspaceGroup>(m_name) )
-      {
-        // If is a group, need to remove all the members as well
-        ads.deepRemoveGroup(m_name);
-      }
-      else
-      {
-        ads.remove(m_name);
-      }
-    }
+    remove();
   }
 
   /**
@@ -73,6 +59,28 @@ namespace API
 
     return Workspace_sptr();
   }
+
+  /**
+   * Removes the workspace entry from the ADS.
+   */
+  void ScopedWorkspace::remove()
+  {
+    AnalysisDataServiceImpl& ads = AnalysisDataService::Instance();
+
+    // When destructed, remove workspace from the ADS if was added and still exists
+    if ( ads.doesExist(m_name) )
+    {
+      if ( ads.retrieveWS<WorkspaceGroup>(m_name) )
+      {
+        // If is a group, need to remove all the members as well
+        ads.deepRemoveGroup(m_name);
+      }
+      else
+      {
+        ads.remove(m_name);
+      }
+    }
+  }
 
   /**
    * Make ADS entry to point to the given workspace.
@@ -84,6 +92,9 @@ namespace API
     if ( ! newWS->name().empty() && ads.doesExist( newWS->name() ) )
       throw std::invalid_argument( "Workspace is already in the ADS under the name " + newWS->name() );
 
+    // Remove previous workspace entry
+    remove();
+
     ads.add(m_name, newWS); 
   }
 

diff --git a/Code/Mantid/Framework/API/test/ScopedWorkspaceTest.h b/Code/Mantid/Framework/API/test/ScopedWorkspaceTest.h
@@ -161,6 +161,23 @@ class ScopedWorkspaceTest : public CxxTest::TestSuite
     TS_ASSERT( test );
   }
 
+  void test_settingTwice()
+  {
+    ScopedWorkspace test;
+
+    MockWorkspace_sptr ws1 = MockWorkspace_sptr(new MockWorkspace);
+    test.set(ws1);
+
+    TS_ASSERT_EQUALS( ws1->name(), test.name() );
+
+    MockWorkspace_sptr ws2 = MockWorkspace_sptr(new MockWorkspace);
+    test.set(ws2);
+
+    TS_ASSERT_EQUALS( ws2->name(), test.name() );
+    TS_ASSERT( ws1->name().empty() );
+    TS_ASSERT_EQUALS( m_ads.getObjectNamesInclHidden().size(), 1 );
+  }
+
 private:
   AnalysisDataServiceImpl& m_ads;
 };