ParameterMap name tags are all over the code

[Martyn Gigg]

The ParameterMap contains parameter names such as pos,rot,masked that are used all over the codebase. This needs centralizing so that the string representation is only in one place.

There is also no unit test for ParameterMap on its own. It is tested in conjunction with the Par* tests at the moment.

[Nick Draper]

Bulk move of tickets to iteration 31 at the iteration 30 code freeze

[Nick Draper]

Moved to iteration 33 at iteration 32 code freeze

[Nick Draper]

Moved at end of release 2.1

[Nick Draper]

Moved at the end of release 2.2

[Nick Draper]

Moved to milestone 2.4

[Karl Palmen]

I've identified the following string that are used in the parameter map:

"pos", "rot" 
"x", "y", "z"
"rotx", "roty", "rotz"
"double", "int", "bool", "string", "V3D", "Quat"

Also there are some mores strings used in asString and SaveNexus. I could write a function in the header file for each one of them to return it.

[Martyn Gigg]

My thought here is rather than just free functions they should be static functions on the ParameterMap class itself, i.e for the "pos" parameter Header:

static const std::string & pos();

Source:

namespace // to be above all of the other function defs
{
  const std:string POS_PARAM_NAME="pos";
  //... plus the others
}
const std::string & ParameterMap::pos()
{
  return POS_PARAM_NAME;
}

// ... plus the others

The POS_PARAM_NAME part is important as it stops the string from being constructed over and over again.

[Karl Palmen]

Thank you Martyn for the suggestion.

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Provisional plan for unit test

Test 1: Test constructor works. Verify parameter map is empty and has zero size.

Test 2: Construct and add one parameter. Verify parameter map is not empty and possibly check its size.

Test 3: Check all the parameter names given by the parameter name functions are correct. This will be the only test that explicitly uses parameter names. The other tests will use the functions tested here.

Test 4: Test the add... functions verify with the contains function. Also test size function, if not done in test 2.

Test 5: Test the get... functions.

Test 6: Test the SaveNexus does not throw any exceptions.

[Karl Palmen]

I find there is already a ParameterMapTest.h . It follows a different plan initially similar to mine.

Test 3: needs adding and could be named testParameter_Name_Functions(). Also it should be the only one to make explicit use of the parameter names. Other functions would call the functions tested here.

Testing ParameterMap.empty() function could be added to testAdding_A_Parameter_That_Is_Not_Present_Puts_The_Parameter_In().

Possibly add testSaveNexus_Does_Not_Throw .

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

To test, check the code of ParameterMap.cpp to see that all strings inserted into the parameters are defined in one place.

Check that the unit test ParameterMapTest.h exists and tests the functions that return these strings and that the unit test does not explicitly refer to these strings anywhere else.

Check that the unit test tests the empty function.

You may also check that the unit test passes.

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Gesner Passos]

Internally, the problem is solved. But, outside the ParameterMap, there are plenty of references to the direct names of the parameters. (For example, Code/Mantid/Framework/Crystal/src/SCDCalibratePanels.cpp uses the names and not the indirect function ::x() ::y() ::pos()) My question is if we should open a ticket to review the places where those parameters appears and change to the newly created functions.

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Karl Palmen]

Made the changes to the code re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: c579eb77200f8e6b70f97467a68d511e0780a1e1

[Karl Palmen]

Remove explicit references to parameter names in unit test re #3692

These will be confined to the test testParameter_Name_Functions() to be added.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: d33ae58835513e4dd3431bf4d0aa8c561ce5bd6b

[Karl Palmen]

Remove more explicit names from unit test re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8409e31f09c6d03020ca3d1289b17e79cd984292

[Karl Palmen]

Add test for the Parameter Name Functions re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 089e71c9b2f8fa409351b4ba0623b2414c195d23

[Karl Palmen]

Test empty function re #3692

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: e8c0ee2d23e4d60896e09061fd85a624b0553323

[Stuart Campbell]

This ticket has been transferred to github issue ​4539