Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Open
pawelbaran opened this issue Feb 22, 2021 · 8 comments
Open

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

pawelbaran opened this issue Feb 22, 2021 · 8 comments
Assignees
@alelom @rwemay @al-fisher @IsakNaslundBh
Labels
type:feature New capability or enhancement type:question Ask for further details or start conversation

Comments

@pawelbaran
Copy link
Member

Following the discussion in BHoM/BHoM_Adapter#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?
@pawelbaran pawelbaran added type:feature New capability or enhancement type:question Ask for further details or start conversation labels Feb 22, 2021
@pawelbaran pawelbaran mentioned this issue Feb 22, 2021
Closed
@IsakNaslundBh
Copy link

Happy to get this added from my end

@al-fisher
Copy link
Member

Agreed

@alelom
Copy link
Member

alelom commented Feb 23, 2021

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

@FraserGreenroyd FraserGreenroyd removed their assignment Feb 23, 2021
@pawelbaran
Copy link
Member Author

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

@alelom
Copy link
Member

alelom commented Feb 23, 2021

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

@pawelbaran
Copy link
Member Author

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
Copy link
Member

Would anyone be against such duplication?

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

@alelom
Copy link
Member

alelom commented Mar 12, 2021

Sounds like the sensible choice to me too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alelom alelom

@rwemay rwemay

@al-fisher al-fisher

@IsakNaslundBh IsakNaslundBh

Labels
type:feature New capability or enhancement type:question Ask for further details or start conversation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@alelom @rwemay @al-fisher @FraserGreenroyd @IsakNaslundBh @pawelbaran