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

--[BE] - Refactor/cleanup attributes and attributes managers #2461

Merged
merged 5 commits into from
Sep 4, 2024

Conversation

jturner65
Copy link
Contributor

Motivation and Context

This PR addresses a few things that I've wanted to take care of for a while, as well as a little bit of groundwork for future PRs. All of these changes are transparent and should have no impact on current Sim execution.

  • Rename the base classes for the attributes and the managers to be more in line with naming conventions elsewhere in the code base.
  • Add a Configuration comparison override.
  • Add the ability to check for duplicate Configurations before adding them as Subconfigs on demand.
  • Address a rare edge-case issue during attributes registration where the name that the attributes is saved with can potentially not be the name that is passed to the (child-class-specific) post-registration processing.

How Has This Been Tested

Locally C++ and python tests pass

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have completed my CLA (see CONTRIBUTING)
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Follow existing config/metadata naming conventions; minor reorganization of SceneDatasetAttributes
Needs to send the handle used to actually register to attributes
@jturner65 jturner65 requested a review from aclegg3 September 4, 2024 17:20
@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label Sep 4, 2024
@@ -1217,6 +1217,25 @@ class Configuration {
return (mapIter != configMap_.end());
}

/**
* @brief return if passed @p subConfig exists in this Configuration's
* subconfig map. Does not compare hidden ConfigValues.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is because the hidden values are used as instance-specific, internally-used metadata that are, by design, always unique.

Copy link
Contributor

@aclegg3 aclegg3 left a comment

Choose a reason for hiding this comment

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

LGTM. I don't see any issues.

@jturner65 jturner65 merged commit d858741 into main Sep 4, 2024
10 checks passed
@jturner65 jturner65 deleted the BE_RefactorAttributesConfiguration branch September 4, 2024 18:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Do not delete this pull request or issue due to inactivity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants