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.

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

Environment_Engine: Refactor of IsContaining and ElementsInSpace methods to Geometry and Analytical namespaces as appropriate #3203

Merged

Conversation

enarhi
Copy link
Member

@enarhi enarhi commented Oct 31, 2023

Issues addressed by this PR

Closes #3198 and #3199

Methods for IsContaining were added to Geometry_Engine, and the ElementsInSpace method was moved to analytical. Both now work off polylines and regions respectively to allow for wider usage outside of the Environment_Engine.

Test files

Test Script

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comments. Somehow I think this will escape needing versioning though which would be cool if so - but let's maybe run the check to be sure.

Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Structure_Engine/Modify/SetAnalysisParameters.cs Outdated Show resolved Hide resolved
@FraserGreenroyd
Copy link
Contributor

@BHoMBot check compliance

Copy link

bhombot-ci bot commented Oct 31, 2023

@FraserGreenroyd to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's fix compliance before checking versioning though 😉

Otherwise from code review this all looks good and in line with what we discussed @enarhi so should be quick enough to settle out.

@FraserGreenroyd FraserGreenroyd changed the title Environment_Engine: Refactor of IsContaining and ElementsInSpace methods to Geometry and Analytical znamespaces as appropriate Environment_Engine: Refactor of IsContaining and ElementsInSpace methods to Geometry and Analytical namespaces as appropriate Oct 31, 2023
Copy link
Member

@pawelbaran pawelbaran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a read through the code and raised a few questions as in the comments - hopefully they make sense, please shout if you prefer to grab a call instead of typing @enarhi 👍

Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
@enarhi
Copy link
Member Author

enarhi commented Nov 1, 2023

@BHoMBot check compliance

Copy link

bhombot-ci bot commented Nov 1, 2023

@enarhi to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

Copy link
Member

@pawelbaran pawelbaran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't hate me @enarhi, getting me to review geometry never ends up without comments 😃

Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Geometry_Engine/Query/IsContaining.cs Outdated Show resolved Hide resolved
Copy link

bhombot-ci bot commented Nov 6, 2023

@enarhi to confirm, the following actions are now queued:

  • check versioning

@enarhi
Copy link
Member Author

enarhi commented Nov 6, 2023

@BHoMBot check versioning

Copy link

bhombot-ci bot commented Nov 6, 2023

@enarhi to confirm, the following actions are now queued:

  • check versioning

There are 16 requests in the queue ahead of you.

@enarhi
Copy link
Member Author

enarhi commented Nov 6, 2023

@BHoMBot check compliance

Copy link

bhombot-ci bot commented Nov 6, 2023

@enarhi to confirm, the following actions are now queued:

  • check code-compliance
  • check documentation-compliance
  • check project-compliance
  • check branch-compliance
  • check dataset-compliance
  • check copyright-compliance

Copy link
Member

@pawelbaran pawelbaran left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice addition to the engine, glad we ironed out the potential bugs ahead of merging - thanks @enarhi!

@pawelbaran
Copy link
Member

@FraserGreenroyd is your change request still valid or can we proceed with merging?

@enarhi
Copy link
Member Author

enarhi commented Nov 6, 2023

@BHoMBot check required

Copy link

bhombot-ci bot commented Nov 6, 2023

@enarhi 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

Copy link

bhombot-ci bot commented Nov 6, 2023

The check code-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 6, 2023

The check documentation-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 6, 2023

The check project-compliance has already been run previously and recorded as a successful check. This check has not been run again at this time.

Copy link

bhombot-ci bot commented Nov 6, 2023

The check versioning has already been run previously and recorded as a successful check. This check has not been run again at this time.

@Tom-Kingstone Tom-Kingstone self-requested a review November 7, 2023 09:45
Copy link
Contributor

@Tom-Kingstone Tom-Kingstone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FraserGreenroyd asked me to go through the test procedures for the IES and XML toolkits, including the new automated test procedures. None of the changes in this PR break any of the existing functionality and all of these tests pass, so I am happy to approve for this case.

Copy link
Contributor

@FraserGreenroyd FraserGreenroyd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reviewed the code and run a couple of test scripts. @Tom-Kingstone has run larger test procedures against dependent toolkits which required the IsContaining method originally to ensure that functionality isn't broken which he's reporting is the case, so happy to approve for merge.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: unit-tests

Copy link

bhombot-ci bot commented Nov 7, 2023

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.

@FraserGreenroyd
Copy link
Contributor

@BHoMBot check ready-to-merge

Copy link

bhombot-ci bot commented Nov 7, 2023

@FraserGreenroyd to confirm, the following actions are now queued:

  • check ready-to-merge

There are 1 requests in the queue ahead of you.

@FraserGreenroyd FraserGreenroyd added the type:feature New capability or enhancement label Nov 7, 2023
@FraserGreenroyd
Copy link
Contributor

@BHoMBot check ready-to-merge

Copy link

bhombot-ci bot commented Nov 7, 2023

@FraserGreenroyd to confirm, the following actions are now queued:

  • check ready-to-merge

@FraserGreenroyd FraserGreenroyd merged commit cf5740f into develop Nov 7, 2023
13 checks passed
@FraserGreenroyd FraserGreenroyd deleted the Environment_Engine-#3199-IsContainingRefactor branch November 7, 2023 09:57
@bhombot-ci bhombot-ci bot mentioned this pull request Dec 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New capability or enhancement
Projects
None yet
4 participants