Package com.powsybl.cgmes.conversion

Class CgmesExport

java.lang.Object

com.powsybl.cgmes.conversion.CgmesExport

All Implemented Interfaces:

Exporter

@AutoService(Exporter.class)
public class CgmesExport
extends Object
implements Exporter

Author:

Luma Zamarreño <zamarrenolm at aia.es>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_NAME
static final String	BOUNDARY_EQ_ID
static final String	BOUNDARY_TP_ID
static final String	BUSINESS_PROCESS
static final String	CGM_EXPORT
static final String	CIM_VERSION
static final String	EXPORT_BOUNDARY_POWER_FLOWS
static final String	EXPORT_LOAD_FLOW_STATUS
static final String	EXPORT_POWER_FLOWS_FOR_SWITCHES
static final String	EXPORT_SV_INJECTIONS_FOR_SLACKS
static final String	EXPORT_TRANSFORMERS_WITH_HIGHEST_VOLTAGE_AT_END1
static final String	MAX_P_MISMATCH_CONVERGED
static final String	MAX_Q_MISMATCH_CONVERGED
static final String	MODEL_DESCRIPTION
static final String	MODEL_VERSION
static final String	MODELING_AUTHORITY_SET
static final String	NAMING_STRATEGY
static final String	PROFILES
static final String	SOURCING_ACTOR
static final String	UPDATE_DEPENDENCIES
static final String	UUID_NAMESPACE

Constructor Summary

Constructors

Constructor	Description
CgmesExport()
CgmesExport(PlatformConfig platformConfig)

Method Summary

Modifier and Type	Method	Description
void	export(Network network, Properties parameters, DataSource dataSource, ReportNode reportNode)	Export the requested network to the CGMES format.
String	getComment()	Get some information about this exporter.
String	getFormat()	Get a unique identifier of the format.
List<Parameter>	getParameters()	Get a description of export parameters
static CgmesMetadataModel	initializeModelForExport(Network network, CgmesSubset subset, CgmesExportContext context, boolean mainNetwork, boolean modelUpdate)	Initialize the model (= the metadata information) that is used by the export.

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

Field Details

BASE_NAME

public static final String BASE_NAME

See Also:

• Constant Field Values

BOUNDARY_EQ_ID

public static final String BOUNDARY_EQ_ID

See Also:

• Constant Field Values

BOUNDARY_TP_ID

public static final String BOUNDARY_TP_ID

See Also:

• Constant Field Values

CIM_VERSION

public static final String CIM_VERSION

See Also:

• Constant Field Values

EXPORT_BOUNDARY_POWER_FLOWS

public static final String EXPORT_BOUNDARY_POWER_FLOWS

See Also:

• Constant Field Values

EXPORT_POWER_FLOWS_FOR_SWITCHES

public static final String EXPORT_POWER_FLOWS_FOR_SWITCHES

See Also:

• Constant Field Values

NAMING_STRATEGY

public static final String NAMING_STRATEGY

See Also:

• Constant Field Values

PROFILES

public static final String PROFILES

See Also:

• Constant Field Values

CGM_EXPORT

public static final String CGM_EXPORT

See Also:

• Constant Field Values

MODELING_AUTHORITY_SET

public static final String MODELING_AUTHORITY_SET

See Also:

• Constant Field Values

MODEL_DESCRIPTION

public static final String MODEL_DESCRIPTION

See Also:

• Constant Field Values

EXPORT_TRANSFORMERS_WITH_HIGHEST_VOLTAGE_AT_END1

public static final String EXPORT_TRANSFORMERS_WITH_HIGHEST_VOLTAGE_AT_END1

See Also:

• Constant Field Values

EXPORT_LOAD_FLOW_STATUS

public static final String EXPORT_LOAD_FLOW_STATUS

See Also:

• Constant Field Values

MAX_P_MISMATCH_CONVERGED

public static final String MAX_P_MISMATCH_CONVERGED

See Also:

• Constant Field Values

MAX_Q_MISMATCH_CONVERGED

public static final String MAX_Q_MISMATCH_CONVERGED

See Also:

• Constant Field Values

EXPORT_SV_INJECTIONS_FOR_SLACKS

public static final String EXPORT_SV_INJECTIONS_FOR_SLACKS

See Also:

• Constant Field Values

SOURCING_ACTOR

public static final String SOURCING_ACTOR

See Also:

• Constant Field Values

UUID_NAMESPACE

public static final String UUID_NAMESPACE

See Also:

• Constant Field Values

MODEL_VERSION

public static final String MODEL_VERSION

See Also:

• Constant Field Values

BUSINESS_PROCESS

public static final String BUSINESS_PROCESS

See Also:

• Constant Field Values

UPDATE_DEPENDENCIES

public static final String UPDATE_DEPENDENCIES

See Also:

• Constant Field Values

Constructor Details

CgmesExport

public CgmesExport(PlatformConfig platformConfig)

CgmesExport

public CgmesExport()

Method Details

getParameters

public List<Parameter> getParameters()

Description copied from interface: Exporter

Get a description of export parameters

Specified by:

getParameters in interface Exporter

Returns:

export

public void export(Network network,
 Properties parameters,
 DataSource dataSource,
 ReportNode reportNode)

Export the requested network to the CGMES format.

Specified by:

export in interface Exporter

Parameters:

network - The network to export.

parameters - Optional parameters that influence the export.

dataSource - The dataSource used by the export.

reportNode - The reportNode used for functional logs.

initializeModelForExport

public static CgmesMetadataModel initializeModelForExport(Network network,
 CgmesSubset subset,
 CgmesExportContext context,
 boolean mainNetwork,
 boolean modelUpdate)

Initialize the model (= the metadata information) that is used by the export. If existing, the network model extension is used for the initialization. If existing, optional parameters are also used for the initialization. If both are present, the optional parameters prevail the values in the network extension.

Parameters:

network - The network in which to look for an existing model extension as basis for initialization.

subset - The subset of the model to initialize.

context - The context used by the export.

mainNetwork - A boolean indicating whether the exported network is the main network (not a subnetwork).

modelUpdate - A boolean indicating whether the model version and ID should be updated.

Returns:

A model with all necessary metadata information for the export.

getComment

public String getComment()

Description copied from interface: Exporter

Get some information about this exporter.

Specified by:

getComment in interface Exporter

getFormat

public String getFormat()

Description copied from interface: Exporter

Get a unique identifier of the format.

Specified by:

getFormat in interface Exporter