Skip to content

Commit

Permalink
Refs #8506. ScopedWorkspace: documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
arturbekasov committed Nov 29, 2013
1 parent 4a5ad36 commit 3096975
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion Code/Mantid/Framework/API/inc/MantidAPI/ScopedWorkspace.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,16 @@ namespace Mantid
{
namespace API
{
/** ScopedWorkspace : TODO: DESCRIPTION
/** ScopedWorkspace : scoped workspace ADS entry.
This class is provided for situations when you need a workspace to be in the ADS to run an
algorithm, but you don't really need to keep it there after the algorithm has finished. In
these circumstances you can create ScopedWorkspace, set it's name as a workspace property
for the algorithm and retrieve it when algorithm has finished. The workspace will be
removed from the ADS when the object goes out of scope, or exception is thrown.
Primarily, it was created to overcome some limitations of WorkspaceProperties, but it can be
useful in other places, e.g. tests.
Copyright © 2013 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
Expand Down

0 comments on commit 3096975

Please sign in to comment.