Add Priority Types For Push

GCRA101 commented 1 month ago

NOTE: Depends on

https://github.com/BHoM/ETABS_Toolkit/pull/480

Issues addressed by this PR

Closes #390

BHoM_Adapter now equipped with a new attribute PropertyTypes defining priority order for the push of objects into software packages in addition to DependencyTypes. This change has been required due to the requirements from software packages like ETABS to push objects following a specific hierarchy.

Test files

Video Demonstration - Issue https://burohappold.sharepoint.com/:v:/r/sites/BHoM/02_Current/12_Scripts/02_Pull%20Request/BHoM/ETABS_Toolkit/%23480-AddPriorityTypesForPush/Push%20Levels%20Issue.mp4?csf=1&web=1&e=7cEacd Video Demonstration - Solution https://burohappold.sharepoint.com/:v:/r/sites/BHoM/02_Current/12_Scripts/02_Pull%20Request/BHoM/ETABS_Toolkit/%23480-AddPriorityTypesForPush/Push%20Levels%20Sorted.mp4?csf=1&web=1&e=cDUbje Json File https://burohappold.sharepoint.com/sites/BHoM/_layouts/15/download.aspx?UniqueId=aa695dbddee44123b35aecc6843d658a&e=mvnMou Grasshopper File https://burohappold.sharepoint.com/:u:/r/sites/BHoM/02_Current/12_Scripts/02_Pull%20Request/BHoM/ETABS_Toolkit/%23480-AddPriorityTypesForPush/Test%20Script.gh?csf=1&web=1&e=Lzfzec Etabs File https://burohappold.sharepoint.com/:u:/r/sites/BHoM/02_Current/12_Scripts/02_Pull%20Request/BHoM/ETABS_Toolkit/%23480-AddPriorityTypesForPush/Test%20ETABS%20Model.EDB?csf=1&web=1&e=lj7JY7

Changelog

Added PriorityTypes attribute as dictionary associating priority number to each type of object to push
Added HandlePriorities attribute allowing Adapters to sort by priorities if required (e.g. ETABS)
Added PriorityComparer defining criteria for sorting objects based on priority
Added GetPrioritySortedObjects to sort objects based on priority and using the PriorityComparer

alelom commented 1 month ago

Had a look at this PR and the ETABS one. Great work @GCRA101 ! 🚀 I agree with the changes suggested by @IsakNaslundBh .

GCRA101 commented 3 weeks ago

@IsakNaslundBh, @alelom, thanks again for the comments. I've incorporated them in the latest commit 3587c9286f9999586a26d870c950f3860f3442fb

IsakNaslundBh commented 2 weeks ago

Happy with this from a code perspective now, and have dismissed my review. @Chrisshort92 Could you please assist in testing this from a functionality point of view?

GCRA101 commented 1 week ago

@peterjamesnugent , @HugoVanLooveren, rebuilt and rechecked the code after the modifications and it all works fine ;).

ETABS vs GH View Levels Push v2

peterjamesnugent commented 11 hours ago

@BHoMBot check required @BHoMBot check copyright-compliance

bhombot-ci[bot] commented 11 hours ago

@peterjamesnugent to confirm, the following actions are now queued: - check `code-compliance` - check `documentation-compliance` - check `project-compliance` - check `core` - check `null-handling` - check `serialisation` - check `versioning` - check `installer` - check `copyright-compliance` There are 3 requests in the queue ahead of you.

bhombot-ci[bot] commented 10 hours ago

Please be advised that the check with reference 32650160492 has more than 50 annotations of notes. API limitations restrict annotations to 50. You may need to rerun this check to obtain the next set when you make changes. At the time of reporting this check, there are 14 additional annotations waiting, made up of 14 errors and 0 warnings.

peterjamesnugent commented 7 hours ago

@GCRA101 for this one you need to sort out the copyright-compliance errors and potentially update from develop branch (let me know if you're unsure what to do).

BHoM / BHoM_Adapter