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

Report Legacy DREAM.3D warnings #919

Conversation

mmarineBlueQuartz
Copy link
Collaborator

  • Add warnings and error reporting through Result<> to the legacy DREAM.3D import process.
  • Add warning reporting to ImportH5ObjectPathsAction.
  • Reports when legacy stats data cannot be imported.

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

* Add warnings and error reporting through Result<> to the legacy DREAM.3D import process.
* Add warning reporting to ImportH5ObjectPathsAction.
@nyoungbq nyoungbq self-requested a review April 19, 2024 13:50
@mmarineBlueQuartz
Copy link
Collaborator Author

Fixes #860

@mmarineBlueQuartz mmarineBlueQuartz merged commit 956f295 into BlueQuartzSoftware:develop Apr 19, 2024
8 checks passed
@mmarineBlueQuartz mmarineBlueQuartz deleted the feature/D3DImportWarnings branch April 19, 2024 19:50
imikejackson pushed a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
* Add warnings and error reporting through Result<> to the legacy DREAM.3D import process.
* Add warning reporting to ImportH5ObjectPathsAction.
* Reports when legacy stats data cannot be imported.
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.

2 participants