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

ENH: RenameAction and Filter Add Overwrite Option #912

Merged

Conversation

nyoungbq
Copy link
Contributor

Added new overwrite functionality

Works by just deleting other object and renaming accordingly (no move semantics)

Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use i if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file simplnx/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file simplnx/docs/Porting_Filters.md has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.

Unit Testing

The idea of unit testing is to test the filter for proper execution and error handling. How many variations on a unit test each filter needs is entirely dependent on what the filter is doing. Generally, the variations can fall into a few categories:

  • 1 Unit test to test output from the filter against known exemplar set of data
  • 1 Unit test to test invalid input code paths that are specific to a filter. Don't test that a DataPath does not exist since that test is already performed as part of the SelectDataArrayAction.

Code Cleanup

  • No commented out code (rare exceptions to this is allowed..)
  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added example pipelines that use the filter
  • Classes and methods are properly documented

@nyoungbq nyoungbq changed the title ENH: RenameAction and Filter now has overwrite option ENH: RenameAction and Filter Add Overwrite Option Apr 12, 2024
@imikejackson imikejackson force-pushed the develop branch 2 times, most recently from 67a7875 to 12c9140 Compare April 22, 2024 14:34
@nyoungbq nyoungbq force-pushed the enh/rename_overwrite_option branch 2 times, most recently from 2d41d26 to 6384ad7 Compare April 30, 2024 16:38
Copy link
Collaborator

@mmarineBlueQuartz mmarineBlueQuartz left a comment

Choose a reason for hiding this comment

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

Looks good, just have some minor things to tweak for readability around changes that did not seem to make it into the PR.

@nyoungbq nyoungbq force-pushed the enh/rename_overwrite_option branch from 0ecdb4c to 1d2fe16 Compare May 1, 2024 19:39
@nyoungbq nyoungbq merged commit f0e0eb7 into BlueQuartzSoftware:develop May 2, 2024
8 checks passed
@nyoungbq nyoungbq deleted the enh/rename_overwrite_option branch May 2, 2024 10:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants