Mantid
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Mantid::MDAlgorithms::DisabledProperty Class Reference

Small class to diable propery on interface. More...

Inheritance diagram for Mantid::MDAlgorithms::DisabledProperty:
Mantid::Kernel::EnabledWhenProperty Mantid::Kernel::IPropertySettings

Public Member Functions

bool checkCriterion (const IPropertyManager *) const override
 Checks that the specified property matches the criteria given.
 
 DisabledProperty ()
 
- Public Member Functions inherited from Mantid::Kernel::EnabledWhenProperty
virtual bool checkComparison (const IPropertyManager *algo) const
 Checks two EnabledWhenProperty objects match the logic operator specified and returns the result of both of them.
 
IPropertySettingsclone () const override
 Make a copy of the present type of validator.
 
std::vector< std::string > dependsOn (const std::string &thisProp) const override
 Other properties that this property depends on.
 
 EnabledWhenProperty (const EnabledWhenProperty &conditionOne, const EnabledWhenProperty &conditionTwo, eLogicOperator logicOperator)
 Constructs a EnabledWhenProperty object which copies two already constructed EnabledWhenProperty objects and returns the result of both of them with the specified logic operator.
 
 EnabledWhenProperty (const EnabledWhenProperty &other)
 Copy constructor.
 
 EnabledWhenProperty (const std::string &otherPropName, const ePropertyCriterion when, const std::string &value="")
 Constructs a EnabledWhenProperty object which checks the property with name given and if it matches the criteria enables it.
 
 EnabledWhenProperty (std::shared_ptr< EnabledWhenProperty > &&conditionOne, std::shared_ptr< EnabledWhenProperty > &&conditionTwo, eLogicOperator logicOperator)
 Constructs a EnabledWhenProperty object which takes ownership of two already constructed EnabledWhenProperty objects and returns the result of both of them with the specified logic operator.
 
bool isEnabled (const IPropertyManager *algo) const override
 Return true/false based on whether the other property satisfies the criterion.
 
bool isVisible (const IPropertyManager *algo) const override
 Return true always.
 
- Public Member Functions inherited from Mantid::Kernel::IPropertySettings
virtual bool applyChanges (const IPropertyManager *algo, const std::string &currentPropName) const
 Overload this virtual function in order to modify the current property based on changes to other properties.
 
 IPropertySettings ()=default
 Constructor.
 
virtual bool isConditionChanged (const IPropertyManager *algo, const std::string &changedPropName="") const
 to verify if the properties, this one depends on have changed or other special condition occurs which needs the framework to react to
 
virtual ~IPropertySettings ()=default
 Destructor.
 

Additional Inherited Members

- Protected Member Functions inherited from Mantid::Kernel::EnabledWhenProperty
 EnabledWhenProperty ()=default
 Protected Constructor for derived classes to skip setting up the comparator in the base class as they will handle it.
 
std::string getPropertyValue (const IPropertyManager *algo) const
 Checks the algorithm and property are both valid and attempts to get the value associated with the property.
 
- Protected Member Functions inherited from Mantid::Kernel::IPropertySettings
 IPropertySettings (const IPropertySettings &)=default
 
- Protected Attributes inherited from Mantid::Kernel::EnabledWhenProperty
std::shared_ptr< PropertyDetailsm_propertyDetails = nullptr
 Holds the various details used within the comparison.
 

Detailed Description

Small class to diable propery on interface.

Definition at line 34 of file BaseConvertToDiffractionMDWorkspace.cpp.

Constructor & Destructor Documentation

◆ DisabledProperty()

Mantid::MDAlgorithms::DisabledProperty::DisabledProperty ( )
inline

Definition at line 36 of file BaseConvertToDiffractionMDWorkspace.cpp.

Member Function Documentation

◆ checkCriterion()

bool Mantid::MDAlgorithms::DisabledProperty::checkCriterion ( const IPropertyManager algo) const
inlineoverridevirtual

Checks that the specified property matches the criteria given.

Does the validator fulfill the criterion based on the other property values?

Parameters
algo:: The pointer to the algorithm to check the property values of
Returns
:: True if the criteria are met else false
Exceptions
:Throws on any problems (e.g. property missing from algorithm)

Reimplemented from Mantid::Kernel::EnabledWhenProperty.

Definition at line 37 of file BaseConvertToDiffractionMDWorkspace.cpp.


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