Refs #5371 method getItem overloaded

modified: ../Framework/API/inc/MantidAPI/WorkspaceGroup.h modified: ../Framework/API/src/WorkspaceGroup.cpp modified: ../Framework/API/test/WorkspaceGroupTest.h
mantidproject · May 22, 2012 · 7ff0ca0 · 7ff0ca0
1 parent 59800f6
commit 7ff0ca0
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/Code/Mantid/Framework/API/inc/MantidAPI/WorkspaceGroup.h b/Code/Mantid/Framework/API/inc/MantidAPI/WorkspaceGroup.h
@@ -75,6 +75,8 @@ class MANTID_API_DLL WorkspaceGroup : public Workspace
   size_t size() const { return m_wsNames.size(); }
   /// Return the ith workspace
   Workspace_sptr getItem(const size_t index) const;
+  /// Return the workspace by name
+  Workspace_sptr getItem(const std::string wsName) const;
   /// Prints the group to the screen using the logger at debug
   void print() const;
   /// Remove a name from the group

diff --git a/Code/Mantid/Framework/API/src/WorkspaceGroup.cpp b/Code/Mantid/Framework/API/src/WorkspaceGroup.cpp
@@ -93,6 +93,17 @@ Workspace_sptr WorkspaceGroup::getItem(const size_t index) const
   return AnalysisDataService::Instance().retrieve(m_wsNames[index]);
 }
 
+/**
+ * Return the workspace by name
+ * @param wsName The name of the workspace
+ * @throws an out_of_range error if the workspace'sname not contained in the group's list of workspace names
+ */
+Workspace_sptr WorkspaceGroup::getItem(const std::string wsName) const
+{
+  if ( !this->contains(wsName) )
+    throw std::out_of_range("Workspace "+wsName+" not contained in the group");
+  return AnalysisDataService::Instance().retrieve(wsName);
+}
 
 /// Empty all the entries out of the workspace group. Does not remove the workspaces from the ADS.
 void WorkspaceGroup::removeAll()

diff --git a/Code/Mantid/Framework/API/test/WorkspaceGroupTest.h b/Code/Mantid/Framework/API/test/WorkspaceGroupTest.h
@@ -51,6 +51,8 @@ class WorkspaceGroupTest : public CxxTest::TestSuite
     WorkspaceGroup_sptr group = makeGroup();
     Workspace_sptr ws1 = group->getItem(1);
     TS_ASSERT_EQUALS( ws1->name(), "ws1");
+    Workspace_sptr ws11 = group->getItem("ws1");
+    TS_ASSERT_EQUALS( ws1, ws11 );
   }
 
   void test_remove()