Ticket #8274 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

[ICAT] Remove old interface classes

Reported by: Jay Rainey Owned by: Jay Rainey
Priority: major Milestone: Release 3.1
Component: GUI Keywords: ICAT,ICAT4,maintenance
Cc: Blocked By: #8321
Blocking: #8192, #8244 Tester: Gesner Passos

Description (last modified by Jay Rainey) (diff)

Since we no longer need the old interfaces we should remove them from Mantid altogether.

The related classes are: 

mantid/Code/Mantid/MantidQt/MantidWidgets/src/ICatAdvancedSearch.cpp
mantid/Code/Mantid/MantidQt/MantidWidgets/src/ICatInvestigation.cpp
mantid/Code/Mantid/MantidQt/MantidWidgets/src/ICatMyDataSearch.cpp
mantid/Code/Mantid/MantidQt/MantidWidgets/src/ICatSearch.cpp
mantid/Code/Mantid/MantidQt/MantidWidgets/src/ICatUtils.cpp

Then the related headers and .ui files: 

mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatAdvancedSearch.h
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatAdvancedSearch.ui
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatInvestigation.h
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatInvestigation.ui
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatMyDataSearch.h
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatMyDataSearch.ui
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatSearch.h
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatSearch.ui
mantid/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/ICatUtils.h

Once they have been removed the new GUI and related helper class should be renamed: 

ICatSearch2.cpp -> CatalogSearch.cpp
ICatHelper.cpp  -> CatalogHelper.cpp

All references to them will then need to be removed, for example, from ApplicationWindow.cpp and catalog algorithms, such as CatalogSearch.cpp.

In addition, related menu items (login & logout) variables should be renamed to be ICAT independent.

Change History

comment:1 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:2 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:3 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:4 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:5 Changed 7 years ago by Jay Rainey

  • Description modified (diff)

comment:6 Changed 7 years ago by Jay Rainey

  • Status changed from new to inprogress

Removed old ICAT interface classes. Refs #8274.

  • Removed relevant classes from cmake list.

Changeset: 186240164537d33305305f3256fe0d9bb9e7b216

comment:7 Changed 7 years ago by Jay Rainey

Removed advancedSearch from application window. Refs #8274.

Changeset: 0eb1ed5860eea301e750d8a60470cc777eefab9e

comment:8 Changed 7 years ago by Jay Rainey

Removed MyDataSearch from application window. Refs #8274.

Changeset: ffdd97c82262d70bfb9cfdb9af0fb7050f893245

comment:9 Changed 7 years ago by Jay Rainey

Removed ICatSearch from application window. Refs #8274.

Changeset: 49250af68550466bf8469d27943f899ff64a4718

comment:10 Changed 7 years ago by Jay Rainey

Renamed ICatHelper class. Refs #8274.

Changeset: 0ed5297771b73b480a9efe90c12d1be3ce283e3d

comment:11 Changed 7 years ago by Jay Rainey

Renamed ICatSearch class. Refs #8274.

  • Renamed Login search, and logout variables in ApplicationWindow.cpp to be ICAT independant.
  • Renamed relevant interface class to match related class name.
  • Updated CMakeLists.

Changeset: 19b34ff847acb71c781d4443423c6897b4391936

comment:12 Changed 7 years ago by Jay Rainey

  • Blocked By 8321 added

As I added a new helper method (executeAsynchronously) in #8321 I need to update the namespace being used for this method when #8321 is tested.

Last edited 7 years ago by Jay Rainey (previous) (diff)

comment:13 Changed 7 years ago by Jay Rainey

  • Blocking 8192 added

comment:14 Changed 7 years ago by Martyn Gigg

I was looking at some code in MantidUI.cpp for another task. There are quite a few places that mention ICAT but I believe they all relate to the old interface.

Could you check all of those and remove any/all that are now not required, please?

comment:15 Changed 7 years ago by Jay Rainey

Remove unused ICAT methods MantidUI & ApplicationWindow. Refs #8274.

Changeset: 8a05a1bfea5a9e1a23da10c41df792cfab7abfab

comment:16 Changed 7 years ago by Jay Rainey

Merge remote-tracking branch 'origin/master' into feature/8274_icat_remove_old_gui. Refs #8274.

