Rename Area acInterchangeTarget to interchangeTarget #3095
Merged
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.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
Bugfix
What is the current behavior?
Starting with iIDM 1.13 / powsybl-core 6.4.0 Area has
acInterchangeTarget
attribute (see #2955)What is the new behavior (if this is a feature change)?
Area
acInterchangeTarget
attribute is renamed tointerchangeTarget
. Note that besides a naming change, this is also and mostly a functional change.For consistency,
Area::getTotalInterchange
was also renamed toArea::getInterchange
.Does this PR introduce a breaking change or deprecate an API?
If yes, please check if the following requirements are fulfilled
What changes might users need to make in their application due to this PR? (migration steps)
Users who serialized iIDM-s containing Areas and acInterchangeTargets with powsybl-core 6.4.0 will need to manually amend their serialized files in order to be able to read them back in upcoming powsybl-core 6.4.1.
Custom IIDM implementation maintainers should rename the following methods in their
Area
implementations:getAcInterchangeTarget()
=>getInterchangeTarget()
setAcInterchangeTarget(double)
=>setInterchangeTarget(double)
getTotalInterchange()
=>getInterchange()
Other information:
Rationale for the change: it was a mistake from #2955. Data formats define usually total interchange targets for the areas, not just the AC part. This is for example the case in CGMES. Looking at other data formats: