Skip to content

GUI: functions returning an Item pointer should have name ending in "Item"

In the GUI we have all these functions:

GUI/Support/IO/AbstractDataLoader.h: RealItem* realItem() const;
GUI/Model/Job/MinimizerItem.h: MinimizerItem* currentMinimizerItem() const;
GUI/Model/Job/FitParameterLinkItem.h: LinkItem* linkItem() const;
GUI/Model/Job/JobItem.h: InstrumentItem* instrumentItem() const;
GUI/Model/Sample/ItemWithMaterial.h: MaterialItem* materialItem() const;
GUI/Model/Device/BeamItems.h: BeamWavelengthItem* wavelengthItem() const;
GUI/Model/Device/BeamItems.h: BeamDistributionItem* inclinationAngleItem() const;
GUI/Model/Device/BeamItems.h: BeamAzimuthalAngleItem* azimuthalAngleItem() const;
GUI/Model/Device/InstrumentItems.h: BeamItem* beamItem() const;
GUI/Model/Device/InstrumentItems.h: BackgroundItem* backgroundItem() const;
GUI/Model/Device/InstrumentItems.h: DetectorItem* detectorItem() const;
GUI/Model/Device/MaskItems.h: SessionItem* maskValueItem() const;
GUI/Model/Device/MaskItems.h: RegionOfInterestItem* regionOfInterestItem() const;
GUI/Model/Model/SessionModel.h: SessionItem* rootItem() const;
GUI/Model/Data/DataItem.h: BasicAxisItem* xAxisItem() const;
GUI/Model/Data/DataItem.h: AmplitudeAxisItem* yAxisItem() const;
GUI/Model/Data/RealItem.h: DataItem* dataItem() const;
GUI/Model/Data/RealItem.h: IntensityDataItem* intensityDataItem() const;
GUI/Model/Data/RealItem.h: SpecularDataItem* specularDataItem() const;
GUI/Model/Data/IntensityDataItem.h: AmplitudeAxisItem* zAxisItem() const;
GUI/Model/Data/IntensityDataItem.h: MaskContainerItem* maskContainerItem() const;
GUI/Model/Data/IntensityDataItem.h: ProjectionContainerItem* projectionContainerItem() const;
GUI/View/SampleDesigner/CompoundForm.h: CompoundItem* compositionItem() const;
GUI/View/SampleDesigner/SampleEditorController.h: MultiLayerItem* sampleItem() const;
GUI/View/SampleDesigner/CoreAndShellForm.h: CoreAndShellItem* coreShellItem() const;
GUI/View/SampleDesigner/InterferenceForm.h: ParticleLayoutItem* layoutItem() const;
GUI/View/SampleDesigner/ParticleLayoutForm.h: ParticleLayoutItem* layoutItem() const;
GUI/View/SampleDesigner/MesocrystalForm.h: MesocrystalItem* mesocrystalItem() const;
GUI/View/SampleDesigner/LatticeTypeSelectionForm.h: Interference2DAbstractLatticeItem* interferenceItem() const;
GUI/View/SampleDesigner/LayerForm.h: LayerItem* layerItem() const;
GUI/View/Import/RealDataTreeModel.h: RealItem* topMostItem() const;
GUI/View/Toplevel/SimulationView.h: SimulationOptionsItem* optionsItem() const;
GUI/View/Instrument/InstrumentsTreeModel.h: InstrumentItem* topMostItem() const;
GUI/View/PlotUtil/ColorMap.h: IntensityDataItem* intensityItem() const;
GUI/View/Common/DataAccessWidget.h: JobItem* jobItem() const;
GUI/View/Common/DataAccessWidget.h: RealItem* realItem() const;
GUI/View/Common/DataAccessWidget.h: SpecularDataItem* realSpecularDataItem() const;
GUI/View/Common/DataAccessWidget.h: SpecularDataItem* simuSpecularDataItem() const;
GUI/View/Common/DataAccessWidget.h: SpecularDataItem* diffSpecularDataItem() const;
GUI/View/Common/DataAccessWidget.h: IntensityDataItem* realIntensityDataItem() const;
GUI/View/Common/DataAccessWidget.h: IntensityDataItem* simuIntensityDataItem() const;
GUI/View/Common/DataAccessWidget.h: IntensityDataItem* diffIntensityDataItem() const;
GUI/View/Common/DataAccessWidget.h: SpecularDataItem* currentSpecularDataItem() const;
GUI/View/Common/DataAccessWidget.h: IntensityDataItem* currentIntensityDataItem() const;
GUI/View/Common/DataItemBundleWidget.h: SpecularDataItem* currentSpecularDataItem() const;
GUI/View/Common/DataItemBundleWidget.h: IntensityDataItem* currentIntensityDataItem() const;

But we also have

GUI/Model/Sample/CoreAndShellItem.h: ParticleItem* core() const;
GUI/Model/Sample/CoreAndShellItem.h: ParticleItem* shell() const;
GUI/Model/Sample/MaterialItems.h: MaterialItem* defaultMaterial() const;
GUI/Model/Sample/ParticleItem.h: FormFactorItem* formfactor() const;
GUI/Model/Device/BeamItems.h: BasicAxisItem* inclinationAxis() const;
GUI/Model/Device/BeamItems.h: FootprintItem* footprint() const;
GUI/Model/Device/InstrumentItems.h: InstrumentItem* createCopy() const;
GUI/Model/Device/SpecularBeamInclinationItem.h: BasicAxisItem* alphaAxis() const;
GUI/Model/Device/BeamDistributionItem.h: DistributionItem* distribution() const;
GUI/Model/Device/DetectorItems.h: ResolutionFunctionItem* resolutionFunction() const;
GUI/Model/Data/RealItem.h: DataItem* nativeData() const;
GUI/Model/BaseItem/SessionItem.h: SessionItem* itemParent() const;
GUI/View/Toplevel/SimulationView.h: MultiLayerItem* selectedSample() const;
GUI/View/Toplevel/SimulationView.h: InstrumentItem* selectedInstrument() const;
GUI/View/Toplevel/SimulationView.h: RealItem* selectedRealData() const;
GUI/View/Fit/FitParameterWidget.h: FitParameterContainerItem* fitContainer() const;
GUI/View/Instrument/InstrumentListView.h: InstrumentItem* currentInstrument() const;
GUI/View/Instrument/DistributionEditor.h: BeamDistributionItem* item() const;

These function names should be modified to also end with "...Item".

Rationale:

  • Keep naming consistent.
  • Disambiguate functions returning a GUI item from functions returning a Core object.