Conflicts:

  • Code/Mantid/MantidQt/MantidWidgets/src/CatalogHelper.cpp
  • Code/Mantid/MantidQt/MantidWidgets/src/CatalogSearch.cpp

Changeset: 599a8925e8c88d8626411d2f8f0a93f99ed9eb2d

Last edited 7 years ago by Jay Rainey (previous) (diff)

comment:17 Changed 7 years ago by Jay Rainey

Merge branch 'feature/8274_icat_remove_old_gui' into develop. Refs #8274.

Conflicts:

  • Code/Mantid/MantidQt/MantidWidgets/src/CatalogHelper.cpp
  • Code/Mantid/MantidQt/MantidWidgets/src/CatalogSearch.cpp
  • Code/Mantid/MantidQt/MantidWidgets/src/ICatAdvancedSearch.cpp
  • Code/Mantid/MantidQt/MantidWidgets/src/ICatInvestigation.cpp
  • Code/Mantid/MantidQt/MantidWidgets/src/ICatSearch.cpp
  • Code/Mantid/MantidQt/MantidWidgets/src/ICatUtils.cpp

Changeset: 0331af8e6777985329bb4f2883a14d252756e04d

Last edited 7 years ago by Jay Rainey (previous) (diff)

comment:18 Changed 7 years ago by Jay Rainey

  • Status changed from inprogress to verify
  • Resolution set to fixed

This ticket involved the removal of unused classes, methods, and re-naming of classes to be ICAT independent. Verify that the changes I made have not broken access to the catalog within Mantid, and that my changes correspond to that in the ​description.

To test

  1. Open Mantid and login into the catalog with your federal ID.
  2. Ensure my changes did not break any functionality by performing searches.

As this ticket dealt with refactoring a code review of my changes would be appreciated.

comment:19 Changed 7 years ago by Jay Rainey

  • Blocking 8244 added

comment:20 Changed 7 years ago by Gesner Passos

  • Status changed from verify to verifying
  • Tester set to Gesner Passos

comment:21 Changed 7 years ago by Gesner Passos

  • Status changed from verifying to reopened
  • Resolution fixed deleted

I've given two small suggestions for changing the code. So, I will reopen in now.

comment:22 Changed 7 years ago by Jay Rainey

  • Status changed from reopened to inprogress

Removed deleted files from CMakeList. Refs #8274.

Changeset: a5f552439b8ee023e742e236656338c4fe67f1d4

comment:23 Changed 7 years ago by Jay Rainey

Removed unused logout method from MantidUi. Refs #8274.

Changeset: a6293162462c8f4991679f59af32c124fb6542a5

comment:24 Changed 7 years ago by Jay Rainey

Make use of asynchronous method. Refs #8274.

Changeset: a2171f94539066fa2af62b46484281246b6c6829

comment:25 Changed 7 years ago by Jay Rainey

  • Status changed from inprogress to verify
  • Resolution set to fixed

comment:26 Changed 7 years ago by Gesner Passos

  • Status changed from verify to closed

Merge remote-tracking branch 'origin/feature/8274_icat_remove_old_gui'

Full changeset: ​e1362e376502bc85e5035bd47126760033216d44

comment:27 Changed 7 years ago by Gesner Passos

Everything works as before, with the changes proposed in this ticket.

comment:28 Changed 7 years ago by Jay Rainey

Merge branch 'feature/8274_icat_remove_old_gui' into develop. Refs #8274.

Conflicts:

Code/Mantid/MantidQt/MantidWidgets/src/CatalogHelper.cpp Code/Mantid/MantidQt/MantidWidgets/src/CatalogSearch.cpp Code/Mantid/MantidQt/MantidWidgets/src/ICatAdvancedSearch.cpp Code/Mantid/MantidQt/MantidWidgets/src/ICatInvestigation.cpp Code/Mantid/MantidQt/MantidWidgets/src/ICatSearch.cpp Code/Mantid/MantidQt/MantidWidgets/src/ICatUtils.cpp

Changeset: 0331af8e6777985329bb4f2883a14d252756e04d

comment:29 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​9119

Note: See TracTickets for help on using tickets.