Package com.powsybl.cgmes.model

Interface CgmesModel

All Known Implementing Classes:

AbstractCgmesModel, CgmesModelTripleStore, InMemoryCgmesModel

public interface CgmesModel

Author:

Luma Zamarreño <zamarrenolm at aia.es>

Method Summary

Modifier and Type	Method	Description
PropertyBags	acDcConverters()
PropertyBags	acLineSegments()
void	add(CgmesSubset subset, String type, PropertyBags objects)
default void	add(String context, String type, PropertyBags objects)
PropertyBags	allObjectsOfType(String type)
PropertyBags	asynchronousMachines()
static String	baseName(ReadOnlyDataSource ds)
PropertyBags	baseVoltages()
PropertyBags	boundaryNodes()
PropertyBags	busBarSections()
void	clear(CgmesSubset subset)
Collection<CgmesTerminal>	computedTerminals()
PropertyBags	connectivityNodeContainers()
PropertyBags	connectivityNodes()
CgmesContainer	container(String containerId)
PropertyBags	controlAreas()
PropertyBags	countrySourcingActors(String countryName)
ZonedDateTime	created()
PropertyBags	dcLineSegments()
CgmesDcTerminal	dcTerminal(String dcTerminalId)
PropertyBags	dcTerminals()
PropertyBags	energyConsumers()
PropertyBags	energySources()
PropertyBags	equivalentBranches()
PropertyBags	equivalentInjections()
PropertyBags	equivalentShunts()
PropertyBags	externalNetworkInjections()
default PropertyBags	fullModels()
String	getBasename()
Properties	getProperties()
default PropertyBags	graph()
default PropertyBags	grounds()
Map<String,PropertyBags>	groupedTransformerEnds()
boolean	hasBoundary()
boolean	hasEquipmentCore()
boolean	isNodeBreaker()
String	modelId()
default PropertyBags	modelProfiles()
double	nominalVoltage(String baseVoltageId)
PropertyBags	nonlinearShuntCompensatorPoints(String id)
PropertyBags	numObjectsByType()
PropertyBags	operationalLimits()
List<String>	phaseTapChangerListForPowerTransformer(String powerTransformerId)
PropertyBags	phaseTapChangers()
PropertyBags	phaseTapChangerTable(String tableId)
PropertyBags	phaseTapChangerTablesPoints()
void	print(PrintStream out)
void	print(Consumer<String> liner)
List<String>	ratioTapChangerListForPowerTransformer(String powerTransformerId)
PropertyBags	ratioTapChangers()
PropertyBags	ratioTapChangerTable(String tableId)
PropertyBags	ratioTapChangerTablesPoints()
PropertyBags	reactiveCapabilityCurveData()
void	read(ReadOnlyDataSource mainDataSource, ReadOnlyDataSource alternativeDataSourceForBoundary, ReportNode reportNode)
void	read(ReadOnlyDataSource ds, ReportNode reportNode)
void	read(InputStream is, String baseName, String contextName, ReportNode reportNode)
PropertyBags	regulatingControls()
ZonedDateTime	scenarioTime()
PropertyBags	seriesCompensators()
void	setBasename(String baseName)
PropertyBags	shuntCompensators()
PropertyBags	sourcingActor(String sourcingActor)
PropertyBags	staticVarCompensators()
String	substation(CgmesTerminal t, boolean nodeBreaker)	Obtain the substation of a given terminal.
PropertyBags	substations()
PropertyBags	svInjections()
PropertyBags	switches()
default PropertyBags	synchronousMachines()	Deprecated, for removal: This API element is subject to removal in a future version. Synchronous machines can be generators or condensers, they are obtained separately.
default PropertyBags	synchronousMachinesCondensers()
default PropertyBags	synchronousMachinesGenerators()
CgmesTerminal	terminal(String terminalId)
PropertyBags	terminals()
default PropertyBags	tieFlows()
default PropertyBags	topologicalIslands()
PropertyBags	topologicalNodes()
PropertyBags	transformerEnds()
PropertyBags	transformers()
TripleStore	tripleStore()
String	version()
String	voltageLevel(CgmesTerminal t, boolean nodeBreaker)	Obtain the voltage level grouping in which a given terminal is contained.
PropertyBags	voltageLevels()
void	write(DataSource ds)
default void	write(DataSource ds, CgmesSubset subset)

Method Details

tripleStore

TripleStore tripleStore()

getProperties

Properties getProperties()

fullModels

default PropertyBags fullModels()

hasEquipmentCore

boolean hasEquipmentCore()

modelId

String modelId()

version

String version()

scenarioTime

ZonedDateTime scenarioTime()

created

ZonedDateTime created()

isNodeBreaker

boolean isNodeBreaker()

hasBoundary

boolean hasBoundary()

terminal

CgmesTerminal terminal(String terminalId)

computedTerminals

Collection<CgmesTerminal> computedTerminals()

numObjectsByType

PropertyBags numObjectsByType()

allObjectsOfType

PropertyBags allObjectsOfType(String type)

