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

Renaming AttachNewLineOnLine / AttachVoltageLevelOnLine #2229

Closed
flo-dup opened this issue Aug 4, 2022 · 2 comments · Fixed by #2238
Closed

Renaming AttachNewLineOnLine / AttachVoltageLevelOnLine #2229

flo-dup opened this issue Aug 4, 2022 · 2 comments · Fixed by #2238
Assignees

Comments

@flo-dup
Copy link
Contributor

flo-dup commented Aug 4, 2022

Do you want to request a feature or report a bug?
None of them, renaming

What is the current behavior?

  • AttachVoltageLevelOnline to insert (/attach/connect) an existing voltage level on a line by creating a line tap (or tee point) on that line, therefore cutting the existing line in two.
  • AttachNewLineOnLine to insert (/attach/connect) similarly an existing voltage level on a line by creating a fictitious switching voltage level on that line, therefore also cutting the existing line in two.

What is the expected behavior?
The "Attach" term does not seem to be used a lot in that context. "Connect" or "Insert" seem more appropriate.

Besides, the "line tap" or "tee point" (point de piquage in french) and the "switching substation" (poste de coupure in french) terms which are referenced by IEC are not mentioned.

What is the motivation / use case for changing the behavior?
Having a more understandable name.

Nonetheless, for its cons, the current javadoc is pretty clear, and the term attach even if not common is still understandable. Is it worth the breaking change?

Other information
IEC links:
line tap: https://www.electropedia.org/iev/iev.nsf/display?openform&ievref=601-02-29
tapped substation: https://www.electropedia.org/iev/iev.nsf/display?openform&ievref=601-02-21
switching substation: https://www.electropedia.org/iev/iev.nsf/display?openform&ievref=605-01-02

@geofjamg
Copy link
Member

geofjamg commented Aug 4, 2022

Yes it worth a breaking change. It is a quite new feature, so nobody worried about the change.

@annetill
Copy link
Member

I understand. The renaming could help understanding better this feature but we should also rely on documentation. These two methods are already well documented because they cannot be used without any documentation, and we can imagine to add the terms "line tap" or "tee point" and "switching substation", and the links to IEC.

The method AttachVoltageLevelOnline could be renamed, but what do you suggest? I understand that you want to replace attach by connect or insert. But adding switching substation is confusing because we create a voltage level that does not belong to any substation but to the network. In the method it is really the voltage level that is inserted. So it could be InsertSwitchingVoltageLevelOnLine or ConnectSwitchingVoltageLevelOnLine. I think I prefer the last one.

The method AttachNewLineOnLine, we create a tee point yes, but we also connect a new line to this point. It is a bit different that above. So, if you really want to have this "tee point term", we could imagine something like ConnectNewLineOnLineThroughTeePoint?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants