Refs #8534. Files for new MuonCalculateAsymmetry algorithm.

Code/Mantid/Framework/WorkflowAlgorithms/CMakeLists.txt

@@ -18,6 +18,7 @@ set ( SRC_FILES
 	src/HFIRInstrument.cpp
 	src/HFIRLoad.cpp
 	src/HFIRSANSNormalise.cpp
+	src/MuonCalculateAsymmetry.cpp
 	src/RefReduction.cpp
 	src/RefRoi.cpp
 	src/SANSBeamFinder.cpp
@@ -54,6 +55,7 @@ set ( INC_FILES
 	inc/MantidWorkflowAlgorithms/HFIRInstrument.h
 	inc/MantidWorkflowAlgorithms/HFIRLoad.h
 	inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h
+	inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h
 	inc/MantidWorkflowAlgorithms/RefReduction.h
 	inc/MantidWorkflowAlgorithms/RefRoi.h
 	inc/MantidWorkflowAlgorithms/SANSBeamFinder.h
@@ -67,6 +69,7 @@ set ( INC_FILES
 )
 
 set ( TEST_FILES
+	MuonCalculateAsymmetryTest.h
 	SANSSolidAngleCorrectionTest.h
 	StepScanTest.h
 )

Code/Mantid/Framework/WorkflowAlgorithms/inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h

@@ -0,0 +1,56 @@
+#ifndef MANTID_WORKFLOWALGORITHMS_MUONCALCULATEASYMMETRY_H_
+#define MANTID_WORKFLOWALGORITHMS_MUONCALCULATEASYMMETRY_H_
+
+#include "MantidKernel/System.h"
+#include "MantidAPI/Algorithm.h"
+
+namespace Mantid
+{
+namespace WorkflowAlgorithms
+{
+
+  /** MuonCalculateAsymmetry : TODO: DESCRIPTION
+    
+    Copyright © 2013 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
+
+    This file is part of Mantid.
+
+    Mantid is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    Mantid is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+    File change history is stored at: <https://github.com/mantidproject/mantid>
+    Code Documentation is available at: <http://doxygen.mantidproject.org>
+  */
+  class DLLExport MuonCalculateAsymmetry  : public API::Algorithm
+  {
+  public:
+    MuonCalculateAsymmetry();
+    virtual ~MuonCalculateAsymmetry();
+
+    virtual const std::string name() const;
+    virtual int version() const;
+    virtual const std::string category() const;
+
+  private:
+    virtual void initDocs();
+    void init();
+    void exec();
+
+
+  };
+
+
+} // namespace WorkflowAlgorithms
+} // namespace Mantid
+
+#endif  /* MANTID_WORKFLOWALGORITHMS_MUONCALCULATEASYMMETRY_H_ */

Code/Mantid/Framework/WorkflowAlgorithms/src/MuonCalculateAsymmetry.cpp

@@ -0,0 +1,70 @@
+/*WIKI*
+TODO: Enter a full wiki-markup description of your algorithm here. You can then use the Build/wiki_maker.py script to generate your full wiki page.
+*WIKI*/
+
+#include "MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h"
+
+namespace Mantid
+{
+namespace WorkflowAlgorithms
+{
+
+  // Register the algorithm into the AlgorithmFactory
+  DECLARE_ALGORITHM(MuonCalculateAsymmetry)
+
+
+
+  //----------------------------------------------------------------------------------------------
+  /** Constructor
+   */
+  MuonCalculateAsymmetry::MuonCalculateAsymmetry()
+  {
+  }
+
+  //----------------------------------------------------------------------------------------------
+  /** Destructor
+   */
+  MuonCalculateAsymmetry::~MuonCalculateAsymmetry()
+  {
+  }
+
+
+  //----------------------------------------------------------------------------------------------
+  /// Algorithm's name for identification. @see Algorithm::name
+  const std::string MuonCalculateAsymmetry::name() const { return "MuonCalculateAsymmetry";};
+
+  /// Algorithm's version for identification. @see Algorithm::version
+  int MuonCalculateAsymmetry::version() const { return 1;};
+
+  /// Algorithm's category for identification. @see Algorithm::category
+  const std::string MuonCalculateAsymmetry::category() const { return TODO: FILL IN A CATEGORY;}
+
+  //----------------------------------------------------------------------------------------------
+  /// Sets documentation strings for this algorithm
+  void MuonCalculateAsymmetry::initDocs()
+  {
+    this->setWikiSummary("TODO: Enter a quick description of your algorithm.");
+    this->setOptionalMessage("TODO: Enter a quick description of your algorithm.");
+  }
+
+  //----------------------------------------------------------------------------------------------
+  /** Initialize the algorithm's properties.
+   */
+  void MuonCalculateAsymmetry::init()
+  {
+    declareProperty(new WorkspaceProperty<>("InputWorkspace","",Direction::Input), "An input workspace.");
+    declareProperty(new WorkspaceProperty<>("OutputWorkspace","",Direction::Output), "An output workspace.");
+  }
+
+  //----------------------------------------------------------------------------------------------
+  /** Execute the algorithm.
+   */
+  void MuonCalculateAsymmetry::exec()
+  {
+    // TODO Auto-generated execute stub
+  }
+
+
+
+} // namespace WorkflowAlgorithms
+} // namespace Mantid

Code/Mantid/Framework/WorkflowAlgorithms/test/MuonCalculateAsymmetryTest.h

@@ -0,0 +1,60 @@
+#ifndef MANTID_WORKFLOWALGORITHMS_MUONCALCULATEASYMMETRYTEST_H_
+#define MANTID_WORKFLOWALGORITHMS_MUONCALCULATEASYMMETRYTEST_H_
+
+#include <cxxtest/TestSuite.h>
+
+#include "MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h"
+
+using Mantid::WorkflowAlgorithms::MuonCalculateAsymmetry;
+
+class MuonCalculateAsymmetryTest : public CxxTest::TestSuite
+{
+public:
+  // This pair of boilerplate methods prevent the suite being created statically
+  // This means the constructor isn't called when running other tests
+  static MuonCalculateAsymmetryTest *createSuite() { return new MuonCalculateAsymmetryTest(); }
+  static void destroySuite( MuonCalculateAsymmetryTest *suite ) { delete suite; }
+
+
+  void test_Init()
+  {
+    MuonCalculateAsymmetry alg;
+    TS_ASSERT_THROWS_NOTHING( alg.initialize() )
+    TS_ASSERT( alg.isInitialized() )
+  }
+
+  void test_exec()
+  {
+    // Name of the output workspace.
+    std::string outWSName("MuonCalculateAsymmetryTest_OutputWS");
+
+    MuonCalculateAsymmetry alg;
+    TS_ASSERT_THROWS_NOTHING( alg.initialize() )
+    TS_ASSERT( alg.isInitialized() )
+    TS_ASSERT_THROWS_NOTHING( alg.setPropertyValue("REPLACE_PROPERTY_NAME_HERE!!!!", "value") );
+    TS_ASSERT_THROWS_NOTHING( alg.setPropertyValue("OutputWorkspace", outWSName) );
+    TS_ASSERT_THROWS_NOTHING( alg.execute(); );
+    TS_ASSERT( alg.isExecuted() );
+
+    // Retrieve the workspace from data service. TODO: Change to your desired type
+    Workspace_sptr ws;
+    TS_ASSERT_THROWS_NOTHING( ws = AnalysisDataService::Instance().retrieveWS<Workspace>(outWSName) );
+    TS_ASSERT(ws);
+    if (!ws) return;
+
+    // TODO: Check the results
+
+    // Remove workspace from the data service.
+    AnalysisDataService::Instance().remove(outWSName);
+  }
+
+  void test_Something()
+  {
+    TSM_ASSERT( "You forgot to write a test!", 0);
+  }
+
+
+};
+
+
+#endif /* MANTID_WORKFLOWALGORITHMS_MUONCALCULATEASYMMETRYTEST_H_ */