Add tryGet/UpdSocket and tryGet/UpdOutput to the Component interface - Githubissues

opensim-org / opensim-core

SimTK OpenSim C++ libraries and command-line applications, and Java/Python wrapping.

https://opensim.stanford.edu

Apache License 2.0

783 stars 316 forks source link

Add tryGet/UpdSocket and tryGet/UpdOutput to the Component interface #3673

Closed adamkewley closed 8 months ago

adamkewley commented 8 months ago

Fixes having to use a try {} catch (...) {} to find a socket/output on a Component.

Brief summary of changes

Added tryGetSocket, tryUpdSocket, tryGetOutput, and tryUpdOutput to the Component interface
try, because they will return nullptr if the socket/output cannot be found on the component
There doesn't (appear to be?) a way of doing this without try...catch or allocating memory (e.g. with getOutputs) and searching in downstream code

Testing I've completed

Added basic tests
Added methods
Refactored existing methods to use the new ones
If the tests pass in CI, then it should be fine

CHANGELOG.md (choose one)

updated.

This change is

adamkewley commented 8 months ago

Note: can't merge this until I ensure the manual merge commit was ok: there are merge conflicts related to adding list sockets to parts of the API that this PR also touches (line-wise: functionally, not).