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 Area acInterchangeTarget to interchangeTarget #3095

Merged
merged 5 commits into from
Jul 11, 2024

Conversation

jeandemanged
Copy link
Member

@jeandemanged jeandemanged commented Jul 9, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

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 to interchangeTarget. Note that besides a naming change, this is also and mostly a functional change.
For consistency, Area::getTotalInterchange was also renamed to Area::getInterchange.

Does this PR introduce a breaking change or deprecate an API?

  • Yes

If yes, please check if the following requirements are fulfilled

  • The Breaking Change or Deprecated label has been added
  • The migration steps are described in the following section

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:

  • IEEE-CDF: does not have DC network description, but defines area interchange, not just "AC interchange"
  • UCTE-DEF: same as IEEE-CDF
  • PSS/E: Area PDES is "Desired net interchange leaving the area (export); entered in MW.", therefore not just "AC interchange"
  • powerfactory: ?

Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>
@jeandemanged jeandemanged changed the title [WIP] Rename Area acInterchangeTarget to interchangeTarget Rename Area acInterchangeTarget to interchangeTarget Jul 9, 2024
Copy link

sonarcloud bot commented Jul 11, 2024

@olperr1 olperr1 merged commit feeb6bc into main Jul 11, 2024
7 checks passed
@olperr1 olperr1 deleted the area-rename-interchange-target branch July 11, 2024 14:44
@olperr1 olperr1 added the bug label Jul 11, 2024
olperr1 pushed a commit that referenced this pull request Jul 11, 2024
Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>
(cherry picked from commit feeb6bc)
geofjamg pushed a commit that referenced this pull request Sep 18, 2024
Signed-off-by: Damien Jeandemange <damien.jeandemange@artelys.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants