-
Notifications
You must be signed in to change notification settings - Fork 63
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
Update instructions for C++ BSK modules to use setters and getters #716
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
schaubh
added
documentation
Improvements or additions to documentation
enhancement
New feature or request
labels
Jun 8, 2024
Mark2000
reviewed
Jun 10, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of style comments. Don't know enough about swig to weigh in on those aspects, but it seems right to me.
schaubh
commented
Jun 11, 2024
Discuss how C++ modules should have user configurable variables be private and be set through setter and getter methods.
schaubh
force-pushed
the
feature/bsk_715_setterGetter
branch
from
June 11, 2024 16:47
4ebdd20
to
b468dfb
Compare
schaubh
force-pushed
the
feature/bsk_715_setterGetter
branch
from
June 11, 2024 19:47
b468dfb
to
9a8c523
Compare
Mark2000
approved these changes
Jun 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
Description
The C++ Basilisk module variables were often public variables, sometimes private variables with setter and getter methods.
From here on the expectation is that C++ module variables are private and accessed via
set
andget
commands.The
makeDraftModule.py
, module writing instructions and tutorial lessons need updating.The
logger()
function right now only logs public module variables. This method needs to be updated to allow both public variables and variables accessible viaget
functions to be logged.Verification
All unit tests pass again.
Documentation
Updated all associated documentation, tutorials, sample scripts and C++ template module documentation.
Future work
None