Enumerated string property

[dmitry-ganyushin]

7509: [Story] create EnumeratedStringProperty, new approach

Description of work

Creating EnumeratedStringProperty structure to simplify string properties in Mantid that are restricted to specific values. This new property type will replace most current string properties.

[rboston628]

remove this line

[dmitry-ganyushin]

If I remove it, I have the following compilation error:

/home/yvg/mantid/Framework/Kernel/inc/MantidKernel/EnumeratedStringProperty.hxx:279:9: error: 'class Mantid::Kernel::EnumeratedStringProperty<{anonymous}::TypeMode, (& {anonymous}::typeOptions)>' has no member named 'm_value'; did you mean 'value'?
  279 |   this->m_value = static_cast<EnumeratedString<E, names>>(value);
      |   ~~~~~~^~~~~~~
      |   value

[peterfpeterson]

I think he means the commented out line of code

[peterfpeterson]

Why does this need to only check the first 1897 characters returned?

[dmitry-ganyushin]

The missing part of the docs string here contains:
BinningMode(Input) *string* ...
It looks like the expected_doc string is generated during build, and instead of *string* contains some machine-generated symbols because of a new object EnumeratedStringProperty. Right now I don't have a better solution.

[peterfpeterson]

Please add a comment in the code that describes this oddity. Future you will thank current you for being so forward thinking in explaining why in a comment.

[dmitry-ganyushin]

Added a comment

[peterfpeterson]

This would greatly benefit from an additional section/page in the developer documentation explaining how to use it. It would benefit from linking to some of these algorithm cpp files as examples.

Also, you deleted most of the PR template (example: how to test).

[rboston628]

Pulled, built, tested in workbench with this script:

# import mantid algorithms, numpy and matplotlib
from mantid.simpleapi import *
from mantid.api import AlgorithmManager
import matplotlib.pyplot as plt
import numpy as np
from mantid.testing import assert_almost_equal as assert_wksp_equal

ws = mtd.unique_name(prefix="test_")
dataX = [1, 2, 3, 4, 5, 6]
dataY = [6, 6, 7, 6, 6]
CreateWorkspace(
    OutputWorkspace=ws,
    DataX = dataX,
    DataY = dataY,
    NSpec=1,
)

# check AddSampleLog

strprop = mtd.unique_name(prefix="prop_")
randomtext = mtd.unique_name(64)
AddSampleLog(
    Workspace=ws,
    LogName=strprop,
    LogText=randomtext,
    LogType="String",
)

number = 1.1234

defprop = mtd.unique_name(prefix="prop_")
AddSampleLog(
    Workspace=ws,
    LogName=defprop,
    LogText=str(number),
    LogType="Number",
)

doubleprop = mtd.unique_name(prefix="prop_")
AddSampleLog(
    Workspace=ws,
    LogName=doubleprop,
    LogText=str(number),
    LogType="Number",
    NumberType="Double",
)

run = mtd[ws].run()
assert run.getProperty(strprop).value == randomtext
assert run.getProperty(defprop).value == number
assert run.getProperty(doubleprop).value == number

# check Rebin

Rebin(
    InputWorkspace=ws,
    OutputWorkspace=ws+"_default",
    Params=(1, 2, 6),
)

Rebin(
    InputWorkspace=ws,
    OutputWorkspace=ws+"_linear",
    Params=(1, -2, 6),
    BinningMode="Linear",
)

CreateWorkspace(
    OutputWorkspace="exp_lin",
    DataX = [dataX[0], dataX[2], dataX[4], dataX[-1]],
    DataY = [sum(dataY[i:i+2]) for i in range(0, 6, 2)],
    NSpec=1,
)
assert_wksp_equal(ws+"_default", ws+"_linear")
assert_wksp_equal(ws+"_default", "exp_lin")

Rebin(
    InputWorkspace=ws,
    OutputWorkspace=ws+"_log",
    Params=(1, 2, 6),
    BinningMode="Logarithmic",
)
CreateWorkspace(
    OutputWorkspace="exp_log",
    DataX = [dataX[0], dataX[2], dataX[5]],
    DataY = [sum(dataY[0:2]), sum(dataY[2:])],
    NSpec=1,
)
assert_wksp_equal(ws+"_log", "exp_log")


# check values
from mantid.api import AlgorithmManager
algo = AlgorithmManager.create("Rebin")
algo.initialize()
algo.setProperty("BinningMode", "Linear")
assert "Linear" == algo.getPropertyValue("BinningMode")
assert "Linear" == algo.getProperty("BinningMode").valueAsStr
assert "Linear" == algo.getProperty("BinningMode").value

This checks several of the algorithms changed to use EnumeratedStringProperty and verifies they work as expected. In particular, the value of the enumerated string can be accessed and compared to a string.