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

[WIP] Fixed layout type for NAD #918

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[WIP] Fixed layout type for NAD #918

wants to merge 4 commits into from

Conversation

CBiasuzzi
Copy link
Contributor

@CBiasuzzi CBiasuzzi commented Dec 13, 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?

feature

What is the current behavior?

What is the new behavior (if this is a feature change)?

Adds a FIXED type to the NadLayoutType list, to be able to generate a NAD with a fixed layout (through the powsybl-diagram's FixedLayout implementation). The NAD's fixed positions, encoded as JSON metadata (e.g., as a result of a previously computed NAD), can be specified in a new NadParameters' parameter 'metadata'. Diagram elements' positions that are not listed in the JSON metadata will be computed using the Force Layout.

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

  • Yes
  • No

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)

Other information:

Note that prerequisite to this PR is the powsybl-diagram's powsybl/powsybl-diagram#656
Note that this PR uses powsybl-diagram's APIs available in v4.7.0: the pom.xml is changed temporarily to force that version.

Note: comments to this PR suggested a different, scaled-down, approach. Please see PR #928

…instead of using the constructor which already reached the maximum allowed number of parameters

Signed-off-by: Christian Biasuzzi <[email protected]>
Copy link

Copy link

@@ -369,6 +369,7 @@ typedef struct nad_parameters_struct {
int scaling_factor;
double radius_factor;
int edge_info_displayed;
char* metadata;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we'd rather put a fixed_positions parameter in get_network_area_diagram, together with an extract_positions utility method which would link to DiagramMetadata::getFixedPositions and DiagramMetadata::getFixedTextPositions.

@@ -613,7 +613,8 @@ PYBIND11_MODULE(_pypowsybl, m) {

py::enum_<pypowsybl::NadLayoutType>(m, "NadLayoutType")
.value("FORCE_LAYOUT", pypowsybl::NadLayoutType::FORCE_LAYOUT)
.value("GEOGRAPHICAL", pypowsybl::NadLayoutType::GEOGRAPHICAL);
.value("GEOGRAPHICAL", pypowsybl::NadLayoutType::GEOGRAPHICAL)
.value("FIXED", pypowsybl::NadLayoutType::FIXED);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not really fond of having a "fixed" layout, knowing that the voltage levels with no position would be layout based on the force layout.

@CBiasuzzi CBiasuzzi changed the title Fixed layout type for NAD [WIP] Fixed layout type for NAD Dec 20, 2024
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 this pull request may close these issues.

2 participants