com.powsybl.iidm.xml

Class XMLExporter

java.lang.Object

com.powsybl.iidm.xml.XMLExporter

All Implemented Interfaces:

Exporter

@AutoService(value=Exporter.class)
public class XMLExporter
extends java.lang.Object
implements Exporter

XML export of an IIDM model.

property name	comment	possible values
iidm.export.xml.indent	if true write indented xml (4 spaces)	true or false
iidm.export.xml.with-branch-state-variables	if true export branches state (active and reactive flow)	true or false
iidm.export.xml.only-main-cc	if true only export equipments of the main connected component	true or false
iidm.export.xml.topology-level	the detail level used in the export of voltage levels	NODE_BREAKER, BUS_BREAKER, BUS_BRANCH

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANONYMISED
static java.lang.String	EXPORT_MODE
static java.lang.String	EXTENSIONS_LIST
static java.lang.String	INDENT
static java.lang.String	ONLY_MAIN_CC
static java.lang.String	SKIP_EXTENSIONS
static java.lang.String	THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND
static java.lang.String	TOPOLOGY_LEVEL
static java.lang.String	WITH_BRANCH_STATE_VARIABLES

Constructor Summary

Constructors

Constructor and Description
XMLExporter()
XMLExporter(PlatformConfig platformConfig)

Method Summary

Modifier and Type	Method and Description
void	export(Network network, java.util.Properties parameters, DataSource dataSource) Export a model.
java.lang.String	getComment() Get some information about this exporter.
java.lang.String	getFormat() Get a unique identifier of the format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INDENT

public static final java.lang.String INDENT

See Also:

Constant Field Values

WITH_BRANCH_STATE_VARIABLES

public static final java.lang.String WITH_BRANCH_STATE_VARIABLES

See Also:

Constant Field Values

ONLY_MAIN_CC

public static final java.lang.String ONLY_MAIN_CC

See Also:

Constant Field Values

ANONYMISED

public static final java.lang.String ANONYMISED

See Also:

Constant Field Values

TOPOLOGY_LEVEL

public static final java.lang.String TOPOLOGY_LEVEL

See Also:

Constant Field Values

THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

public static final java.lang.String THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

See Also:

Constant Field Values

EXPORT_MODE

public static final java.lang.String EXPORT_MODE

See Also:

Constant Field Values

EXTENSIONS_LIST

public static final java.lang.String EXTENSIONS_LIST

See Also:

Constant Field Values

SKIP_EXTENSIONS

public static final java.lang.String SKIP_EXTENSIONS

See Also:

Constant Field Values

Constructor Detail

XMLExporter

public XMLExporter()

XMLExporter

public XMLExporter(PlatformConfig platformConfig)

Method Detail

getFormat

public java.lang.String getFormat()

Description copied from interface: Exporter

Get a unique identifier of the format.

Specified by:

getFormat in interface Exporter

getComment

public java.lang.String getComment()

Description copied from interface: Exporter

Get some information about this exporter.

Specified by:

getComment in interface Exporter

export

public void export(Network network,
                   java.util.Properties parameters,
                   DataSource dataSource)

Description copied from interface: Exporter

Export a model.

Specified by:

export in interface Exporter

Parameters:

network - the model

parameters - some properties to configure the export

dataSource - data source