added get and set state to sidl, documentation still to do #112
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
| @@ -115,8 +115,12 @@ grouped by functional category. | |||
| :ref:`get_value` Get a copy of values of a given variable. | |||
| :ref:`get_value_ptr` Get a reference to the values of a given variable. | |||
| :ref:`get_value_at_indices` Get variable values at specific locations. | |||
| :ref:`get_state` Get all the variables that together form the state of the model. | |||
| :ref:`get_state_pr` Get a reference to the value of the state. | |||
There was a problem hiding this comment.
Might suggest get_state_ptr to be consistent with the other functions that get a reference.
There was a problem hiding this comment.
I see that this is defined as get_state_ptr in bmi-python so get_state_pr is a typo?
| :ref:`set_value` Set the values of a given variable. | ||
| :ref:`set_value_at_indices` Set the values of a variable at specific locations. | ||
| :ref:`set_state` Set all the variables that together form the state of the model. | ||
| :ref:`set_state_pr` Set the state by providing a reference. |
There was a problem hiding this comment.
Might suggest set_state_ptr to be consistent with the other functions that get a reference.
There was a problem hiding this comment.
I see that this is defined as set_state_ptr in bmi-python so set_state_pr is a typo?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I've added a get_state and set_state function, to allow users to get the entire state of a model in one request. Related pull requests on the bmi-python and bmi-examples-python repos show how to use this in Python