You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/iidm/exporter/iidm.md
+34-4Lines changed: 34 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,14 @@ For more information about the IIDM model, see [here](../model/index.md).
11
11
12
12
IIDM networks can be serialized in XML files. The IIDM exporter generates files with a `*.xiidm` extension.
13
13
14
+
The IIDM exporter has three exporting modes:
15
+
16
+
-**First mode**: Exports the network and its extensions in a unique file.
17
+
18
+
-**Second mode**: Exports the network in a file and the extensions in another file.
19
+
20
+
-**Third mode**: Exports the network in a file and each extension type in a separate file.
21
+
14
22
# Example
15
23
```xml
16
24
<?xml version="1.0" encoding="UTF-8"?>
@@ -78,10 +86,6 @@ of the network or not. Its default value is `false`.
78
86
The `iidm.export.xml.anonymised` property is an optional property that defines if the XIIDM exporter anonymises
79
87
all equipments in the generated file or not. Its default value is `false`.
80
88
81
-
## iidm.export.xml.skip-extensions
82
-
The `iidm.export.xml.skip-extensions` property is an optional property that defines if the XIIDM exporter skips exporting the
83
-
network extensions or not. Its default value is `false`.
84
-
85
89
## iidm.export.xml.topology-level
86
90
The `iidm.export.xml.topology-level` property is an optional property that defines if the most detailed topology in which the XIIDM exporter can export the
87
91
network. Its default value is `NODE_BREAKER`.
@@ -90,6 +94,32 @@ network. Its default value is `NODE_BREAKER`.
90
94
The `iidm.export.xml.throw-exception-if-extension-not-found` property is an optional property that defines if the XIIDM exporter throws
91
95
an exception if the network contains an unknown or unserializable extension or if it just ignores it. Its default value is `false`.
92
96
97
+
## iidm.export.xml.export-mode
98
+
The `iidm.export.xml.export-mode` property is an optional property that defines the export mode of the XIIDM exporter.
99
+
The export mode can be:
100
+
101
+
-`IidmImportExportMode.UNIQUE_FILE`: in case we want to export the network and its extensions in a unique file.
102
+
103
+
-`IidmImportExportMode.EXTENSIONS_IN_ONE_SEPARATED_FILE`: in case we want to export the network in a file and the extensions in a separate file.
104
+
Example: if our network `test` has extensions then the network will be exported in the `test.xiidm` file when all its extensions will be exported in `test-ext.xiidm` file.
105
+
106
+
-`IidmImportExportMode.ONE_SEPARATED_FILE_PER_EXTENSION_TYPE`: in case we want to export network in a file and each extension type in a separate file.
107
+
Example: if our network `test` has two extensions `loadFoo` and `loadBar` then the network will be exported
108
+
in the `test.xiidm` file when `loadFoo` and `loadBar` will be exported respectively in `test-loadFoo.xiidm` and `test-loadBar.xiidm`.
109
+
110
+
The default value for this parameter is `IidmImportExportMode.NO_SEPARATED_FILE_FOR_EXTENSIONS`.
111
+
112
+
## iidm.export.xml.extensions
113
+
The `iidm.export.xml.extensions` property is an optional property that defines the list of extensions that we want to export by the XIIDM exporter.
114
+
By default all extensions will be exported.
115
+
116
+
# Deprecated configuration properties for IIDM-XML exporter
117
+
118
+
## iidm.export.xml.skip-extensions
119
+
The `iidm.export.xml.skip-extensions` property is an optional property that defines if the XIIDM exporter skips exporting the
120
+
network extensions or not. Its default value is `false`.
121
+
This property is deprecated since v2.4.0. Use the `iidm.export.xml.export-mode` property instead.
122
+
93
123
# Maven configuration
94
124
To support IIDM-XML files, add the following dependencies to the `pom.xml` file.
0 commit comments