search

moosetechnology / MooseIDE

New Tools for Moose
MIT License
8 stars 25 forks source link

Rename MiAbstractModel to MiAbstractVisualizationModel ? #1167

Open NicolasAnquetil opened 2 months ago

NicolasAnquetil commented 2 months ago

There are many 'model' in MooseIDE: famix model, MiAbstractModel, models of shapes in Roassal, ...

To clarify a bit things, I propose to rename MiAbstractModel to MiAbstractVisualizationModel (or something equally significant)

ClotildeToullec commented 2 months ago

I agree to the name change, but I'd prefer MiAbstractBrowserModel, because it's not always visualizations. Also, all subclasses should be named with the same convention (MiSomethingBrowserModel?)

I think we should also be careful about variable names: (aBrowserModel /aMooseModel / aShapeModel) and method selectors (browserModel /mooseModel / shapeModel) when possible. I feel like these are the most confusing.

NicolasAnquetil commented 2 months ago

Yes your proposed name looks good to me Yes all subclasses should use the same convention Yes we should be careful with the variable names. In the MiAbstractBrowser I used specModel which can be changed if you prefer browserModel. For shapeModel, I am not sure we should go into Roassal...

ClotildeToullec commented 2 months ago

Ok, that's a plan. specModel is ok, I proposed browserModel because that is the convention we chose for the classes, but either are good. Of course we don't go into roassal itself, I meant if ever we use temps or utility methods (I don't think of any example in particular, now that you mention it).