CgmesModel (powsybl 3.5.0 API)

All Known Implementing Classes:

AbstractCgmesModel, CgmesModelTripleStore
```
public interface CgmesModel
```
Author:

Luma Zamarreño

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and 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)`
`PropertyBags`	`connectivityNodeContainers()`
`PropertyBags`	`connectivityNodes()`
`CgmesContainer`	`container(String containerId)`
`org.joda.time.DateTime`	`created()`
`PropertyBags`	`dcLineSegments()`
`CgmesDcTerminal`	`dcTerminal(String dcTerminalId)`
`PropertyBags`	`dcTerminals()`
`PropertyBags`	`dcTerminalsTP()`
`PropertyBags`	`energyConsumers()`
`PropertyBags`	`energySources()`
`PropertyBags`	`equivalentBranches()`
`PropertyBags`	`equivalentInjections()`
`PropertyBags`	`equivalentShunts()`
`PropertyBags`	`externalNetworkInjections()`
`default PropertyBags`	`fullModel(String cgmesProfile)`
`String`	`getBasename()`
`Properties`	`getProperties()`
`default PropertyBags`	`graph()`
`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()`
`String`	`phaseTapChangerForPowerTransformer(String powerTransformerId)`
`PropertyBags`	`phaseTapChangers()`
`PropertyBags`	`phaseTapChangerTable(String tableId)`
`PropertyBags`	`phaseTapChangerTablesPoints()`
`void`	`print(Consumer<String> liner)`
`void`	`print(PrintStream out)`
`String`	`ratioTapChangerForPowerTransformer(String powerTransformerId)`
`PropertyBags`	`ratioTapChangers()`
`PropertyBags`	`ratioTapChangerTable(String tableId)`
`PropertyBags`	`ratioTapChangerTablesPoints()`
`PropertyBags`	`reactiveCapabilityCurveData()`
`void`	`read(InputStream is, String baseName, String contextName)`
`void`	`read(ReadOnlyDataSource ds)`
`void`	`read(ReadOnlyDataSource mainDataSource, ReadOnlyDataSource alternativeDataSourceForBoundary)`
`PropertyBags`	`regulatingControls()`
`org.joda.time.DateTime`	`scenarioTime()`
`PropertyBags`	`seriesCompensators()`
`void`	`setBasename(String baseName)`
`PropertyBags`	`shuntCompensators()`
`PropertyBags`	`staticVarCompensators()`
`String`	`substation(CgmesTerminal t, boolean nodeBreaker)` Obtain the substation of a given terminal.
`PropertyBags`	`substations()`
`PropertyBags`	`svInjections()`
`PropertyBags`	`switches()`
`PropertyBags`	`synchronousMachines()`
`CgmesTerminal`	`terminal(String terminalId)`
`String`	`terminalForEquipment(String conductingEquipmentId, int sequenceNumber)`
`PropertyBags`	`terminals()`
`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 Detail

tripleStore
```
TripleStore tripleStore()
```

getProperties
```
Properties getProperties()
```

fullModel

default PropertyBags fullModel(String cgmesProfile)

hasEquipmentCore
```
boolean hasEquipmentCore()
```

modelId
```
String modelId()
```

version
```
String version()
```

scenarioTime
```
org.joda.time.DateTime scenarioTime()
```

created
```
org.joda.time.DateTime created()
```

isNodeBreaker
```
boolean isNodeBreaker()
```

hasBoundary
```
boolean hasBoundary()
```

terminal

CgmesTerminal terminal(String terminalId)

numObjectsByType
```
PropertyBags numObjectsByType()
```

allObjectsOfType

PropertyBags allObjectsOfType(String type)

boundaryNodes
```
PropertyBags boundaryNodes()
```

baseVoltages
```
PropertyBags baseVoltages()
```

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
```
PropertyBags synchronousMachines()
```

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)

acDcConverters
```
PropertyBags acDcConverters()
```

dcLineSegments
```
PropertyBags dcLineSegments()
```

dcTerminals
```
PropertyBags dcTerminals()
```

dcTerminalsTP
```
PropertyBags dcTerminalsTP()
```

topologicalIslands

default PropertyBags topologicalIslands()

graph
```
default PropertyBags graph()
```

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)
```

read

void read(ReadOnlyDataSource mainDataSource,
          ReadOnlyDataSource alternativeDataSourceForBoundary)

read

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

terminalForEquipment

String terminalForEquipment(String conductingEquipmentId,
                            int sequenceNumber)

ratioTapChangerForPowerTransformer

String ratioTapChangerForPowerTransformer(String powerTransformerId)

phaseTapChangerForPowerTransformer

String phaseTapChangerForPowerTransformer(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()
```

Interface CgmesModel

Method Summary

Method Detail

tripleStore

getProperties

fullModel

hasEquipmentCore

modelId

version

scenarioTime

created

isNodeBreaker

hasBoundary

terminal

numObjectsByType

allObjectsOfType

boundaryNodes

baseVoltages

substations

voltageLevels

terminals

connectivityNodeContainers

operationalLimits

connectivityNodes

topologicalNodes

busBarSections

switches

acLineSegments

equivalentBranches

seriesCompensators

transformers

transformerEnds

groupedTransformerEnds

ratioTapChangers

phaseTapChangers

regulatingControls

energyConsumers

energySources

shuntCompensators

equivalentShunts

nonlinearShuntCompensatorPoints

staticVarCompensators

synchronousMachines

equivalentInjections

externalNetworkInjections

svInjections

asynchronousMachines

reactiveCapabilityCurveData

ratioTapChangerTablesPoints

phaseTapChangerTablesPoints

ratioTapChangerTable

phaseTapChangerTable

acDcConverters

dcLineSegments

dcTerminals

dcTerminalsTP

topologicalIslands

graph

dcTerminal

clear

add

add

print

print

baseName

setBasename

getBasename

write

write

read

read

read

terminalForEquipment

ratioTapChangerForPowerTransformer

phaseTapChangerForPowerTransformer

substation

voltageLevel

container

nominalVoltage

modelProfiles