Refl UI options column doesn't handle lists properly

[Harry Jeffery]

If I wanted to set the Params and ThetaIn properties I might enter this: Params="1,2,3", ThetaIn=2.3

Currently this will not work as the options column cannot handle quoted commas.

Goals:

• Correctly handle quoted commas
• Allow quote characters to be escaped
• Allow escape characters to be escaped

[Harry Jeffery]

Refs #10380 Improve options parsing in Refl UI

We now support quoting values that contain commas, escaping quotes, and values that contain '='.

Changeset: 4f6f946fb5e4bf67540b076c9b178d947c4f5563

[Harry Jeffery]

Testing

In the Refl UI, the options column may be used to override the properties set when executing ReflectometryReductionOneAuto. Set some properties using it like so: Params='0.1,0.2,0.3', ThetaIn=2.3. Then check the algorithm history for the resulting IvsQ workspace. We don't care about the data in the workspace, just that the properties were overridden correctly for ReflectometryReductionOneAuto

The only column you *need* to fill to process a row is the Run(s) column. Some valid values to test with: 13460,13462,13469,13470

• Verify that the options column now supports a quoted comma separated list of doubles
• Verify that the algorithm properties are correctly overridden

[Owen Arnold]

This works, but is lacking automated testing. I would like to see the string parsing put under test so that we can check that it's correctly processing the variables.. At the moment, you have this parseOptionsString as a protected member, which is right, because we only want to expose notify as a public member.

In order to make this testable, any of the following would be OK.

• static public member
• free function
• composition

Composition would be my preferred option. My thinking for this is that may end up being a sufficiently complex piece of logic in its own right. For example, it currently doesn't (but should) stop you providing options that are already in some way specified as part of the table. but I'll let you make a choice about how you want to do this for now.

[Harry Jeffery]

Waiting for #10364 to pass before unit test can be added.

[Harry Jeffery]

Refs #10380 Generalise parseOptionsString → parseKeyValueString

As a static interface it can now be unit tested appropriately.

Changeset: 2e6560159dab6040a7f35766119184185c6df41d

[Harry Jeffery]

Refs #10380 Unit test parseKeyValueString

Changeset: 1514244018d0486e6fd8051b93fcb7fc8f4a73fc

[Harry Jeffery]

Refs #10380 Correct documentation

Changeset: c2c4630e1936913870dd3dec2aebf46f481cf385

[Harry Jeffery]

Additional Testing

• Inspect changes
• Verify new unit test is passing

[Harry Jeffery]

Merge branch 'master' into feature/10380_refl_ui_options_col_quote_commas

Full changeset: ​39cc41b8588ea25d2487c161b186a447b07f6fb6

[Owen Arnold]

Merge remote-tracking branch 'origin/feature/10380_refl_ui_options_col_quote_commas'

Full changeset: ​5917d700d77a5b16ef636d1605862270cc9e4051

[Stuart Campbell]

This ticket has been transferred to github issue ​11222