diff --git a/Framework/API/inc/MantidAPI/Algorithm.h b/Framework/API/inc/MantidAPI/Algorithm.h index d12aae549105e5f415c315f263d049e422f34d02..4bbb14e5da43588ccc57b0a142e297143160b78d 100644 --- a/Framework/API/inc/MantidAPI/Algorithm.h +++ b/Framework/API/inc/MantidAPI/Algorithm.h @@ -335,8 +335,10 @@ protected: friend class AlgorithmProxy; void initializeFromProxy(const AlgorithmProxy &); - void setExecutionState(const ExecutionState state); ///< Sets the current execution state - void setResultState(const ResultState state); ///< Sets the result execution state + void setExecutionState( + const ExecutionState state); ///< Sets the current execution state + void + setResultState(const ResultState state); ///< Sets the result execution state void store(); @@ -461,8 +463,8 @@ private: ExecutionState m_executionState; ///< the current execution state ResultState m_resultState; ///< the current result State - bool m_isExecuted; ///< Algorithm is executed flag - bool m_isChildAlgorithm; ///< Algorithm is a child algorithm + bool m_isExecuted; ///< Algorithm is executed flag + bool m_isChildAlgorithm; ///< Algorithm is a child algorithm bool m_recordHistoryForChild; ///< Flag to indicate whether history should be /// recorded. Applicable to child algs only bool m_alwaysStoreInADS; ///< Always store in the ADS, even for child algos diff --git a/Framework/API/inc/MantidAPI/AlgorithmProxy.h b/Framework/API/inc/MantidAPI/AlgorithmProxy.h index 0dd7cc982e1885124eea5791b0ef0406cc39da67..6355b90456e9c12f8da4e7f3d279a7e1d98076a2 100644 --- a/Framework/API/inc/MantidAPI/AlgorithmProxy.h +++ b/Framework/API/inc/MantidAPI/AlgorithmProxy.h @@ -185,14 +185,14 @@ private: const int m_version; ///< version of the real algorithm mutable boost::shared_ptr<Algorithm> - m_alg; ///< Shared pointer to a real algorithm. Created on demand - - ExecutionState m_executionState; ///< the current execution state - ResultState m_resultState; ///< the current result State - bool m_isExecuted; ///< Executed flag - bool m_isLoggingEnabled; ///< is the logging of the underlying algorithm - /// enabled - int m_loggingOffset; ///< the logging priority offset + m_alg; ///< Shared pointer to a real algorithm. Created on demand + + ExecutionState m_executionState; ///< the current execution state + ResultState m_resultState; ///< the current result State + bool m_isExecuted; ///< Executed flag + bool m_isLoggingEnabled; ///< is the logging of the underlying algorithm + /// enabled + int m_loggingOffset; ///< the logging priority offset bool m_isAlgStartupLoggingEnabled; /// Whether to log alg startup and /// closedown messages from the base class /// (default = true) diff --git a/Framework/API/inc/MantidAPI/IAlgorithm.h b/Framework/API/inc/MantidAPI/IAlgorithm.h index 1da6aa9b46b3d60b0a8861f3fe2920737de5c40c..d1100040f1c79894c31f9380b4900b7f5fde5a6a 100644 --- a/Framework/API/inc/MantidAPI/IAlgorithm.h +++ b/Framework/API/inc/MantidAPI/IAlgorithm.h @@ -28,9 +28,9 @@ namespace API { */ using AlgorithmID = void *; -///The current state of the algorithm object +/// The current state of the algorithm object enum class ExecutionState { UNINITIALIZED, INITIALIZED, RUNNING, FINISHED }; -///The validity of the results of the algorithm object +/// The validity of the results of the algorithm object enum class ResultState { INCOMPLETE, FAILED, SUCCESS }; /** diff --git a/Framework/API/src/Algorithm.cpp b/Framework/API/src/Algorithm.cpp index 838a59883f7a85725b8b8a797f70fa9a810cfc27..f30d14e5c8cc882e16298e5586f4cebda75d6ca7 100644 --- a/Framework/API/src/Algorithm.cpp +++ b/Framework/API/src/Algorithm.cpp @@ -140,7 +140,8 @@ bool Algorithm::isInitialized() const { /// Has the Algorithm already been executed bool Algorithm::isExecuted() const { - return ((executionState() == ExecutionState::FINISHED) && (resultState() == ResultState::SUCCESS)) ; + return ((executionState() == ExecutionState::FINISHED) && + (resultState() == ResultState::SUCCESS)); } //--------------------------------------------------------------------------------------------- diff --git a/Framework/API/src/AlgorithmProxy.cpp b/Framework/API/src/AlgorithmProxy.cpp index 2eaca0315620c6e655ff69caf04c4f887be0c96b..c8d9343331aaac781abd4c9791eb7c9c9115897b 100644 --- a/Framework/API/src/AlgorithmProxy.cpp +++ b/Framework/API/src/AlgorithmProxy.cpp @@ -119,8 +119,7 @@ ExecutionState AlgorithmProxy::executionState() const { } /// Gets the current result State -ResultState AlgorithmProxy::resultState() const { - return m_resultState; } +ResultState AlgorithmProxy::resultState() const { return m_resultState; } /// True if the algorithm is running. bool AlgorithmProxy::isRunning() const { @@ -129,7 +128,7 @@ bool AlgorithmProxy::isRunning() const { /// Has the AlgorithmProxy already been initialized bool AlgorithmProxy::isInitialized() const { - return true; //Algorithm Proxies will always initialize the algorithm + return true; // Algorithm Proxies will always initialize the algorithm } /// Has the AlgorithmProxy already been executed