diff --git a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SofQCommon.h b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SofQCommon.h index 6298e3486a2597e2df505b2d7b26088bf06087de..38ec355ca4dbf0312abc8e6b3ac92d0b8b161b63 100644 --- a/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SofQCommon.h +++ b/Code/Mantid/Framework/Algorithms/inc/MantidAlgorithms/SofQCommon.h @@ -3,30 +3,30 @@ #include "MantidAPI/Algorithm.h" #include "MantidGeometry/IDetector.h" -// number of small routines used by all SofQW algorithms intended to provide united user interface to all SofQ algorihtms. - +// Two small routines used by all SofQW algorithms intended to provide united user interface to all SofQ algorihtms. namespace Mantid { namespace Algorithms { - struct SofQCommon - { + struct SofQCommon + { - /// E Mode - int m_emode; - /// EFixed has been provided - bool m_efixedGiven; - /// EFixed - double m_efixed; + /// E Mode + int m_emode; + /// EFixed has been provided + bool m_efixedGiven; + /// EFixed + double m_efixed; - SofQCommon():m_emode(0), m_efixedGiven(false), m_efixed(0.0){} + //Constructor + SofQCommon():m_emode(0), m_efixedGiven(false), m_efixed(0.0){} + // init the class parameters, defined above + void initCachedValues(API::MatrixWorkspace_const_sptr workspace, API::Algorithm *const hostAlgorithm); - void initCachedValues(API::MatrixWorkspace_const_sptr workspace, API::Algorithm *const hostAlgorithm); - - /// Get the efixed value for the given detector - double getEFixed(Geometry::IDetector_const_sptr det) const; - }; + /// Get the efixed value for the given detector + double getEFixed(Geometry::IDetector_const_sptr det) const; + }; } } diff --git a/Code/Mantid/Framework/Algorithms/src/SofQCommon.cpp b/Code/Mantid/Framework/Algorithms/src/SofQCommon.cpp index 30f6e5501a5ea7ab56944eb3268dab4727e73046..25c8558266a6c0af446fc15e1d4bd3527cc239a8 100644 --- a/Code/Mantid/Framework/Algorithms/src/SofQCommon.cpp +++ b/Code/Mantid/Framework/Algorithms/src/SofQCommon.cpp @@ -5,10 +5,8 @@ namespace Mantid namespace Algorithms { /** The procedure analyses emode and efixed properties provided to the algorithm and identify the energy analysis mode and the way the properties are defined - @param workspace :: input workspace which may or may not have incident energy property (Ei) attached to it as the run log - @param hostAlgorithm :: the pointer to SofQ algorithm hosting the base class. This algorithm expects to have EMode and EFixed properties attached to it. - - + *@param workspace :: input workspace which may or may not have incident energy property (Ei) attached to it as the run log + *@param hostAlgorithm :: the pointer to SofQ algorithm hosting the base class. This algorithm expects to have EMode and EFixed properties attached to it. */ void SofQCommon::initCachedValues(API::MatrixWorkspace_const_sptr workspace, API::Algorithm *const hostAlgorithm) { @@ -52,10 +50,6 @@ namespace Mantid } } - - - - /** * Return the efixed for this detector. In Direct mode this has to be property set up earlier and in Indirect mode it may be the property of a component if not specified globally for the instrument. @@ -83,6 +77,6 @@ namespace Mantid return efixed; } - + } } \ No newline at end of file