-
Notifications
You must be signed in to change notification settings - Fork 65
Generate parameterUpdated calls in parametersLoaded #1097
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
Open
durasi
wants to merge
4
commits into
nasa:main
Choose a base branch
from
durasi:feature/5697-parameters-loaded-notify
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
30ff847
Generate parameterUpdated calls in parametersLoaded (#5697)
durasi 1802ae8
Guard parameterUpdated calls in parametersLoaded with validity check
durasi ed7513c
Add parameterLoaded hook called as each parameter is loaded
durasi 769faa3
Apply review suggestions: guardedList for include, rename hook
durasi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -130,7 +130,8 @@ case class ComponentParameters ( | |
| "Parameter hook functions", | ||
| List( | ||
| getParamUpdateHookFunction, | ||
| getParamLoadHookFunction | ||
| getParamLoadHookFunction, | ||
| getParamLoadedHookFunction | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For consistency, let's rename |
||
| ) | ||
| ) | ||
| } | ||
|
|
@@ -225,7 +226,9 @@ case class ComponentParameters ( | |
| Some( | ||
| s"""|\\brief Called whenever parameters are loaded | ||
| | | ||
| |This function does nothing by default. You may override it. | ||
| |By default this notifies the component of each parameter via | ||
| |parameterUpdated. You may override it, for example to suppress | ||
| |notification on load. | ||
| |""" | ||
| ), | ||
| "parametersLoaded", | ||
|
|
@@ -235,6 +238,36 @@ case class ComponentParameters ( | |
| CppDoc.Function.Virtual | ||
| ) | ||
|
|
||
| private def getParamLoadedHookFunction = functionClassMember( | ||
| Some( | ||
| s"""|\\brief Called for each parameter when parameters are loaded | ||
| | | ||
| |By default this notifies the component via parameterUpdated when | ||
| |the parameter loaded successfully (valid or default). You may | ||
| |override it, for example to distinguish load from update. | ||
| |""" | ||
| ), | ||
| "parameterLoaded", | ||
| List( | ||
| CppDoc.Function.Param( | ||
| CppDoc.Type("FwPrmIdType"), | ||
| "id", | ||
| Some("The parameter ID") | ||
| ), | ||
| CppDoc.Function.Param( | ||
| CppDoc.Type("Fw::ParamValid"), | ||
| "valid", | ||
| Some("The parameter validity status") | ||
| ) | ||
| ), | ||
| CppDoc.Type("void"), | ||
| wrapInIf( | ||
| "FW_PARAM_OK(valid)", | ||
| lines("this->parameterUpdated(id);") | ||
| ), | ||
| CppDoc.Function.Virtual | ||
| ) | ||
|
|
||
| private def getParamUpdateHookFunction = functionClassMember( | ||
| Some( | ||
| s"""|\\brief Called whenever a parameter is updated | ||
|
|
@@ -448,6 +481,9 @@ case class ComponentParameters ( | |
| lines( | ||
| """| | ||
| |this->m_paramLock.unlock();""" | ||
| ), | ||
| lines( | ||
| s"this->parameterLoaded(${paramIdConstantName(param.getName)}, this->${paramValidityFlagName(param.getName)});" | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
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.