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

Rename cse::variable_index #265

Closed
eidekrist opened this issue Jun 11, 2019 · 2 comments · Fixed by #339
Closed

Rename cse::variable_index #265

eidekrist opened this issue Jun 11, 2019 · 2 comments · Fixed by #339
Labels
discussion needed Let's have a discussion about this

Comments

@eidekrist
Copy link
Member

cse::variable_index represents the value reference of an FMI variable, which is a handle to a variable value, and not an index as such. In an FMU's modelDescription.xml, a variable's index, which can be different from its value reference, is used when describing the model's unknown outputs. This has caused confusion in the past, and will probably continue to do so in the future. I therefore boldly propose to rename cse::variable_index to cse::value_reference.

Thoughts?

@eidekrist eidekrist added the discussion needed Let's have a discussion about this label Jun 11, 2019
@markaren
Copy link
Contributor

Sounds good to me.

@kyllingstad
Copy link
Member

I agree. Should rename cse_variable_index in the C library too, then.

markaren added a commit that referenced this issue Aug 27, 2019
eidekrist pushed a commit that referenced this issue Aug 27, 2019
eidekrist pushed a commit that referenced this issue Aug 28, 2019
* Rename cse::variable_index #265

* #265 Rename local variables

* #265 Review followup. Fix stragglers, rename methods in simulator class.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion needed Let's have a discussion about this
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants