public interface Network extends Container<Network>
Characteristics
Attribute | Type | Unit | Required | Defaut value | Description |
---|---|---|---|---|---|
Id | String | - | yes | - | Unique identifier of the network |
Name | String | - | yes | - | Human-readable name of the network |
CaseDate | DateTime | - | no | Now | The date of the case |
ForecastDistance | integer | - | no | 0 | The number of minutes between the date of the case generation and the date of the case |
Network n = Network.create("test", "test");
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
VariantManager.allowVariantMultiThreadAccess(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.
|
static interface |
Network.PrettyNetworkFactory
Just being able to name method create et not createNetwork.
|
Modifier and Type | Method and Description |
---|---|
void |
addListener(NetworkListener listener) |
static Network |
create(String id,
String sourceFormat)
Create an empty network using default implementation.
|
Iterable<Battery> |
getBatteries()
Get all batteries.
|
Battery |
getBattery(String id)
Get a battery.
|
int |
getBatteryCount()
Get the battery count.
|
Stream<Battery> |
getBatteryStream()
Get all batteries.
|
Branch |
getBranch(String branchId)
Get a branch
|
int |
getBranchCount()
Get the branch count.
|
Iterable<Branch> |
getBranches()
Get all branches
|
Stream<Branch> |
getBranchStream()
Get all branches
|
BusbarSection |
getBusbarSection(String id)
Get a busbar section from its id or an alias.
|
int |
getBusbarSectionCount()
Get the busbar section count.
|
Iterable<BusbarSection> |
getBusbarSections()
Get all busbar sections.
|
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.
|
default int |
getConnectableCount()
Count the connectables of the network
|
default <C extends Connectable> |
getConnectableCount(Class<C> clazz)
Count the connectables of the network for a given type
|
default Iterable<Connectable> |
getConnectables()
Get all connectables of the network
|
default <C extends Connectable> |
getConnectables(Class<C> clazz)
Get all connectables of the network for a given type
|
default Stream<Connectable> |
getConnectableStream()
Get a stream of all connectables of the network
|
default <C extends Connectable> |
getConnectableStream(Class<C> clazz)
Get a stream of all connectables of the network for a given type
|
Set<Country> |
getCountries()
Get all countries.
|
int |
getCountryCount()
Get the country count.
|
DanglingLine |
getDanglingLine(String id)
Get a dangling line.
|
int |
getDanglingLineCount()
Get the dangling line count.
|
Iterable<DanglingLine> |
getDanglingLines()
Get all dangling lines.
|
Stream<DanglingLine> |
getDanglingLineStream()
Get all dangling lines.
|
int |
getForecastDistance()
Get the forecast distance in minutes.
|
Generator |
getGenerator(String id)
Get a generator.
|
int |
getGeneratorCount()
Get the generator count.
|
Iterable<Generator> |
getGenerators()
Get all generators.
|
Stream<Generator> |
getGeneratorStream()
Get all generators.
|
HvdcConverterStation<?> |
getHvdcConverterStation(String id)
Get an HVDC converter station.
|
int |
getHvdcConverterStationCount()
Get HVDC converter stations count.
|
Iterable<HvdcConverterStation<?>> |
getHvdcConverterStations()
Get all HVDC converter stations.
|
Stream<HvdcConverterStation<?>> |
getHvdcConverterStationStream()
Get all HVDC converter stations.
|
default HvdcLine |
getHvdcLine(HvdcConverterStation converterStation)
Get an HVDC line from a converter station
|
HvdcLine |
getHvdcLine(String id)
Get an HVDC line.
|
int |
getHvdcLineCount()
Get HVDC lines count.
|
Iterable<HvdcLine> |
getHvdcLines()
Get all HVDC lines.
|
Stream<HvdcLine> |
getHvdcLineStream()
Get all HVDC lines.
|
Identifiable<?> |
getIdentifiable(String id)
Get an equipment by its ID or alias
|
Collection<Identifiable<?>> |
getIdentifiables()
Get all identifiables of the network.
|
LccConverterStation |
getLccConverterStation(String id)
Get an LCC converter station.
|
int |
getLccConverterStationCount()
Get LCC converter stations count.
|
Iterable<LccConverterStation> |
getLccConverterStations()
Get all LCC converter stations.
|
Stream<LccConverterStation> |
getLccConverterStationStream()
Get all LCC converter stations.
|
Line |
getLine(String id)
Get a AC line.
|
int |
getLineCount()
Get the AC line count.
|
Iterable<Line> |
getLines()
Get all AC lines.
|
Stream<Line> |
getLineStream()
Get all AC lines.
|
Load |
getLoad(String id)
Get a load.
|
int |
getLoadCount()
Get the load count.
|
Iterable<Load> |
getLoads()
Get all loads.
|
Stream<Load> |
getLoadStream()
Get all loads.
|
ShuntCompensator |
getShuntCompensator(String id)
Get a compensator shunt.
|
int |
getShuntCompensatorCount()
Get the shunt count.
|
Iterable<ShuntCompensator> |
getShuntCompensators()
Get all compensator shunts.
|
Stream<ShuntCompensator> |
getShuntCompensatorStream()
Get all compensator shunts.
|
String |
getSourceFormat()
Get the source format.
|
StaticVarCompensator |
getStaticVarCompensator(String id)
Get a static var compensator.
|
int |
getStaticVarCompensatorCount()
Get the static var compensator count.
|
Iterable<StaticVarCompensator> |
getStaticVarCompensators()
Get all static var compensators.
|
Stream<StaticVarCompensator> |
getStaticVarCompensatorStream()
Get all static var compensators.
|
Substation |
getSubstation(String id)
Get a substation.
|
int |
getSubstationCount()
Get the substation count.
|
Iterable<Substation> |
getSubstations()
Get all substations.
|
Iterable<Substation> |
getSubstations(Country country,
String tsoId,
String... geographicalTags)
Get substation located in a specific county, TSO and marked with a list
of geographical tag.
|
Iterable<Substation> |
getSubstations(String country,
String tsoId,
String... geographicalTags)
Get substation located in a specific county, TSO and marked with a list
of geographical tag.
|
Stream<Substation> |
getSubstationStream()
Get all substations.
|
Switch |
getSwitch(String id)
Get a switch from its id or an alias.
|
int |
getSwitchCount()
Get the switch count.
|
Iterable<Switch> |
getSwitches()
Get all switches.
|
Stream<Switch> |
getSwitchStream()
Get all switches.
|
ThreeWindingsTransformer |
getThreeWindingsTransformer(String id)
Get a 3 windings transformer.
|
int |
getThreeWindingsTransformerCount()
Get the 3 windings transformer count.
|
Iterable<ThreeWindingsTransformer> |
getThreeWindingsTransformers()
Get all 3 windings transformers.
|
Stream<ThreeWindingsTransformer> |
getThreeWindingsTransformerStream()
Get all 3 windings transformers.
|
TwoWindingsTransformer |
getTwoWindingsTransformer(String id)
Get a two windings transformer.
|
int |
getTwoWindingsTransformerCount()
Get the two windings transformer count.
|
Iterable<TwoWindingsTransformer> |
getTwoWindingsTransformers()
Get all two windings transformers.
|
Stream<TwoWindingsTransformer> |
getTwoWindingsTransformerStream()
Get all two windings transformers.
|
VariantManager |
getVariantManager()
Get the variant manager of the network.
|
VoltageLevel |
getVoltageLevel(String id)
Get a substation voltage level.
|
int |
getVoltageLevelCount()
Get the voltage level count.
|
Iterable<VoltageLevel> |
getVoltageLevels()
Get all substation voltage levels.
|
Stream<VoltageLevel> |
getVoltageLevelStream()
Get all substation voltage levels.
|
VscConverterStation |
getVscConverterStation(String id)
Get an VSC converter station.
|
int |
getVscConverterStationCount()
Get VSC converter stations count.
|
Iterable<VscConverterStation> |
getVscConverterStations()
Get all VSC converter stations.
|
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) |
static Network.PrettyNetworkFactory |
with(String name)
Get network factory named
name . |
getContainerType
addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, setFictitious, setProperty
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
static Network create(String id, String sourceFormat)
id
- id of the networksourceFormat
- source formatstatic Network.PrettyNetworkFactory with(String name)
name
.name
- name of the NetworkFactory
org.joda.time.DateTime getCaseDate()
Network setCaseDate(org.joda.time.DateTime date)
IllegalArgumentException
- if date is null.int getForecastDistance()
Example: 0 for a snapshot, 6*60 to 30*60 for a DACF.
Network setForecastDistance(int forecastDistance)
String getSourceFormat()
VariantManager getVariantManager()
int getCountryCount()
SubstationAdder newSubstation()
Iterable<Substation> getSubstations()
Stream<Substation> getSubstationStream()
int getSubstationCount()
Iterable<Substation> getSubstations(Country country, String tsoId, 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 tagsIterable<Substation> getSubstations(String country, String tsoId, String... geographicalTags)
country
- the country name, if empty string, the filtering will be on
substations without 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(String id)
id
- the id or an alias of the substationIterable<VoltageLevel> getVoltageLevels()
Stream<VoltageLevel> getVoltageLevelStream()
int getVoltageLevelCount()
VoltageLevel getVoltageLevel(String id)
id
- the id or an alias of the substation voltage levelLineAdder newLine()
Branch getBranch(String branchId)
branchId
- the id of the branchint getBranchCount()
int getLineCount()
TieLineAdder newTieLine()
Iterable<TwoWindingsTransformer> getTwoWindingsTransformers()
Stream<TwoWindingsTransformer> getTwoWindingsTransformerStream()
int getTwoWindingsTransformerCount()
TwoWindingsTransformer getTwoWindingsTransformer(String id)
id
- the id or an alias of the two windings transformerIterable<ThreeWindingsTransformer> getThreeWindingsTransformers()
Stream<ThreeWindingsTransformer> getThreeWindingsTransformerStream()
int getThreeWindingsTransformerCount()
ThreeWindingsTransformer getThreeWindingsTransformer(String id)
id
- the id or an alias of the 3 windings transformerint getGeneratorCount()
Generator getGenerator(String id)
id
- the id or an alias of the generatorint getBatteryCount()
Battery getBattery(String id)
id
- the id or an alias of the batteryint getLoadCount()
Iterable<ShuntCompensator> getShuntCompensators()
Stream<ShuntCompensator> getShuntCompensatorStream()
int getShuntCompensatorCount()
ShuntCompensator getShuntCompensator(String id)
id
- the id or an alias of the compensator shuntIterable<DanglingLine> getDanglingLines()
Stream<DanglingLine> getDanglingLineStream()
int getDanglingLineCount()
DanglingLine getDanglingLine(String id)
id
- the id or an alias of the dangling lineIterable<StaticVarCompensator> getStaticVarCompensators()
Stream<StaticVarCompensator> getStaticVarCompensatorStream()
int getStaticVarCompensatorCount()
StaticVarCompensator getStaticVarCompensator(String id)
id
- the id or an alias of the static var compensatorSwitch getSwitch(String id)
id
- id or an alias of the switchint getSwitchCount()
BusbarSection getBusbarSection(String id)
id
- the id or an alias of the busbar sectionIterable<BusbarSection> getBusbarSections()
Stream<BusbarSection> getBusbarSectionStream()
int getBusbarSectionCount()
Iterable<HvdcConverterStation<?>> getHvdcConverterStations()
Stream<HvdcConverterStation<?>> getHvdcConverterStationStream()
int getHvdcConverterStationCount()
HvdcConverterStation<?> getHvdcConverterStation(String id)
id
- the id or an alias of the HVDC converter stationIterable<LccConverterStation> getLccConverterStations()
Stream<LccConverterStation> getLccConverterStationStream()
int getLccConverterStationCount()
LccConverterStation getLccConverterStation(String id)
id
- the id or an alias of the LCC converter stationIterable<VscConverterStation> getVscConverterStations()
Stream<VscConverterStation> getVscConverterStationStream()
int getVscConverterStationCount()
VscConverterStation getVscConverterStation(String id)
id
- the id or an alias of the VSC converter stationint getHvdcLineCount()
HvdcLine getHvdcLine(String id)
id
- the id or an alias of the HVDC linedefault HvdcLine getHvdcLine(HvdcConverterStation converterStation)
converterStation
- a HVDC converter stationHvdcLineAdder newHvdcLine()
Identifiable<?> getIdentifiable(String id)
id
- the id or an alias of the equipmentCollection<Identifiable<?>> getIdentifiables()
default <C extends Connectable> Iterable<C> getConnectables(Class<C> clazz)
clazz
- connectable type classdefault <C extends Connectable> Stream<C> getConnectableStream(Class<C> clazz)
clazz
- connectable type classdefault <C extends Connectable> int getConnectableCount(Class<C> clazz)
clazz
- connectable type classdefault Iterable<Connectable> getConnectables()
default Stream<Connectable> getConnectableStream()
default int getConnectableCount()
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)
Copyright © 2020. All rights reserved.