|
| template<typename T > |
| void | expectGetProperty (std::string const &propertyName, PropertyWithValue< T > *prop) |
| |
| | MOCK_CONST_METHOD0 (alias, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (aliasDeprecated, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (categories, const std::vector< std::string >()) |
| |
| | MOCK_CONST_METHOD0 (category, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (categorySeparator, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (executionState, ExecutionState()) |
| |
| | MOCK_CONST_METHOD0 (getAlgorithmID, AlgorithmID()) |
| |
| | MOCK_CONST_METHOD0 (getAlgStartupLogging, bool()) |
| |
| | MOCK_CONST_METHOD0 (getAlwaysStoreInADS, bool()) |
| |
| | MOCK_CONST_METHOD0 (getLoggingOffset, int()) |
| |
| | MOCK_CONST_METHOD0 (getProperties, const std::vector< Mantid::Kernel::Property * > &()) |
| |
| | MOCK_CONST_METHOD0 (helpURL, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (isChild, bool()) |
| |
| | MOCK_CONST_METHOD0 (isExecuted, bool()) |
| |
| | MOCK_CONST_METHOD0 (isInitialized, bool()) |
| |
| | MOCK_CONST_METHOD0 (isLogging, bool()) |
| |
| | MOCK_CONST_METHOD0 (isReadyForGarbageCollection, bool()) |
| |
| | MOCK_CONST_METHOD0 (isRunning, bool()) |
| |
| | MOCK_CONST_METHOD0 (name, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (propertyCount, size_t()) |
| |
| | MOCK_CONST_METHOD0 (resultState, ResultState()) |
| |
| | MOCK_CONST_METHOD0 (seeAlso, const std::vector< std::string >()) |
| |
| | MOCK_CONST_METHOD0 (summary, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (toJson, ::Json::Value()) |
| |
| | MOCK_CONST_METHOD0 (toString, std::string()) |
| |
| | MOCK_CONST_METHOD0 (validateProperties, bool()) |
| |
| | MOCK_CONST_METHOD0 (version, int()) |
| |
| | MOCK_CONST_METHOD0 (workspaceMethodInputProperty, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (workspaceMethodName, const std::string()) |
| |
| | MOCK_CONST_METHOD0 (workspaceMethodOn, const std::vector< std::string >()) |
| |
| | MOCK_CONST_METHOD1 (addObserver, void(const Poco::AbstractObserver &)) |
| |
| | MOCK_CONST_METHOD1 (asJson, ::Json::Value(bool)) |
| |
| | MOCK_CONST_METHOD1 (asString, std::string(bool)) |
| |
| | MOCK_CONST_METHOD1 (existsProperty, bool(const std::string &)) |
| |
| | MOCK_CONST_METHOD1 (getPointerToProperty, Mantid::Kernel::Property *(const std::string &)) |
| |
| | MOCK_CONST_METHOD1 (getPointerToPropertyOrdinal, Mantid::Kernel::Property *(const int &)) |
| |
| | MOCK_CONST_METHOD1 (getProperty, TypedValue(const std::string &)) |
| |
| | MOCK_CONST_METHOD1 (getPropertyValue, std::string(const std::string &)) |
| |
| | MOCK_CONST_METHOD1 (removeObserver, void(const Poco::AbstractObserver &)) |
| |
| | MOCK_CONST_METHOD1 (setChildEndProgress, void(const double)) |
| |
| | MOCK_CONST_METHOD1 (setChildStartProgress, void(const double)) |
| |
| | MOCK_METHOD ((std::vector< std::string >), getDeclaredPropertyNames,(),(const, noexcept)) |
| |
| | MOCK_METHOD0 (cancel, void()) |
| |
| | MOCK_METHOD0 (clear, void()) |
| |
| | MOCK_METHOD0 (execute, bool()) |
| |
| | MOCK_METHOD0 (executeAsChildAlg, void()) |
| |
| | MOCK_METHOD0 (executeAsync, Poco::ActiveResult< bool >()) |
| |
| | MOCK_METHOD0 (initialize, void()) |
| |
| | MOCK_METHOD0 (resetProperties, void()) |
| |
| | MOCK_METHOD0 (validateInputs, std::map< std::string, std::string >()) |
| |
| | MOCK_METHOD1 (enableHistoryRecordingForChild, void(const bool)) |
| |
| | MOCK_METHOD1 (setAlgStartupLogging, void(const bool)) |
| |
| | MOCK_METHOD1 (setAlwaysStoreInADS, void(const bool)) |
| |
| | MOCK_METHOD1 (setChild, void(const bool)) |
| |
| | MOCK_METHOD1 (setLogging, void(const bool)) |
| |
| | MOCK_METHOD1 (setLoggingOffset, void(const int)) |
| |
| | MOCK_METHOD1 (setRethrows, void(const bool)) |
| |
| | MOCK_METHOD1 (takeProperty, std::unique_ptr< Mantid::Kernel::Property >(const size_t)) |
| |
| | MOCK_METHOD2 (declareOrReplaceProperty, void(std::unique_ptr< Mantid::Kernel::Property >, const std::string &)) |
| |
| | MOCK_METHOD2 (declareProperty, void(std::unique_ptr< Mantid::Kernel::Property >, const std::string &)) |
| |
| | MOCK_METHOD2 (removeProperty, void(const std::string &, const bool)) |
| |
| | MOCK_METHOD2 (setPropertiesWithString, void(const std::string &, const std::unordered_set< std::string > &)) |
| |
| | MOCK_METHOD2 (setPropertyOrdinal, void(const int &, const std::string &)) |
| |
| | MOCK_METHOD2 (setPropertyValue, void(const std::string &, const std::string &)) |
| |
| | MOCK_METHOD2 (setPropertyValueFromJson, void(const std::string &, const Json::Value &)) |
| |
| | MOCK_METHOD3 (setProperties, void(const ::Json::Value &, const std::unordered_set< std::string > &, bool)) |
| |
| | MOCK_METHOD3 (setProperties, void(const std::string &, const std::unordered_set< std::string > &, bool)) |
| |
| virtual void | addObserver (const Poco::AbstractObserver &observer) const =0 |
| | Add an observer for a notification.
|
| |
| virtual const std::string | alias () const =0 |
| | function to return any aliases of the algorithm.
|
| |
| virtual const std::string | aliasDeprecated () const =0 |
| | Expiration date (in ISO8601 format) for the algorithm aliases. Empty if no expiration date.
|
| |
| virtual void | cancel ()=0 |
| | Raises the cancel flag.
|
| |
| virtual const std::vector< std::string > | categories () const =0 |
| | Function to return all of the categories that contain this algorithm.
|
| |
| virtual const std::string | category () const =0 |
| | function to return a category of the algorithm.
|
| |
| virtual const std::string | categorySeparator () const =0 |
| | Function to return the separator token for the category string.
|
| |
| virtual void | enableHistoryRecordingForChild (const bool on)=0 |
| | If true history will be recorded for a child.
|
| |
| virtual bool | execute ()=0 |
| | System execution.
|
| |
| virtual void | executeAsChildAlg ()=0 |
| | Execute as a Child Algorithm, with try/catch.
|
| |
| virtual Poco::ActiveResult< bool > | executeAsync ()=0 |
| | Asynchronous execution of the algorithm.
|
| |
| virtual ExecutionState | executionState () const =0 |
| | Gets the current execution state.
|
| |
| virtual AlgorithmID | getAlgorithmID () const =0 |
| | Algorithm ID.
|
| |
| virtual bool | getAlgStartupLogging () const =0 |
| | get the state of Logging of start and end messages
|
| |
| virtual bool | getAlwaysStoreInADS () const =0 |
| | To query whether the output is stored in the analysis data service.
|
| |
| virtual int | getLoggingOffset () const =0 |
| | returns the logging priority offset
|
| |
| virtual const std::string | helpURL () const =0 |
| | function to return an optional URL for documentation.
|
| |
| virtual void | initialize ()=0 |
| | Initialization method invoked by the framework.
|
| |
| virtual bool | isChild () const =0 |
| | To query whether algorithm is a child. Default to false.
|
| |
| virtual bool | isExecuted () const =0 |
| | Check whether the algorithm has been executed sucessfully.
|
| |
| virtual bool | isInitialized () const =0 |
| | Check whether the algorithm is initialized properly.
|
| |
| virtual bool | isLogging () const =0 |
| | returns the status of logging, True = enabled
|
| |
| virtual bool | isReadyForGarbageCollection () const =0 |
| | True if the algorithm is ready for garbage collection.
|
| |
| virtual bool | isRunning () const =0 |
| | True if the algorithm is running.
|
| |
| virtual const std::string | name () const =0 |
| | function to return a name of the algorithm, must be overridden in all algorithms
|
| |
| virtual void | removeObserver (const Poco::AbstractObserver &observer) const =0 |
| | Remove an observer.
|
| |
| virtual ResultState | resultState () const =0 |
| | Gets the currnet result State.
|
| |
| virtual const std::vector< std::string > | seeAlso () const =0 |
| | Function to return all of the seeAlso algorithms related to this algorithm.
|
| |
| virtual void | setAlgStartupLogging (const bool enabled)=0 |
| | disable Logging of start and end messages
|
| |
| virtual void | setAlwaysStoreInADS (const bool doStore)=0 |
| | Set whether we always store the output in the analysis data service.
|
| |
| virtual void | setChild (const bool isChild)=0 |
| | To set whether algorithm is a child.
|
| |
| virtual void | setChildEndProgress (const double endProgress) const =0 |
| | setting the child end progress
|
| |
| virtual void | setChildStartProgress (const double startProgress) const =0 |
| | setting the child start progress
|
| |
| virtual void | setLogging (const bool value)=0 |
| | Logging can be disabled by passing a value of false.
|
| |
| virtual void | setLoggingOffset (const int value)=0 |
| | gets the logging priority offset
|
| |
| virtual void | setRethrows (const bool rethrow)=0 |
| | To query whether an algorithm should rethrow exceptions when executing.
|
| |
| virtual const std::string | summary () const =0 |
| | function returns a summary message that will be displayed in the default GUI, and in the help.
|
| |
| virtual ::Json::Value | toJson () const =0 |
| | Serialize an algorithm as Json.
|
| |
| virtual std::string | toString () const =0 |
| | Serialize an algorithm.
|
| |
| virtual std::map< std::string, std::string > | validateInputs ()=0 |
| | Method checking errors on ALL the inputs, before execution.
|
| |
| virtual int | version () const =0 |
| | function to return a version of the algorithm, must be overridden in all algorithms
|
| |
| virtual const std::string | workspaceMethodName () const =0 |
| |
| virtual const std::vector< std::string > | workspaceMethodOn () const =0 |
| | Returns a set of class names that will have the method attached.
|
| |
| virtual const std::string | workspaceMethodInputProperty () const =0 |
| | Returns the name of the input workspace property used by the calling object.
|
| |
| virtual ::Json::Value | asJson (bool withDefaultValues=false) const =0 |
| | Return the property manager serialized as a json object.
|
| |
| virtual std::string | asString (bool withDefaultValues=false) const =0 |
| | Return the property manager serialized as a string.
|
| |
| virtual void | declareOrReplaceProperty (std::unique_ptr< Property > p, const std::string &doc="")=0 |
| | Function to declare properties (i.e. store them)
|
| |
| void | declareProperty (const std::string &name, const char *value, const std::string &doc, IValidator_sptr validator=std::make_shared< NullValidator >(), const unsigned int direction=Direction::Input) |
| | Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).
|
| |
| void | declareProperty (const std::string &name, const char *value, const unsigned int direction) |
| | Add a property of string type to the list of managed properties.
|
| |
| void | declareProperty (const std::string &name, const char *value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc=std::string(), const unsigned int direction=Direction::Input) |
| | Specialised version of declareProperty template method to prevent the creation of a PropertyWithValue of type const char* if an argument in quotes is passed (it will be converted to a string).
|
| |
| template<typename T > |
| void | declareProperty (const std::string &name, T value, const std::string &doc, const unsigned int direction=Direction::Input) |
| | Add a property to the list of managed properties with no validator.
|
| |
| template<typename T > |
| void | declareProperty (const std::string &name, T value, const unsigned int direction) |
| | Add a property of the template type to the list of managed properties.
|
| |
| template<typename T > |
| void | declareProperty (const std::string &name, T value, IValidator_sptr validator=std::make_shared< NullValidator >(), const std::string &doc="", const unsigned int direction=Direction::Input) |
| | Add a property of the template type to the list of managed properties.
|
| |
| virtual void | declareProperty (std::unique_ptr< Property > p, const std::string &doc="")=0 |
| | Function to declare properties (i.e. store them)
|
| |
| virtual bool | existsProperty (const std::string &name) const =0 |
| | Checks whether the named property is already in the list of managed property.
|
| |
| virtual void | filterByProperty (Mantid::Kernel::LogFilter *, const std::vector< std::string > &) |
| |
| virtual std::vector< std::string > | getDeclaredPropertyNames () const noexcept=0 |
| | Get the list of managed property names.
|
| |
| virtual Property * | getPointerToProperty (const std::string &name) const =0 |
| | Get a pointer to property by name.
|
| |
| virtual const std::vector< Property * > & | getProperties () const =0 |
| | Get the list of managed properties.
|
| |
| std::vector< Property * > | getPropertiesInGroup (const std::string &group) const |
| | Get the list of managed properties in a given group.
|
| |
| virtual TypedValue | getProperty (const std::string &name) const =0 |
| | Get the value of a property.
|
| |
| virtual std::string | getPropertyValue (const std::string &name) const =0 |
| | Get the value of a property as a string.
|
| |
| virtual size_t | propertyCount () const =0 |
| | Returns the number of properties under management.
|
| |
| virtual void | removeProperty (const std::string &name, const bool delproperty=true)=0 |
| | Removes the property from management.
|
| |
| virtual void | resetProperties ()=0 |
| |
| virtual void | setProperties (const ::Json::Value &jsonValue, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0 |
| | Sets all the properties from a json object.
|
| |
| virtual void | setProperties (const std::string &propertiesJson, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >(), bool createMissing=false)=0 |
| | Sets all properties from a string.
|
| |
| virtual void | setPropertiesWithString (const std::string &propertiesString, const std::unordered_set< std::string > &ignoreProperties=std::unordered_set< std::string >())=0 |
| | Sets all the declared properties from a string.
|
| |
| IPropertyManager * | setProperty (const std::string &name, const char *value) |
| | Specialised version of setProperty template method to handle const char *.
|
| |
| IPropertyManager * | setProperty (const std::string &name, const std::string &value) |
| | Specialised version of setProperty template method to handle std::string.
|
| |
| template<typename T > |
| IPropertyManager * | setProperty (const std::string &name, const T &value) |
| | Templated method to set the value of a PropertyWithValue.
|
| |
| template<typename T > |
| IPropertyManager * | setProperty (const std::string &name, std::unique_ptr< T > value) |
| | Templated method to set the value of a PropertyWithValue from a std::unique_ptr.
|
| |
| void | setPropertyGroup (const std::string &name, const std::string &group) |
| | Set the group for a given property.
|
| |
| virtual void | setPropertyOrdinal (const int &index, const std::string &value)=0 |
| | Set the value of a property by an index.
|
| |
| void | setPropertySettings (const std::string &name, std::unique_ptr< IPropertySettings > settings) |
| |
| virtual void | setPropertyValue (const std::string &name, const std::string &value)=0 |
| | Sets property value from a string.
|
| |
| virtual void | setPropertyValueFromJson (const std::string &name, const Json::Value &value)=0 |
| | Sets property value from a Json::Value.
|
| |
| virtual std::unique_ptr< Property > | takeProperty (const size_t index)=0 |
| | Removes the property from management and returns a pointer to it.
|
| |
| void | updatePropertyValues (const IPropertyManager &other) |
| | Update values of the existing properties.
|
| |
| virtual bool | validateProperties () const =0 |
| | Validates all the properties in the collection.
|
| |
| virtual | ~IPropertyManager ()=default |
| |