Ticket #4764 (assigned)

Opened 9 years ago

Last modified 5 years ago

PropertyHandler.cpp needs more comments

Reported by: Russell Taylor Owned by: Karl Palmen
Priority: minor Milestone: Backlog
Component: Framework Keywords:
Cc: Blocked By:
Blocking: Tester:

Description

I was trying to understand how something in PropertyHandler.cpp works and it was not easy - there are hardly any comments!

Add some (in-code and doxygen)

Change History

comment:1 Changed 9 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner set to Anyone

comment:2 Changed 8 years ago by Nick Draper

  • Milestone changed from Release 2.1 to Release 2.2

Moved at end of release 2.1

comment:3 Changed 8 years ago by Karl Palmen

I've found PropertyHandler in ...\Mantid\MantidQT\MantidWidgets\.

comment:4 Changed 8 years ago by Karl Palmen

  • Owner changed from Anyone to Karl Palmen

comment:5 Changed 8 years ago by Nick Draper

  • Milestone changed from Release 2.2 to Release 2.3

http://www.mantidproject.org/Release_Notes_2_2_Full_List

comment:6 Changed 8 years ago by Nick Draper

  • Milestone changed from Release 2.3 to Release 2.4

Moved to release 2.4

comment:7 Changed 8 years ago by Karl Palmen

I find it deals with the window in which one adds and deals with fitting functions.

PropertyHandler seems to be a misleading name, because Mantid has properties other than those concerning fitting functions, particularly the properties of algorithms.

comment:8 Changed 8 years ago by Karl Palmen

It was also called when I pressed the Load button in the window that lists the workspaces. So it may deal with properties in several windows.

comment:9 Changed 8 years ago by Karl Palmen

  • Milestone changed from Release 2.4 to Release 2.5

comment:10 Changed 7 years ago by Karl Palmen

An existing comment accessible in Doxygen, says the property management is based on the Gaudi project at ​http://proj-gaudi.web.cern.ch/proj-gaudi/ .

comment:11 Changed 7 years ago by Russell Taylor

Unfortunately we use the term 'Property' for several distinct things. The usage here has nothing whatsoever to do with Gaudi or algorithm properties.

comment:12 Changed 7 years ago by Karl Palmen

I've found out that the DeclareProperty function used by algorithms belongs to a PropertyManagerOwner class, which implements the IpropertyManager interface also implemented by PropertyManager.

comment:13 Changed 7 years ago by Karl Palmen

PropertyManager is one of three classes that implements IPropertyManager. The other two are Algorithm and PropertyManagerOwner.

comment:14 Changed 7 years ago by Russell Taylor

In the context of this ticket, PropertyManager is not relevant. This ticket concerns the class MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/PropertyHandler.h

comment:15 Changed 7 years ago by Karl Palmen

Ah! I see PropertyHandler is related to Fitting Functions and may handle the properties of such.

comment:16 Changed 7 years ago by Karl Palmen

  • Milestone changed from Release 2.5 to Release 2.6

comment:17 Changed 7 years ago by Nick Draper

  • Status changed from assigned to new

comment:18 Changed 7 years ago by Nick Draper

  • Component changed from Mantid to Framework

comment:19 Changed 7 years ago by Nick Draper

  • Milestone changed from Release 2.6 to Backlog

Moved to the Backlog after the code freeze for R2.6

comment:20 Changed 7 years ago by Nick Draper

  • Status changed from new to assigned

bulk move to assigned at the into of the triage step

comment:21 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​5611

Note: See TracTickets for help on using tickets.