Skip to content

Commit

Permalink
Refs #8494. Initial class files.
Browse files Browse the repository at this point in the history
  • Loading branch information
arturbekasov committed Dec 11, 2013
1 parent 6ca4ece commit 829b099
Show file tree
Hide file tree
Showing 4 changed files with 189 additions and 0 deletions.
3 changes: 3 additions & 0 deletions Code/Mantid/Framework/WorkflowAlgorithms/CMakeLists.txt
Expand Up @@ -19,6 +19,7 @@ set ( SRC_FILES
src/HFIRLoad.cpp
src/HFIRSANSNormalise.cpp
src/MuonCalculateAsymmetry.cpp
src/MuonLoad.cpp
src/RefReduction.cpp
src/RefRoi.cpp
src/SANSBeamFinder.cpp
Expand Down Expand Up @@ -56,6 +57,7 @@ set ( INC_FILES
inc/MantidWorkflowAlgorithms/HFIRLoad.h
inc/MantidWorkflowAlgorithms/HFIRSANSNormalise.h
inc/MantidWorkflowAlgorithms/MuonCalculateAsymmetry.h
inc/MantidWorkflowAlgorithms/MuonLoad.h
inc/MantidWorkflowAlgorithms/RefReduction.h
inc/MantidWorkflowAlgorithms/RefRoi.h
inc/MantidWorkflowAlgorithms/SANSBeamFinder.h
Expand All @@ -70,6 +72,7 @@ set ( INC_FILES

set ( TEST_FILES
MuonCalculateAsymmetryTest.h
MuonLoadTest.h
SANSSolidAngleCorrectionTest.h
StepScanTest.h
)
Expand Down
@@ -0,0 +1,56 @@
#ifndef MANTID_WORKFLOWALGORITHMS_MUONLOAD_H_
#define MANTID_WORKFLOWALGORITHMS_MUONLOAD_H_

#include "MantidKernel/System.h"
#include "MantidAPI/Algorithm.h"

namespace Mantid
{
namespace WorkflowAlgorithms
{

/** MuonLoad : 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 MuonLoad : public API::Algorithm
{
public:
MuonLoad();
virtual ~MuonLoad();

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_MUONLOAD_H_ */
70 changes: 70 additions & 0 deletions Code/Mantid/Framework/WorkflowAlgorithms/src/MuonLoad.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/MuonLoad.h"

namespace Mantid
{
namespace WorkflowAlgorithms
{

// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(MuonLoad)



//----------------------------------------------------------------------------------------------
/** Constructor
*/
MuonLoad::MuonLoad()
{
}

//----------------------------------------------------------------------------------------------
/** Destructor
*/
MuonLoad::~MuonLoad()
{
}


//----------------------------------------------------------------------------------------------
/// Algorithm's name for identification. @see Algorithm::name
const std::string MuonLoad::name() const { return "MuonLoad";};

/// Algorithm's version for identification. @see Algorithm::version
int MuonLoad::version() const { return 1;};

/// Algorithm's category for identification. @see Algorithm::category
const std::string MuonLoad::category() const { return TODO: FILL IN A CATEGORY;}

//----------------------------------------------------------------------------------------------
/// Sets documentation strings for this algorithm
void MuonLoad::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 MuonLoad::init()
{
declareProperty(new WorkspaceProperty<>("InputWorkspace","",Direction::Input), "An input workspace.");
declareProperty(new WorkspaceProperty<>("OutputWorkspace","",Direction::Output), "An output workspace.");
}

//----------------------------------------------------------------------------------------------
/** Execute the algorithm.
*/
void MuonLoad::exec()
{
// TODO Auto-generated execute stub
}



} // namespace WorkflowAlgorithms
} // namespace Mantid
60 changes: 60 additions & 0 deletions Code/Mantid/Framework/WorkflowAlgorithms/test/MuonLoadTest.h
@@ -0,0 +1,60 @@
#ifndef MANTID_WORKFLOWALGORITHMS_MUONLOADTEST_H_
#define MANTID_WORKFLOWALGORITHMS_MUONLOADTEST_H_

#include <cxxtest/TestSuite.h>

#include "MantidWorkflowAlgorithms/MuonLoad.h"

using Mantid::WorkflowAlgorithms::MuonLoad;

class MuonLoadTest : 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 MuonLoadTest *createSuite() { return new MuonLoadTest(); }
static void destroySuite( MuonLoadTest *suite ) { delete suite; }


void test_Init()
{
MuonLoad alg;
TS_ASSERT_THROWS_NOTHING( alg.initialize() )
TS_ASSERT( alg.isInitialized() )
}

void test_exec()
{
// Name of the output workspace.
std::string outWSName("MuonLoadTest_OutputWS");

MuonLoad 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_MUONLOADTEST_H_ */

0 comments on commit 829b099

Please sign in to comment.