boundaryNodes

PropertyBags boundaryNodes()

baseVoltages

PropertyBags baseVoltages()

countrySourcingActors

PropertyBags countrySourcingActors(String countryName)

sourcingActor

PropertyBags sourcingActor(String sourcingActor)

substations

PropertyBags substations()

voltageLevels

PropertyBags voltageLevels()

terminals

PropertyBags terminals()

connectivityNodeContainers

PropertyBags connectivityNodeContainers()

operationalLimits

PropertyBags operationalLimits()

connectivityNodes

PropertyBags connectivityNodes()

topologicalNodes

PropertyBags topologicalNodes()

busBarSections

PropertyBags busBarSections()

switches

PropertyBags switches()

acLineSegments

PropertyBags acLineSegments()

equivalentBranches

PropertyBags equivalentBranches()

seriesCompensators

PropertyBags seriesCompensators()

transformers

PropertyBags transformers()

transformerEnds

PropertyBags transformerEnds()

groupedTransformerEnds

Map<String,PropertyBags> groupedTransformerEnds()

ratioTapChangers

PropertyBags ratioTapChangers()

phaseTapChangers

PropertyBags phaseTapChangers()

regulatingControls

PropertyBags regulatingControls()

energyConsumers

PropertyBags energyConsumers()

energySources

PropertyBags energySources()

shuntCompensators

PropertyBags shuntCompensators()

equivalentShunts

PropertyBags equivalentShunts()

nonlinearShuntCompensatorPoints

PropertyBags nonlinearShuntCompensatorPoints(String id)

staticVarCompensators

PropertyBags staticVarCompensators()

synchronousMachines

@Deprecated(since="6.3.0",
            forRemoval=true)
default PropertyBags synchronousMachines()

Deprecated, for removal: This API element is subject to removal in a future version.

Synchronous machines can be generators or condensers, they are obtained separately. Use synchronousMachinesGenerators() or synchronousMachinesCondensers() instead.

synchronousMachinesGenerators

default PropertyBags synchronousMachinesGenerators()

synchronousMachinesCondensers

default PropertyBags synchronousMachinesCondensers()

equivalentInjections

PropertyBags equivalentInjections()

externalNetworkInjections

PropertyBags externalNetworkInjections()

svInjections

PropertyBags svInjections()

asynchronousMachines

PropertyBags asynchronousMachines()

reactiveCapabilityCurveData

PropertyBags reactiveCapabilityCurveData()

ratioTapChangerTablesPoints

PropertyBags ratioTapChangerTablesPoints()

phaseTapChangerTablesPoints

PropertyBags phaseTapChangerTablesPoints()

ratioTapChangerTable

PropertyBags ratioTapChangerTable(String tableId)

phaseTapChangerTable

PropertyBags phaseTapChangerTable(String tableId)

controlAreas

PropertyBags controlAreas()

acDcConverters

PropertyBags acDcConverters()

dcLineSegments

PropertyBags dcLineSegments()

dcTerminals

PropertyBags dcTerminals()

tieFlows

default PropertyBags tieFlows()

topologicalIslands

default PropertyBags topologicalIslands()

graph

default PropertyBags graph()

grounds

default PropertyBags grounds()

dcTerminal

CgmesDcTerminal dcTerminal(String dcTerminalId)

clear

void clear(CgmesSubset subset)

add

void add(CgmesSubset subset,
 String type,
 PropertyBags objects)

add

default void add(String context,
 String type,
 PropertyBags objects)

print

void print(PrintStream out)

print

void print(Consumer<String> liner)

baseName

static String baseName(ReadOnlyDataSource ds)

setBasename

void setBasename(String baseName)

getBasename

String getBasename()

write

void write(DataSource ds)

write

default void write(DataSource ds,
 CgmesSubset subset)

read

void read(ReadOnlyDataSource ds,
 ReportNode reportNode)

read

void read(ReadOnlyDataSource mainDataSource,
 ReadOnlyDataSource alternativeDataSourceForBoundary,
 ReportNode reportNode)

read

void read(InputStream is,
 String baseName,
 String contextName,
 ReportNode reportNode)

ratioTapChangerListForPowerTransformer

List<String> ratioTapChangerListForPowerTransformer(String powerTransformerId)

phaseTapChangerListForPowerTransformer

List<String> phaseTapChangerListForPowerTransformer(String powerTransformerId)

substation

String substation(CgmesTerminal t,
 boolean nodeBreaker)

Obtain the substation of a given terminal.

Parameters:

t - the terminal

nodeBreaker - to determine the terminal container, use node-breaker connectivity information first

voltageLevel

String voltageLevel(CgmesTerminal t,
 boolean nodeBreaker)

Obtain the voltage level grouping in which a given terminal is contained.

Parameters:

t - the terminal

nodeBreaker - to determine the terminal container, use node-breaker connectivity information first

container

CgmesContainer container(String containerId)

nominalVoltage

double nominalVoltage(String baseVoltageId)

modelProfiles

default PropertyBags modelProfiles()