Add the AppendDiscoveryResult to NdrRegistry #1810
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Filed as internal issue #USD-7288 |
spiffmon
reviewed
Jun 2, 2022
pxr/usd/ndr/registry.h
Outdated
| /// This method will not immediately spawn a parse call which will be | ||
| /// deferred until a GetNode*() method is called. | ||
| NDR_API | ||
| void AppendDiscoveryResult(NdrNodeDiscoveryResult&& discoveryResult); |
There was a problem hiding this comment.
"Append" implies knowledge that we're storing DR's in a list, which is an implementation detail we'd rather not be locked into. Can we change this to "Add"?
spiffmon
reviewed
Jun 2, 2022
| NDR_API | ||
| void AppendDiscoveryResult(NdrNodeDiscoveryResult&& discoveryResult); | ||
|
|
||
| /// Copy version of the method above. |
There was a problem hiding this comment.
Can we use the doxygen \overload directive, here?
spiffmon
reviewed
Jun 2, 2022
pxr/usd/ndr/registry.h
Outdated
| void AppendDiscoveryResult(NdrNodeDiscoveryResult&& discoveryResult); | ||
|
|
||
| /// Copy version of the method above. | ||
| /// For performance reasons, one should prefer to use the move version. |
There was a problem hiding this comment.
Can we say "prefer to use the rvalue reference form"?
This method allows the client to explicitly set additional discovery results that would NOT be found through the plugin system. For example to support lazily-loaded plugins which cannot be easily discovered in advance.
Append implies that discovery results are stored in a list while add is more generic and does not expose implementation details. This commit also improves these methods' documentation.
DuncanHopkins
force-pushed
the
MR/NDRAccessor
branch
from
92566ab
to
aca3e7c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This method allows the client to explicitly set additional discovery
results that would NOT be found through the plugin system. For example
to support lazily-loaded plugins which cannot be easily discovered in
advance.