Skip to content

Commit

Permalink
update topology protobuf
Browse files Browse the repository at this point in the history
  • Loading branch information
@hiimjako
hiimjako committed Jun 4, 2024
1 parent df5f9b4 commit 2cec5d1
Show file tree
Hide file tree
Showing 5 changed files with 219 additions and 191 deletions.
82 changes: 40 additions & 42 deletions docs/topology.proto.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ direction LR
%%
class TopologicalNode {
+ string Id
+ List~string~ TerminalIds
+ List~string~ ConnectivityNodeIds
+ List~string~ BranchIds
Expand All @@ -63,36 +62,36 @@ class TopologicalNode {
}
```
### BranchConnection Diagram
### TopologicalIsland Diagram

```mermaid
classDiagram
direction LR
%% A wrapper in order to use an array in the map in TopologicalIsland.
%% * It represents the connections between the TopologicalNodes in the TopologicalIsland.
%% A topology Island information.
%% * To be used in ComputedTopology message.
%%
class BranchConnection {
+ List~string~ TopologicalNodeIds
class TopologicalIsland {
+ string Id
+ Map~string, TopologicalNode~ TopologicalNodes
}
TopologicalIsland .. ` TopologicalNode`
```
### TopologicalIsland Diagram
### BranchConnection Diagram

```mermaid
classDiagram
direction LR
%% A topology Island information.
%% * To be used in ComputedTopology message.
%% A wrapper in order to use an array in the map in TopologicalIsland.
%% * It represents the connections between the TopologicalNodes in the TopologicalIsland.
%%
class TopologicalIsland {
+ string Id
+ List~TopologicalNode~ TopologicalNodes
class BranchConnection {
+ List~string~ TopologicalNodeIds
}
TopologicalIsland --> `TopologicalNode`
```
### ComputedTopology Diagram
Expand All @@ -112,10 +111,10 @@ direction LR
class ComputedTopology {
+ string eqId
+ List~TopologicalIsland~ topologicalIslands
+ Map~string, TopologicalIsland~ topologicalIslands
+ Map~string, BranchConnection~ BranchConnections
}
ComputedTopology --> `TopologicalIsland`
ComputedTopology .. ` TopologicalIsland`
ComputedTopology .. ` BranchConnection`
```
Expand Down Expand Up @@ -153,46 +152,45 @@ A topology Node information.

| Field | Ordinal | Type | Label | Description |
|-------------------------------|---------|----------|----------|------------------------------------------------------------------|
| `Id` | 1 | `string` | | The id of the TopologicalNode. |
| `TerminalIds` | 2 | `string` | Repeated | The list of Terminal ids in the TopologicalNode. |
| `ConnectivityNodeIds` | 3 | `string` | Repeated | The list of ConnectivityNode ids in the TopologicalNode. |
| `BranchIds` | 4 | `string` | Repeated | The list of Branch ids in the TopologicalNode. |
| `ConnectivityNodeContainerId` | 5 | `string` | | The id of the ConnectivityNodeContainer in the TopologicalNode. |
| `BaseVoltageId` | 6 | `string` | | The id of the BaseVoltage in the TopologicalNode. |
| `BaseVoltage` | 7 | `double` | | The BaseVoltage in the TopologicalNode. |
| `TerminalIds` | 1 | `string` | Repeated | The list of Terminal ids in the TopologicalNode. |
| `ConnectivityNodeIds` | 2 | `string` | Repeated | The list of ConnectivityNode ids in the TopologicalNode. |
| `BranchIds` | 3 | `string` | Repeated | The list of Branch ids in the TopologicalNode. |
| `ConnectivityNodeContainerId` | 4 | `string` | | The id of the ConnectivityNodeContainer in the TopologicalNode. |
| `BaseVoltageId` | 5 | `string` | | The id of the BaseVoltage in the TopologicalNode. |
| `BaseVoltage` | 6 | `double` | | The BaseVoltage in the TopologicalNode. |




## Message: BranchConnection
## Message: TopologicalIsland

**FQN**: zaphiro.grid.v1.BranchConnection
**FQN**: zaphiro.grid.v1.TopologicalIsland

A wrapper in order to use an array in the map in TopologicalIsland.
* It represents the connections between the TopologicalNodes in the TopologicalIsland.
A topology Island information.
* To be used in ComputedTopology message.



| Field | Ordinal | Type | Label | Description |
|----------------------|---------|----------|----------|-----------------------------------------------------------|
| `TopologicalNodeIds` | 1 | `string` | Repeated | The list of TopologicalNode ids connected to the Branch. |
| Field | Ordinal | Type | Label | Description |
|--------------------|---------|---------------------------|-------|---------------------------------------------------------------------|
| `Id` | 1 | `string` | | The id of the TopologicalIsland. |
| `TopologicalNodes` | 2 | `string, TopologicalNode` | Map | The list of TopologicalNode in the TopologicalIsland. TN id -> TN. |




## Message: TopologicalIsland
## Message: BranchConnection

**FQN**: zaphiro.grid.v1.TopologicalIsland
**FQN**: zaphiro.grid.v1.BranchConnection

A topology Island information.
* To be used in ComputedTopology message.
A wrapper in order to use an array in the map in TopologicalIsland.
* It represents the connections between the TopologicalNodes in the TopologicalIsland.



| Field | Ordinal | Type | Label | Description |
|--------------------|---------|-------------------|----------|--------------------------------------------------------|
| `Id` | 1 | `string` | | The id of the TopologicalIsland. |
| `TopologicalNodes` | 2 | `TopologicalNode` | Repeated | The list of TopologicalNode in the TopologicalIsland. |
| Field | Ordinal | Type | Label | Description |
|----------------------|---------|----------|----------|-----------------------------------------------------------|
| `TopologicalNodeIds` | 1 | `string` | Repeated | The list of TopologicalNode ids connected to the Branch. |



Expand All @@ -211,11 +209,11 @@ Headers used in rabbitMQ:



| Field | Ordinal | Type | Label | Description |
|----------------------|---------|----------------------------|----------|-----------------------------------------------------------------------------------------------------|
| `eqId` | 1 | `string` | | The id of the EQ file used. |
| `topologicalIslands` | 2 | `TopologicalIsland` | Repeated | The map of TopologicalIslands in the Topology. |
| `BranchConnections` | 3 | `string, BranchConnection` | Map | All the connections between the TopologicalNodes in the TopologicalIsland. TN id -> TN connection. |
| Field | Ordinal | Type | Label | Description |
|----------------------|---------|-----------------------------|-------|-----------------------------------------------------------------------------------------------------|
| `eqId` | 1 | `string` | | The id of the EQ file used. |
| `topologicalIslands` | 2 | `string, TopologicalIsland` | Map | The map of TopologicalIslands in the Topology. TI id -> TI. |
| `BranchConnections` | 3 | `string, BranchConnection` | Map | All the connections between the TopologicalNodes in the TopologicalIsland. TN id -> TN connection. |



Expand Down
Loading

0 comments on commit 2cec5d1

Please sign in to comment.