public interface Network extends Container<Network>
To create a new network, use NetworkFactory
.
The network is initially created with one variant identified by
VariantManagerConstants.INITIAL_VARIANT_ID
. VariantManager
is
responsible for variant management and is accessible from the network thanks
to getVariantManager()
.
Instances of Network
are not thread safe except for attributes
depending of the variant (always specified in the javadoc) if
StateManager.allowStateMultiThreadAccess(boolean)
is set to true.
NetworkFactory
,
VariantManager
Modifier and Type | Interface and Description |
---|---|
static interface |
Network.BusBreakerView
A global bus/breaker view of the network.
|
static interface |
Network.BusView
A global bus view of the network.
|
Modifier and Type | Method and Description |
---|---|
void |
addListener(NetworkListener listener) |
Branch |
getBranch(java.lang.String branchId)
Get a branch
|
int |
getBranchCount()
Get the branch count.
|
java.lang.Iterable<Branch> |
getBranches()
Get all branches
|
java.util.stream.Stream<Branch> |
getBranchStream()
Get all branches
|
BusbarSection |
getBusbarSection(java.lang.String id)
Get a busbar section from its id.
|
int |
getBusbarSectionCount()
Get the busbar section count.
|
java.lang.Iterable<BusbarSection> |
getBusbarSections()
Get all busbar sections.
|
java.util.stream.Stream<BusbarSection> |
getBusbarSectionStream()
Get all busbar sections.
|
Network.BusBreakerView |
getBusBreakerView()
Get a bus/breaker view of the network.
|
Network.BusView |
getBusView()
Get a bus view of the network.
|
org.joda.time.DateTime |
getCaseDate()
Get the date that the network represents.
|
java.util.Set<Country> |
getCountries()
Get all countries.
|
int |
getCountryCount()
Get the country count.
|
DanglingLine |
getDanglingLine(java.lang.String id)
Get a dangling line.
|
int |
getDanglingLineCount()
Get the dangling line count.
|
java.lang.Iterable<DanglingLine> |
getDanglingLines()
Get all dangling lines.
|
java.util.stream.Stream<DanglingLine> |
getDanglingLineStream()
Get all dangling lines.
|
int |
getForecastDistance()
Get the forecast distance in minutes.
|
Generator |
getGenerator(java.lang.String id)
Get a generator.
|
int |
getGeneratorCount()
Get the generator count.
|
java.lang.Iterable<Generator> |
getGenerators()
Get all generators.
|
java.util.stream.Stream<Generator> |
getGeneratorStream()
Get all generators.
|
HvdcConverterStation<?> |
getHvdcConverterStation(java.lang.String id)
Get an HVDC converter station.
|
int |
getHvdcConverterStationCount()
Get HVDC converter stations count.
|
java.lang.Iterable<HvdcConverterStation<?>> |
getHvdcConverterStations()
Get all HVDC converter stations.
|
java.util.stream.Stream<HvdcConverterStation<?>> |
getHvdcConverterStationStream()
Get all HVDC converter stations.
|
HvdcLine |
getHvdcLine(java.lang.String id)
Get an HVDC line.
|
int |
getHvdcLineCount()
Get HVDC lines count.
|
java.lang.Iterable<HvdcLine> |
getHvdcLines()
Get all HVDC lines.
|
java.util.stream.Stream<HvdcLine> |
getHvdcLineStream()
Get all HVDC lines.
|
Identifiable<?> |
getIdentifiable(java.lang.String id)
Get a equipment.
|
java.util.Collection<Identifiable<?>> |
getIdentifiables()
Get all identifiables of the network.
|
LccConverterStation |
getLccConverterStation(java.lang.String id)
Get an LCC converter station.
|
int |
getLccConverterStationCount()
Get LCC converter stations count.
|
java.lang.Iterable<LccConverterStation> |
getLccConverterStations()
Get all LCC converter stations.
|
java.util.stream.Stream<LccConverterStation> |
getLccConverterStationStream()
Get all LCC converter stations.
|
Line |
getLine(java.lang.String id)
Get a AC line.
|
int |
getLineCount()
Get the AC line count.
|
java.lang.Iterable<Line> |
getLines()
Get all AC lines.
|
java.util.stream.Stream<Line> |
getLineStream()
Get all AC lines.
|
Load |
getLoad(java.lang.String id)
Get a load.
|
int |
getLoadCount()
Get the load count.
|
java.lang.Iterable<Load> |
getLoads()
Get all loads.
|
java.util.stream.Stream<Load> |
getLoadStream()
Get all loads.
|
default ShuntCompensator |
getShunt(java.lang.String id)
Deprecated.
Use
getShuntCompensator(String) instead. |
default ShuntCompensator |
getShuntCompensator(java.lang.String id)
Get a compensator shunt.
|
default int |
getShuntCompensatorCount()
Get the shunt count.
|
default java.lang.Iterable<ShuntCompensator> |
getShuntCompensators()
Get all compensator shunts.
|
default java.util.stream.Stream<ShuntCompensator> |
getShuntCompensatorStream()
Get all compensator shunts.
|
default int |
getShuntCount()
Deprecated.
Use
getShuntCompensatorCount() instead. |
default java.lang.Iterable<ShuntCompensator> |
getShunts()
Deprecated.
Use
#getShuntCompensators) instead. |
default java.util.stream.Stream<ShuntCompensator> |
getShuntStream()
Deprecated.
Use
getShuntCompensatorStream() instead. |
java.lang.String |
getSourceFormat()
Get the source format.
|
default StateManager |
getStateManager()
Deprecated.
Use
getVariantManager() instead. |
StaticVarCompensator |
getStaticVarCompensator(java.lang.String id)
Get a static var compensator.
|
int |
getStaticVarCompensatorCount()
Get the static var compensator count.
|
java.lang.Iterable<StaticVarCompensator> |
getStaticVarCompensators()
Get all static var compensators.
|
java.util.stream.Stream<StaticVarCompensator> |
getStaticVarCompensatorStream()
Get all static var compensators.
|
Substation |
getSubstation(java.lang.String id)
Get a substation.
|
int |
getSubstationCount()
Get the substation count.
|
java.lang.Iterable<Substation> |
getSubstations()
Get all substations.
|
java.lang.Iterable<Substation> |
getSubstations(Country country,
java.lang.String tsoId,
java.lang.String... geographicalTags)
Get substation located in a specific county, TSO and marked with a list
of geographical tag.
|
java.util.stream.Stream<Substation> |
getSubstationStream()
Get all substations.
|
Switch |
getSwitch(java.lang.String id)
Get a switch from its id.
|
int |
getSwitchCount()
Get the switch count.
|
java.lang.Iterable<Switch> |
getSwitches()
Get all switches.
|
java.util.stream.Stream<Switch> |
getSwitchStream()
Get all switches.
|
ThreeWindingsTransformer |
getThreeWindingsTransformer(java.lang.String id)
Get a 3 windings transformer.
|
int |
getThreeWindingsTransformerCount()
Get the 3 windings transformer count.
|
java.lang.Iterable<ThreeWindingsTransformer> |
getThreeWindingsTransformers()
Get all 3 windings transformers.
|
java.util.stream.Stream<ThreeWindingsTransformer> |
getThreeWindingsTransformerStream()
Get all 3 windings transformers.
|
TwoWindingsTransformer |
getTwoWindingsTransformer(java.lang.String id)
Get a two windings transformer.
|
int |
getTwoWindingsTransformerCount()
Get the two windings transformer count.
|
java.lang.Iterable<TwoWindingsTransformer> |
getTwoWindingsTransformers()
Get all two windings transformers.
|
java.util.stream.Stream<TwoWindingsTransformer> |
getTwoWindingsTransformerStream()
Get all two windings transformers.
|
default VariantManager |
getVariantManager()
Get the variant manager of the network.
|
VoltageLevel |
getVoltageLevel(java.lang.String id)
Get a substation voltage level.
|
int |
getVoltageLevelCount()
Get the voltage level count.
|
java.lang.Iterable<VoltageLevel> |
getVoltageLevels()
Get all substation voltage levels.
|
java.util.stream.Stream<VoltageLevel> |
getVoltageLevelStream()
Get all substation voltage levels.
|
VscConverterStation |
getVscConverterStation(java.lang.String id)
Get an VSC converter station.
|
int |
getVscConverterStationCount()
Get VSC converter stations count.
|
java.lang.Iterable<VscConverterStation> |
getVscConverterStations()
Get all VSC converter stations.
|
java.util.stream.Stream<VscConverterStation> |
getVscConverterStationStream()
Get all VSC converter stations.
|
void |
merge(Network... others) |
void |
merge(Network other)
Merge with an other network.
|
HvdcLineAdder |
newHvdcLine()
Get a builder to create a new HVDC line.
|
LineAdder |
newLine()
Get a builder to create a new AC line.
|
SubstationAdder |
newSubstation()
Get a builder to create a new substation.
|
TieLineAdder |
newTieLine()
Get a builder to create a new AC tie line.
|
void |
removeListener(NetworkListener listener) |
Network |
setCaseDate(org.joda.time.DateTime date)
Set the date that the network represents.
|
Network |
setForecastDistance(int forecastDistance) |
getContainerType
getId, getName, getProperties, hasProperty
addExtension, getExtension, getExtensionByName, getExtensions, removeExtension
org.joda.time.DateTime getCaseDate()
Network setCaseDate(org.joda.time.DateTime date)
java.lang.IllegalArgumentException
- if date is null.int getForecastDistance()
Example: 0 for a snapshot, 6*60 to 30*60 for a DACF.
Network setForecastDistance(int forecastDistance)
java.lang.String getSourceFormat()
default VariantManager getVariantManager()
@Deprecated default StateManager getStateManager()
getVariantManager()
instead.java.util.Set<Country> getCountries()
int getCountryCount()
SubstationAdder newSubstation()
java.lang.Iterable<Substation> getSubstations()
java.util.stream.Stream<Substation> getSubstationStream()
int getSubstationCount()
java.lang.Iterable<Substation> getSubstations(Country country, java.lang.String tsoId, java.lang.String... geographicalTags)
country
- the country, if null
there is no
filtering on countriestsoId
- the id of the TSO, if null
there is no
filtering on TSOsgeographicalTags
- a list a geographical tagsSubstation getSubstation(java.lang.String id)
id
- the id of the substationjava.lang.Iterable<VoltageLevel> getVoltageLevels()
java.util.stream.Stream<VoltageLevel> getVoltageLevelStream()
int getVoltageLevelCount()
VoltageLevel getVoltageLevel(java.lang.String id)
id
- the id of the substation voltage levelLineAdder newLine()
java.lang.Iterable<Line> getLines()
Branch getBranch(java.lang.String branchId)
branchId
- the id of the branchjava.lang.Iterable<Branch> getBranches()
java.util.stream.Stream<Branch> getBranchStream()
int getBranchCount()
java.util.stream.Stream<Line> getLineStream()
int getLineCount()
Line getLine(java.lang.String id)
id
- the name of the AC lineTieLineAdder newTieLine()
java.lang.Iterable<TwoWindingsTransformer> getTwoWindingsTransformers()
java.util.stream.Stream<TwoWindingsTransformer> getTwoWindingsTransformerStream()
int getTwoWindingsTransformerCount()
TwoWindingsTransformer getTwoWindingsTransformer(java.lang.String id)
id
- the id of the two windings transformerjava.lang.Iterable<ThreeWindingsTransformer> getThreeWindingsTransformers()
java.util.stream.Stream<ThreeWindingsTransformer> getThreeWindingsTransformerStream()
int getThreeWindingsTransformerCount()
ThreeWindingsTransformer getThreeWindingsTransformer(java.lang.String id)
id
- the id of the 3 windings transformerjava.lang.Iterable<Generator> getGenerators()
java.util.stream.Stream<Generator> getGeneratorStream()
int getGeneratorCount()
Generator getGenerator(java.lang.String id)
id
- the id od the generatorjava.lang.Iterable<Load> getLoads()
java.util.stream.Stream<Load> getLoadStream()
int getLoadCount()
Load getLoad(java.lang.String id)
id
- the id the load@Deprecated default java.lang.Iterable<ShuntCompensator> getShunts()
#getShuntCompensators)
instead.@Deprecated default java.util.stream.Stream<ShuntCompensator> getShuntStream()
getShuntCompensatorStream()
instead.@Deprecated default int getShuntCount()
getShuntCompensatorCount()
instead.@Deprecated default ShuntCompensator getShunt(java.lang.String id)
getShuntCompensator(String)
instead.default java.lang.Iterable<ShuntCompensator> getShuntCompensators()
default java.util.stream.Stream<ShuntCompensator> getShuntCompensatorStream()
default int getShuntCompensatorCount()
default ShuntCompensator getShuntCompensator(java.lang.String id)
id
- the id of the compensator shuntjava.lang.Iterable<DanglingLine> getDanglingLines()
java.util.stream.Stream<DanglingLine> getDanglingLineStream()
int getDanglingLineCount()
DanglingLine getDanglingLine(java.lang.String id)
id
- the id of the dangling linejava.lang.Iterable<StaticVarCompensator> getStaticVarCompensators()
java.util.stream.Stream<StaticVarCompensator> getStaticVarCompensatorStream()
int getStaticVarCompensatorCount()
StaticVarCompensator getStaticVarCompensator(java.lang.String id)
id
- the id of the static var compensatorSwitch getSwitch(java.lang.String id)
id
- id of the switchjava.lang.Iterable<Switch> getSwitches()
java.util.stream.Stream<Switch> getSwitchStream()
int getSwitchCount()
BusbarSection getBusbarSection(java.lang.String id)
id
- id of the busbar sectionjava.lang.Iterable<BusbarSection> getBusbarSections()
java.util.stream.Stream<BusbarSection> getBusbarSectionStream()
int getBusbarSectionCount()
java.lang.Iterable<HvdcConverterStation<?>> getHvdcConverterStations()
java.util.stream.Stream<HvdcConverterStation<?>> getHvdcConverterStationStream()
int getHvdcConverterStationCount()
HvdcConverterStation<?> getHvdcConverterStation(java.lang.String id)
id
- the id of the HVDC converter stationjava.lang.Iterable<LccConverterStation> getLccConverterStations()
java.util.stream.Stream<LccConverterStation> getLccConverterStationStream()
int getLccConverterStationCount()
LccConverterStation getLccConverterStation(java.lang.String id)
id
- the id of the LCC converter stationjava.lang.Iterable<VscConverterStation> getVscConverterStations()
java.util.stream.Stream<VscConverterStation> getVscConverterStationStream()
int getVscConverterStationCount()
VscConverterStation getVscConverterStation(java.lang.String id)
id
- the id of the VSC converter stationjava.lang.Iterable<HvdcLine> getHvdcLines()
java.util.stream.Stream<HvdcLine> getHvdcLineStream()
int getHvdcLineCount()
HvdcLine getHvdcLine(java.lang.String id)
id
- the id of the HVDC lineHvdcLineAdder newHvdcLine()
Identifiable<?> getIdentifiable(java.lang.String id)
id
- the id of the equipmentjava.util.Collection<Identifiable<?>> getIdentifiables()
Network.BusBreakerView getBusBreakerView()
Network.BusView getBusView()
void merge(Network other)
other
- the other networkvoid merge(Network... others)
void addListener(NetworkListener listener)
void removeListener(NetworkListener listener)