Package com.powsybl.iidm.serde

Class AbstractTreeDataExporter

java.lang.Object

com.powsybl.iidm.serde.AbstractTreeDataExporter

All Implemented Interfaces:

Exporter

Direct Known Subclasses:

BinaryExporter, JsonExporter, XMLExporter

public abstract class AbstractTreeDataExporter
extends Object
implements Exporter

Tree data 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.anonymised	if true then exported network is anonymous	true or false
iidm.export.xml.iidm-version-incompatibility-behavior	behavior when there is an IIDM version incompatibility	THROW_EXCEPTION or LOG_ERROR
iidm.export.xml.topology-level	the detail level used in the export of voltage levels	NODE_BREAKER, BUS_BREAKER, BUS_BRANCH
iidm.export.xml.throw-exception-if-extension-not-found	if true throw exception when extension not found	true or false
iidm.export.xml.extensions	list of exported extensions	comma-separated string
iidm.export.xml.sorted	sort export output file	true or false
iidm.export.xml.version	version in which files will be generated	1.5 or 1.4 etc
iidm.export.xml.with-automation-systems	if true automation systems are exported	true or false

Author:

Geoffroy Jamgotchian <geoffroy.jamgotchian at rte-france.com>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANONYMISED
static final String	EXTENSIONS_LIST
static final String	IIDM_VERSION_INCOMPATIBILITY_BEHAVIOR
static final String	INDENT
static final String	ONLY_MAIN_CC
static final String	SORTED
static final String	THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND
static final String	TOPOLOGY_LEVEL
static final String	VERSION
static final String	WITH_AUTOMATION_SYSTEMS
static final String	WITH_BRANCH_STATE_VARIABLES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTreeDataExporter(PlatformConfig platformConfig)

Method Summary

Modifier and Type	Method	Description
void	export(Network network, Properties parameters, DataSource dataSource)	Export a model.
protected abstract String	getExtension()
List<Parameter>	getParameters()	Get a description of export parameters
protected abstract TreeDataFormat	getTreeDataFormat()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.iidm.network.Exporter

export, getComment, getFormat

Field Details

INDENT

public static final String INDENT

See Also:

• Constant Field Values

WITH_BRANCH_STATE_VARIABLES

public static final String WITH_BRANCH_STATE_VARIABLES

See Also:

• Constant Field Values

ONLY_MAIN_CC

public static final String ONLY_MAIN_CC

See Also:

• Constant Field Values

ANONYMISED

public static final String ANONYMISED

See Also:

• Constant Field Values

IIDM_VERSION_INCOMPATIBILITY_BEHAVIOR

public static final String IIDM_VERSION_INCOMPATIBILITY_BEHAVIOR

See Also:

• Constant Field Values

TOPOLOGY_LEVEL

public static final String TOPOLOGY_LEVEL

See Also:

• Constant Field Values

THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

public static final String THROW_EXCEPTION_IF_EXTENSION_NOT_FOUND

See Also:

• Constant Field Values

EXTENSIONS_LIST

public static final String EXTENSIONS_LIST

See Also:

• Constant Field Values

SORTED

public static final String SORTED

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

WITH_AUTOMATION_SYSTEMS

public static final String WITH_AUTOMATION_SYSTEMS

See Also:

• Constant Field Values

Constructor Details

AbstractTreeDataExporter

protected AbstractTreeDataExporter(PlatformConfig platformConfig)

Method Details

getTreeDataFormat

protected abstract TreeDataFormat getTreeDataFormat()

getExtension

protected abstract String getExtension()

export

public void export(Network network,
 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

getParameters

public List<Parameter> getParameters()

Description copied from interface: Exporter

Get a description of export parameters

Specified by:

getParameters in interface Exporter

Returns: