Package com.powsybl.cgmes.conversion.export

Class CgmesExportContext

java.lang.Object

com.powsybl.cgmes.conversion.export.CgmesExportContext

public class CgmesExportContext
extends Object

Author:

Miora Ralambotiana <miora.ralambotiana at rte-france.com>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CgmesExportContext.ModelDescription

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	ENCODE_IDS_DEFAULT_VALUE
static final boolean	EXPORT_BOUNDARY_POWER_FLOWS_DEFAULT_VALUE
static final boolean	EXPORT_POWER_FLOWS_FOR_SWITCHES_DEFAULT_VALUE
static final boolean	EXPORT_TRANSFORMERS_WITH_HIGHEST_VOLTAGE_AT_END1_DEFAULT_VALUE
static final String	SUB_REGION_ID

Constructor Summary

Constructors

Constructor	Description
CgmesExportContext()
CgmesExportContext(Network network)
CgmesExportContext(Network network, ReferenceDataProvider referenceDataProvider)
CgmesExportContext(Network network, ReferenceDataProvider referenceDataProvider, NamingStrategy namingStrategy)

Method Summary

Modifier and Type	Method	Description
void	addIidmMappings(Network network)
boolean	containsTopologicalNode(String tn)
String	encode(String id)
boolean	exportBoundaryPowerFlows()
boolean	exportFlowsForSwitches()
boolean	exportTransformersWithHighestVoltageAtEnd1()
BaseVoltageMapping.BaseVoltageSource	getBaseVoltageByNominalVoltage(double nominalV)
CgmesNamespace.Cim	getCim()
int	getCimVersion()
CgmesExportContext.ModelDescription	getEqModelDescription()
String	getFictitiousContainerFor(Identifiable<?> id)
NamingStrategy	getNamingStrategy()
String	getRegionName(String regionId)
Collection<String>	getRegionsIds()
Reporter	getReporter()
org.joda.time.DateTime	getScenarioTime()
CgmesExportContext.ModelDescription	getSshModelDescription()
String	getSubRegionName(String subRegionId)
CgmesExportContext.ModelDescription	getSvModelDescription()
Map<String,Bus>	getTopologicalNodes(Network network)
CgmesTopologyKind	getTopologyKind()
CgmesExportContext.ModelDescription	getTpModelDescription()
boolean	isExportedEquipment(Identifiable<?> c)
boolean	isExportEquipment()
void	putTopologicalNode(String tn, Bus bus)
CgmesExportContext	setBoundaryEqId(String boundaryEqId)
CgmesExportContext	setBoundaryTpId(String boundaryTpId)
CgmesExportContext	setCimVersion(int cimVersion)
CgmesExportContext	setEncodeIds(boolean encodeIds)
CgmesExportContext	setExportBoundaryPowerFlows(boolean exportBoundaryPowerFlows)
CgmesExportContext	setExportEquipment(boolean exportEquipment)
CgmesExportContext	setExportFlowsForSwitches(boolean exportFlowsForSwitches)
CgmesExportContext	setExportTransformersWithHighestVoltageAtEnd1(boolean exportTransformersWithHighestVoltageAtEnd1)
void	setFictitiousContainerFor(Identifiable<?> id, String containerId)
CgmesExportContext	setNamingStrategy(NamingStrategy namingStrategy)
CgmesExportContext	setReporter(Reporter reporter)
CgmesExportContext	setScenarioTime(org.joda.time.DateTime scenarioTime)
CgmesExportContext	setTopologyKind(CgmesTopologyKind topologyKind)
void	updateDependencies()
boolean	writeConnectivityNodes()

Methods inherited from class java.lang.Object

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

Field Details

SUB_REGION_ID

public static final String SUB_REGION_ID

See Also:

• Constant Field Values

EXPORT_BOUNDARY_POWER_FLOWS_DEFAULT_VALUE

public static final boolean EXPORT_BOUNDARY_POWER_FLOWS_DEFAULT_VALUE

See Also:

• Constant Field Values

EXPORT_POWER_FLOWS_FOR_SWITCHES_DEFAULT_VALUE

public static final boolean EXPORT_POWER_FLOWS_FOR_SWITCHES_DEFAULT_VALUE

See Also:

• Constant Field Values

EXPORT_TRANSFORMERS_WITH_HIGHEST_VOLTAGE_AT_END1_DEFAULT_VALUE

public static final boolean EXPORT_TRANSFORMERS_WITH_HIGHEST_VOLTAGE_AT_END1_DEFAULT_VALUE

See Also:

• Constant Field Values

ENCODE_IDS_DEFAULT_VALUE

public static final boolean ENCODE_IDS_DEFAULT_VALUE

See Also:

• Constant Field Values

Constructor Details

CgmesExportContext

public CgmesExportContext()

CgmesExportContext

public CgmesExportContext(Network network)

CgmesExportContext

public CgmesExportContext(Network network,
 ReferenceDataProvider referenceDataProvider)

CgmesExportContext

public CgmesExportContext(Network network,
 ReferenceDataProvider referenceDataProvider,
 NamingStrategy namingStrategy)

Method Details

updateDependencies

public void updateDependencies()

getFictitiousContainerFor

public String getFictitiousContainerFor(Identifiable<?> id)

setFictitiousContainerFor

public void setFictitiousContainerFor(Identifiable<?> id,
 String containerId)

addIidmMappings

public void addIidmMappings(Network network)

isExportEquipment

public boolean isExportEquipment()

setExportEquipment

public CgmesExportContext setExportEquipment(boolean exportEquipment)

isExportedEquipment

public boolean isExportedEquipment(Identifiable<?> c)

setBoundaryEqId

public CgmesExportContext setBoundaryEqId(String boundaryEqId)

setBoundaryTpId

public CgmesExportContext setBoundaryTpId(String boundaryTpId)

getCimVersion

public int getCimVersion()

setCimVersion

public CgmesExportContext setCimVersion(int cimVersion)

getTopologyKind

public CgmesTopologyKind getTopologyKind()

setTopologyKind

public CgmesExportContext setTopologyKind(CgmesTopologyKind topologyKind)

getScenarioTime

public org.joda.time.DateTime getScenarioTime()

setScenarioTime

public CgmesExportContext setScenarioTime(org.joda.time.DateTime scenarioTime)

getEqModelDescription

public CgmesExportContext.ModelDescription getEqModelDescription()

getTpModelDescription

public CgmesExportContext.ModelDescription getTpModelDescription()

getSvModelDescription

public CgmesExportContext.ModelDescription getSvModelDescription()

getSshModelDescription

public CgmesExportContext.ModelDescription getSshModelDescription()

exportBoundaryPowerFlows

public boolean exportBoundaryPowerFlows()

setExportBoundaryPowerFlows

public CgmesExportContext setExportBoundaryPowerFlows(boolean exportBoundaryPowerFlows)

exportFlowsForSwitches

public boolean exportFlowsForSwitches()

setExportFlowsForSwitches

public CgmesExportContext setExportFlowsForSwitches(boolean exportFlowsForSwitches)

exportTransformersWithHighestVoltageAtEnd1

public boolean exportTransformersWithHighestVoltageAtEnd1()

setExportTransformersWithHighestVoltageAtEnd1

public CgmesExportContext setExportTransformersWithHighestVoltageAtEnd1(boolean exportTransformersWithHighestVoltageAtEnd1)

encode

public String encode(String id)

setEncodeIds

public CgmesExportContext setEncodeIds(boolean encodeIds)

getCim

public CgmesNamespace.Cim getCim()

getNamingStrategy

public NamingStrategy getNamingStrategy()

setNamingStrategy

public CgmesExportContext setNamingStrategy(NamingStrategy namingStrategy)

getBaseVoltageByNominalVoltage

public BaseVoltageMapping.BaseVoltageSource getBaseVoltageByNominalVoltage(double nominalV)

writeConnectivityNodes

public boolean writeConnectivityNodes()

getRegionsIds

public Collection<String> getRegionsIds()

getRegionName

public String getRegionName(String regionId)

getSubRegionName

public String getSubRegionName(String subRegionId)

setReporter

public CgmesExportContext setReporter(Reporter reporter)

getReporter

public Reporter getReporter()

putTopologicalNode

public void putTopologicalNode(String tn,
 Bus bus)

containsTopologicalNode

public boolean containsTopologicalNode(String tn)

getTopologicalNodes

public Map<String,Bus> getTopologicalNodes(Network network)