MantidQt::MantidWidgets::AlgorithmHintStrategy Class Reference

AlgorithmHintStrategy : Produces hints using a given algorithm's properties. More...

#include <AlgorithmHintStrategy.h>

Inheritance diagram for MantidQt::MantidWidgets::AlgorithmHintStrategy:

Public Member Functions
	AlgorithmHintStrategy (Mantid::API::IAlgorithm_sptr algorithm, std::vector< std::string > blacklist)
	AlgorithmHintStrategy (std::string const &algorithmName, std::vector< std::string > blacklist)
std::vector< Hint >	createHints () override
	Create a list of hints for auto completion. More...
bool	isBlacklisted (std::string const &propertyName)
Public Member Functions inherited from MantidQt::MantidWidgets::HintStrategy
virtual std::vector< Hint >	createHints ()=0
	Create a list of hints for auto completion. More...
	HintStrategy ()
virtual	~HintStrategy ()=default

Private Attributes
Mantid::API::IAlgorithm_sptr	m_algorithm
std::vector< std::string >	m_blacklist

Detailed Description

AlgorithmHintStrategy : Produces hints using a given algorithm's properties.

Definition at line 19 of file AlgorithmHintStrategy.h.

Constructor & Destructor Documentation

AlgorithmHintStrategy() [1/2]

MantidQt::MantidWidgets::AlgorithmHintStrategy::AlgorithmHintStrategy ( Mantid::API::IAlgorithm_sptr  algorithm, std::vector< std::string >  blacklist  )

inline

Definition at line 21 of file AlgorithmHintStrategy.h.

AlgorithmHintStrategy() [2/2]

MantidQt::MantidWidgets::AlgorithmHintStrategy::AlgorithmHintStrategy ( std::string const &  algorithmName, std::vector< std::string >  blacklist  )

inline

Definition at line 24 of file AlgorithmHintStrategy.h.

Member Function Documentation

createHints()

std::vector< Hint > MantidQt::MantidWidgets::AlgorithmHintStrategy::createHints ( )

inlineoverridevirtual

Create a list of hints for auto completion.

This is overwritten on the python side. However, leaving this as abstract method causes SIP issues in _common.sip

Returns

A map of keywords to short descriptions for the keyword.

Implements MantidQt::MantidWidgets::HintStrategy.

Definition at line 32 of file AlgorithmHintStrategy.h.

References m_algorithm.

isBlacklisted()

bool MantidQt::MantidWidgets::AlgorithmHintStrategy::isBlacklisted ( std::string const &  propertyName )

inline

Definition at line 28 of file AlgorithmHintStrategy.h.

References m_blacklist.

Member Data Documentation

m_algorithm

Mantid::API::IAlgorithm_sptr MantidQt::MantidWidgets::AlgorithmHintStrategy::m_algorithm

private

Definition at line 48 of file AlgorithmHintStrategy.h.

Referenced by createHints().

m_blacklist

std::vector<std::string> MantidQt::MantidWidgets::AlgorithmHintStrategy::m_blacklist

private

Definition at line 49 of file AlgorithmHintStrategy.h.

Referenced by isBlacklisted().

---

The documentation for this class was generated from the following file:

• qt/widgets/common/inc/MantidQtWidgets/Common/AlgorithmHintStrategy.h