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

Update instructions for C++ BSK modules to use setters and getters #716

Merged
merged 10 commits into from
Jun 13, 2024

Conversation

schaubh
Copy link
Contributor

@schaubh schaubh commented Jun 8, 2024

  • Tickets addressed: bsk-715
  • Review: By commit
  • Merge strategy: Merge (no squash)

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 and get 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 via get 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

@schaubh schaubh added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 8, 2024
@schaubh schaubh self-assigned this Jun 8, 2024
@schaubh schaubh requested a review from a team as a code owner June 8, 2024 00:37
@schaubh schaubh linked an issue Jun 8, 2024 that may be closed by this pull request
Copy link
Contributor

@Mark2000 Mark2000 left a 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.

src/utilities/makeDraftModule.py Outdated Show resolved Hide resolved
@schaubh schaubh force-pushed the feature/bsk_715_setterGetter branch from 4ebdd20 to b468dfb Compare June 11, 2024 16:47
@schaubh schaubh force-pushed the feature/bsk_715_setterGetter branch from b468dfb to 9a8c523 Compare June 11, 2024 19:47
@Mark2000 Mark2000 self-requested a review June 12, 2024 16:12
@schaubh schaubh merged commit a19ed23 into develop Jun 13, 2024
3 checks passed
@schaubh schaubh deleted the feature/bsk_715_setterGetter branch June 13, 2024 14:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

C++ modules should start using setters and getters
3 participants