Moved deep group removing to the ADS class. Re #7253.

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

@@ -128,6 +128,12 @@ class DLLExport AnalysisDataServiceImpl : public Kernel::DataService<API::Worksp
      return boost::dynamic_pointer_cast<WSTYPE>(workspace);
    }
 
+   /** @name Methods to work with workspace groups */
+   //@{
+
+   void deepRemoveGroup(const std::string& name);
+
+   //@}
 
 private:
    /// Checks the name is valid, throwing if not

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

@@ -87,8 +87,6 @@ class MANTID_API_DLL WorkspaceGroup : public Workspace
   void remove(const std::string& name);
   /// Remove all names from the group but do not touch the ADS
   void removeAll();
-  /// Remove all names from the group and also from the ADS
-  void deepRemoveAll();
   /// This method returns true if the group is empty (no member workspace)
   bool isEmpty() const;
   bool areNamesSimilar() const;

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

@@ -143,6 +143,35 @@ namespace Mantid
       ws->setName( newName );
     }
 
+    /**
+     * Remove a workspace group and all its members from the ADS.
+     * @param name :: A group to remove.
+     */
+    void AnalysisDataServiceImpl::deepRemoveGroup(const std::string &name)
+    {
+        WorkspaceGroup_sptr group = retrieveWS<WorkspaceGroup>( name );
+        if ( !group )
+        {
+            throw std::runtime_error("Workspace " + name + " is not a workspace group.");
+        }
+        group->observeADSNotifications( false );
+        for(size_t i = 0; i < group->size(); ++i)
+        {
+            auto ws = group->getItem(i);
+            WorkspaceGroup_sptr gws = boost::dynamic_pointer_cast<WorkspaceGroup>( ws );
+            if ( gws )
+            {
+                // if a member is a group remove its items as well
+                deepRemoveGroup( gws->name() );
+            }
+            else
+            {
+                remove( ws->name() );
+            }
+        }
+        remove( name );
+    }
+
     //-------------------------------------------------------------------------
     // Private methods
     //-------------------------------------------------------------------------

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

@@ -350,7 +350,7 @@ bool FrameworkManagerImpl::deleteWorkspace(const std::string& wsName)
   if(ws_grpsptr)
   {
     //  selected workspace is a group workspace
-    ws_grpsptr->deepRemoveAll();
+      AnalysisDataService::Instance().deepRemoveGroup( wsName );
   }
   // Make sure we drop the references so the memory will get freed when we expect it to
   ws_sptr.reset();

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

@@ -173,19 +173,6 @@ void WorkspaceGroup::remove(const std::string& wsName)
   updated();
 }
 
-/// Removes all members of the group from the group AND from the AnalysisDataService
-void WorkspaceGroup::deepRemoveAll()
-{
-  Poco::Mutex::ScopedLock _lock(m_mutex);
-  if( m_observingADS ) AnalysisDataService::Instance().notificationCenter.removeObserver(m_deleteObserver);
-  while (!m_workspaces.empty())
-  {
-    AnalysisDataService::Instance().remove(m_workspaces.back()->name());
-	  m_workspaces.pop_back();
-  }
-  if( m_observingADS ) AnalysisDataService::Instance().notificationCenter.addObserver(m_deleteObserver);
-}
-
 /// Print the names of all the workspaces in this group to the logger (at debug level)
 void WorkspaceGroup::print() const
 {

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

@@ -331,6 +331,27 @@ class AnalysisDataServiceTest : public CxxTest::TestSuite
     ConfigService::Instance().setString("MantidOptions.InvisibleWorkspaces","0");
   }
 
+  void test_deepRemoveGroup()
+  {
+      addToADS("some_workspace");
+      auto group = addGroupToADS("group");
+      TS_ASSERT_EQUALS( ads.size(), 4);
+
+      // name doesn't exist
+      TS_ASSERT_THROWS( ads.deepRemoveGroup("abc"), std::runtime_error );
+      // workspace isn't a group
+      TS_ASSERT_THROWS( ads.deepRemoveGroup("group_1"), std::runtime_error );
+      TS_ASSERT_THROWS_NOTHING( ads.deepRemoveGroup("group") );
+      TS_ASSERT_EQUALS( ads.size(), 1);
+
+      // check a group containing another group
+      group = addGroupWithGroupToADS("group");
+      TS_ASSERT_EQUALS( ads.size(), 6);
+      TS_ASSERT_THROWS_NOTHING( ads.deepRemoveGroup("group") );
+      TS_ASSERT_EQUALS( ads.size(), 1);
+      ads.clear();
+  }
+
 private:
 
   /// If replace=true then usea addOrReplace
@@ -373,6 +394,29 @@ class AnalysisDataServiceTest : public CxxTest::TestSuite
     return space;
   }
 
