search

BHoM / admin

Repository for raising central issues and questions; Regarding governance, process and multi-repo and framework compliance
GNU Lesser General Public License v3.0
0 stars 0 forks source link

Shall we expose toolkit-specific Ids through ToolkitId methods? #15

Open pawelbaran opened 3 years ago

pawelbaran commented 3 years ago

Following the discussion in https://github.com/BHoM/BHoM_Adapter/issues/288, I believe that adding toolkit-specific Query methods returning toolkit-specific Ids would be an easy yet nice UX booster - the currently available generic AdapterId method is hard to capture for non-expert users who do not know what AdapterIdFragmentType is. Therefore, I think we should add methods like RobotId, EtabsId etc. that would simply call AdapterId. Looks like we have an initial agreement on that, but just to confirm, what do you think?

IsakNaslundBh commented 3 years ago

Happy to get this added from my end

al-fisher commented 3 years ago

Agreed

alelom commented 3 years ago

As I stated here, I'm more than happy with this.

pawelbaran commented 3 years ago

Cool, how would you name the method? AdapterNameId? Or without adapter name prefix, taken into account it can be deducted from the namespace?

alelom commented 3 years ago

I think I'd go for RobotID, RevitID, EnergyPlusID, etc. (note the all caps ID as @FraserGreenroyd likes)

pawelbaran commented 3 years ago

In Revit_Toolkit we have ElementId, which is named after the Revit concept - I believe it is worth keeping it not to confuse the users, but on top of it I can add an identical method named RevitID to align to the proposal. Would anyone be against such duplication?

al-fisher commented 3 years ago

Would anyone be against such duplication?

I would not be against duplication - intuitive for all users.

alelom commented 3 years ago

Sounds like the sensible choice to me too.