+  /// Add a group with 2 simple workspaces to the ADS
+  Workspace_sptr addGroupToADS(const std::string & name)
+  {
+      WorkspaceGroup_sptr group( new WorkspaceGroup );
+      group->addWorkspace( MockWorkspace_sptr(new MockWorkspace) );
+      group->addWorkspace( MockWorkspace_sptr(new MockWorkspace) );
+      ads.add(name, group);
+      return group;
+  }
+
+  /// Add a group with 1 simple workspace and 1 group with 2 simple ws to the ADS
+  Workspace_sptr addGroupWithGroupToADS(const std::string & name)
+  {
+      WorkspaceGroup_sptr group( new WorkspaceGroup );
+      group->addWorkspace( MockWorkspace_sptr(new MockWorkspace) );
+      WorkspaceGroup_sptr group1( new WorkspaceGroup );
+      group1->addWorkspace( MockWorkspace_sptr(new MockWorkspace) );
+      group1->addWorkspace( MockWorkspace_sptr(new MockWorkspace) );
+      group->addWorkspace( group1 );
+      ads.add(name, group);
+      return group;
+  }
+
   /// Add or replace the given name
   void addOrReplaceToADS(const std::string & name)
   {

Code/Mantid/Framework/Algorithms/test/CheckWorkspacesMatchTest.h

@@ -741,6 +741,7 @@ class CheckWorkspacesMatchTest : public CxxTest::TestSuite
 
   void test_Input_With_Two_Groups_When_Single_Item_Checking_Is_Disabled()
   {
+    Mantid::API::AnalysisDataService::Instance().clear();
     // Create a group
     const std::string groupOneName("TestGroupOne");
     WorkspaceGroup_sptr groupOne = WorkspaceCreationHelper::CreateWorkspaceGroup(2, 2, 2, groupOneName);
@@ -804,9 +805,9 @@ class CheckWorkspacesMatchTest : public CxxTest::TestSuite
 
   void cleanupGroup(const WorkspaceGroup_sptr group)
   {
-    group->deepRemoveAll();
+    //group->deepRemoveAll();
     const std::string name = group->getName();
-    Mantid::API::AnalysisDataService::Instance().remove(name);
+    Mantid::API::AnalysisDataService::Instance().deepRemoveGroup(name);
   }
 
 private:

Code/Mantid/Framework/Algorithms/test/ChopDataTest.h

@@ -90,8 +90,7 @@ class ChopDataTest : public CxxTest::TestSuite
 
     // Cleanup
     AnalysisDataService::Instance().remove("chopdatatest_input");
-    wsgroup->deepRemoveAll();
-    AnalysisDataService::Instance().remove("chopdatatest_output");
+    AnalysisDataService::Instance().deepRemoveGroup("chopdatatest_output");
   }
 
 private:

Code/Mantid/Framework/DataHandling/src/LoadSassena.cpp

@@ -29,6 +29,7 @@ Dataset '''fqt''' is split into two workspaces, one for the real part and the ot
 #include "MantidAPI/FileProperty.h"
 #include "MantidAPI/NumericAxis.h"
 #include "MantidAPI/Axis.h"
+#include "MantidAPI/AnalysisDataService.h"
 #include "MantidDataObjects/Workspace2D.h"
 #include "MantidKernel/Exception.h"
 #include "MantidKernel/Unit.h"
@@ -338,10 +339,12 @@ void LoadSassena::exec()
   //auto gws=boost::dynamic_pointer_cast<API::WorkspaceGroup>(getProperty("OutputWorkspace"));
   //API::WorkspaceGroup_sptr gws=getProperty("OutputWorkspace");
   API::Workspace_sptr ows=getProperty("OutputWorkspace");
+
   API::WorkspaceGroup_sptr gws=boost::dynamic_pointer_cast<API::WorkspaceGroup>(ows);
-  if(gws)
+  if(gws && API::AnalysisDataService::Instance().doesExist( gws->name() ) )
   {
-    gws->deepRemoveAll(); // remove workspace members
+    //gws->deepRemoveAll(); // remove workspace members
+    API::AnalysisDataService::Instance().deepRemoveGroup( gws->name() );
   }
   else
   {

Code/Mantid/MantidQt/CustomInterfaces/src/MuonAnalysis.cpp

@@ -1553,7 +1553,6 @@ void MuonAnalysis::getDeadTimeFromFile(const QString & fileName)
         QMessageBox::information(this, "Mantid - Muon Analysis", "This kind of workspace is not compatible with applying dead times");
         return;
       }
-      deadTimeTables->deepRemoveAll();
       Mantid::API::AnalysisDataService::Instance().remove("tempMuonDeadTime123qwe");
     }
   }