Package com.powsybl.iidm.network
Interface Bus
-
- All Superinterfaces:
Extendable<Bus>
,Identifiable<Bus>
public interface Bus extends Identifiable<Bus>
A bus is a set of equipments connected together through a closed switch. It could be a configured object ot a result of a computation depending of the context.- Author:
- Geoffroy Jamgotchian
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description double
getAngle()
Get the voltage angle of the bus in degree.Iterable<Battery>
getBatteries()
Get batteries connected to the bus.Stream<Battery>
getBatteryStream()
Get batteries connected to the bus.Component
getConnectedComponent()
Get the connected component that the bus is part of.int
getConnectedTerminalCount()
Get the number of terminals connected to this bus.default Iterable<? extends Terminal>
getConnectedTerminals()
Get an iterable of the terminals connected to the bus.default Stream<? extends Terminal>
getConnectedTerminalStream()
Get a stream of the terminals connected to the bus.default Iterable<DanglingLine>
getDanglingLines()
Get all dangling lines connected to the bus.Iterable<DanglingLine>
getDanglingLines(DanglingLineFilter danglingLineFilter)
Get dangling lines connected to the bus based on given filter.default Stream<DanglingLine>
getDanglingLineStream()
Get all dangling lines connected to the bus.Stream<DanglingLine>
getDanglingLineStream(DanglingLineFilter danglingLineFilter)
Get dangling lines connected to the bus based on given filter.default double
getFictitiousP0()
default double
getFictitiousQ0()
Iterable<Generator>
getGenerators()
Get generators connected to the bus.Stream<Generator>
getGeneratorStream()
Get generators connected to the bus.Iterable<LccConverterStation>
getLccConverterStations()
Get LCC converter stations connected to the bus.Stream<LccConverterStation>
getLccConverterStationStream()
Get LCC converter stations connected to the bus.Iterable<Line>
getLines()
Get the AC lines connected to the bus.Stream<Line>
getLineStream()
Get the AC lines connected to the bus.Iterable<Load>
getLoads()
Get loads connected to the bus.Stream<Load>
getLoadStream()
Get loads connected to the bus.double
getP()
Get the active power in MW injected by equipments connected to the bus.double
getQ()
Get the reactive power in MVAR injected by equiments connected to the bus.Iterable<ShuntCompensator>
getShuntCompensators()
Get shunt compensators connected to the bus.Stream<ShuntCompensator>
getShuntCompensatorStream()
Get shunt compensators connected to the bus.Iterable<StaticVarCompensator>
getStaticVarCompensators()
Get static VAR compensators connected to the bus.Stream<StaticVarCompensator>
getStaticVarCompensatorStream()
Get static VAR compensators connected to the bus.Component
getSynchronousComponent()
Get the synchronous component that the bus is part of.Iterable<ThreeWindingsTransformer>
getThreeWindingsTransformers()
Get 3 windings transformers connected to the bus.Stream<ThreeWindingsTransformer>
getThreeWindingsTransformerStream()
Get 3 windings transformers connected to the bus.default Iterable<ThreeWindingsTransformer>
getThreeWindingTransformers()
Deprecated.UsegetThreeWindingsTransformers()
instead.default Stream<ThreeWindingsTransformer>
getThreeWindingTransformerStream()
Deprecated.UsegetThreeWindingsTransformerStream()
instead.Iterable<TwoWindingsTransformer>
getTwoWindingsTransformers()
Get 2 windings transformer connected to the bus.Stream<TwoWindingsTransformer>
getTwoWindingsTransformerStream()
Get 2 windings transformer connected to the bus.default Iterable<TwoWindingsTransformer>
getTwoWindingTransformers()
Deprecated.UsegetTwoWindingsTransformers()
instead.default Stream<TwoWindingsTransformer>
getTwoWindingTransformerStream()
Deprecated.UsegetTwoWindingsTransformerStream()
instead.default IdentifiableType
getType()
Get identifiable type.double
getV()
Get the voltage magnitude of the bus in kV.VoltageLevel
getVoltageLevel()
Get the voltage level to which the bus belongs.Iterable<VscConverterStation>
getVscConverterStations()
Get VSC converter stations connected to the bus.Stream<VscConverterStation>
getVscConverterStationStream()
Get VSC converter stations connected to the bus.boolean
isInMainConnectedComponent()
Check if the bus belongs to the main connected componentboolean
isInMainSynchronousComponent()
Check if the bus belongs to the main synchronous componentBus
setAngle(double angle)
Set the voltage angle of the bus in degree.default Bus
setFictitiousP0(double p0)
default Bus
setFictitiousQ0(double q0)
Bus
setV(double v)
Set the voltage magnituge of the bus in kV.void
visitConnectedEquipments(TopologyVisitor visitor)
Visit equipments connected to the bus.void
visitConnectedOrConnectableEquipments(TopologyVisitor visitor)
Visit equipments connected or connectable to the bus.-
Methods inherited from interface com.powsybl.commons.extensions.Extendable
addExtension, getExtension, getExtensionByName, getExtensions, getImplementationName, newExtension, removeExtension
-
Methods inherited from interface com.powsybl.iidm.network.Identifiable
addAlias, addAlias, addAlias, addAlias, getAliases, getAliasFromType, getAliasType, getId, getName, getNameOrId, getNetwork, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, removeProperty, setFictitious, setName, setProperty
-
-
-
-
Method Detail
-
getVoltageLevel
VoltageLevel getVoltageLevel()
Get the voltage level to which the bus belongs.
-
getV
double getV()
Get the voltage magnitude of the bus in kV.
-
setV
Bus setV(double v)
Set the voltage magnituge of the bus in kV.
-
getAngle
double getAngle()
Get the voltage angle of the bus in degree.
-
setAngle
Bus setAngle(double angle)
Set the voltage angle of the bus in degree.
-
getP
double getP()
Get the active power in MW injected by equipments connected to the bus.
-
getQ
double getQ()
Get the reactive power in MVAR injected by equiments connected to the bus.
-
getFictitiousP0
default double getFictitiousP0()
-
setFictitiousP0
default Bus setFictitiousP0(double p0)
-
getFictitiousQ0
default double getFictitiousQ0()
-
setFictitiousQ0
default Bus setFictitiousQ0(double q0)
-
getConnectedComponent
Component getConnectedComponent()
Get the connected component that the bus is part of.
-
isInMainConnectedComponent
boolean isInMainConnectedComponent()
Check if the bus belongs to the main connected component- Returns:
- true if the bus belongs to the main connected component, false otherwise
-
getSynchronousComponent
Component getSynchronousComponent()
Get the synchronous component that the bus is part of.
-
isInMainSynchronousComponent
boolean isInMainSynchronousComponent()
Check if the bus belongs to the main synchronous component- Returns:
- true if the bus belongs to the main synchronous component, false otherwise
-
getConnectedTerminalCount
int getConnectedTerminalCount()
Get the number of terminals connected to this bus.
-
getTwoWindingsTransformers
Iterable<TwoWindingsTransformer> getTwoWindingsTransformers()
Get 2 windings transformer connected to the bus.
-
getTwoWindingTransformers
@Deprecated default Iterable<TwoWindingsTransformer> getTwoWindingTransformers()
Deprecated.UsegetTwoWindingsTransformers()
instead.Get 2 windings transformer connected to the bus.
-
getTwoWindingsTransformerStream
Stream<TwoWindingsTransformer> getTwoWindingsTransformerStream()
Get 2 windings transformer connected to the bus.
-
getTwoWindingTransformerStream
@Deprecated default Stream<TwoWindingsTransformer> getTwoWindingTransformerStream()
Deprecated.UsegetTwoWindingsTransformerStream()
instead.Get 2 windings transformer connected to the bus.
-
getThreeWindingsTransformers
Iterable<ThreeWindingsTransformer> getThreeWindingsTransformers()
Get 3 windings transformers connected to the bus.
-
getThreeWindingTransformers
@Deprecated default Iterable<ThreeWindingsTransformer> getThreeWindingTransformers()
Deprecated.UsegetThreeWindingsTransformers()
instead.Get 3 windings transformers connected to the bus.
-
getThreeWindingsTransformerStream
Stream<ThreeWindingsTransformer> getThreeWindingsTransformerStream()
Get 3 windings transformers connected to the bus.
-
getThreeWindingTransformerStream
@Deprecated default Stream<ThreeWindingsTransformer> getThreeWindingTransformerStream()
Deprecated.UsegetThreeWindingsTransformerStream()
instead.Get 3 windings transformers connected to the bus.
-
getShuntCompensators
Iterable<ShuntCompensator> getShuntCompensators()
Get shunt compensators connected to the bus.
-
getShuntCompensatorStream
Stream<ShuntCompensator> getShuntCompensatorStream()
Get shunt compensators connected to the bus.
-
getDanglingLines
Iterable<DanglingLine> getDanglingLines(DanglingLineFilter danglingLineFilter)
Get dangling lines connected to the bus based on given filter.
-
getDanglingLines
default Iterable<DanglingLine> getDanglingLines()
Get all dangling lines connected to the bus.
-
getDanglingLineStream
Stream<DanglingLine> getDanglingLineStream(DanglingLineFilter danglingLineFilter)
Get dangling lines connected to the bus based on given filter.
-
getDanglingLineStream
default Stream<DanglingLine> getDanglingLineStream()
Get all dangling lines connected to the bus.
-
getStaticVarCompensators
Iterable<StaticVarCompensator> getStaticVarCompensators()
Get static VAR compensators connected to the bus.
-
getStaticVarCompensatorStream
Stream<StaticVarCompensator> getStaticVarCompensatorStream()
Get static VAR compensators connected to the bus.
-
getLccConverterStations
Iterable<LccConverterStation> getLccConverterStations()
Get LCC converter stations connected to the bus.
-
getLccConverterStationStream
Stream<LccConverterStation> getLccConverterStationStream()
Get LCC converter stations connected to the bus.
-
getVscConverterStations
Iterable<VscConverterStation> getVscConverterStations()
Get VSC converter stations connected to the bus.
-
getVscConverterStationStream
Stream<VscConverterStation> getVscConverterStationStream()
Get VSC converter stations connected to the bus.
-
visitConnectedEquipments
void visitConnectedEquipments(TopologyVisitor visitor)
Visit equipments connected to the bus.- Parameters:
visitor
- a handler to be notified for each equipment connected at the bus
-
visitConnectedOrConnectableEquipments
void visitConnectedOrConnectableEquipments(TopologyVisitor visitor)
Visit equipments connected or connectable to the bus.- Parameters:
visitor
- a handler to be notified for each equipment
-
getConnectedTerminals
default Iterable<? extends Terminal> getConnectedTerminals()
Get an iterable of the terminals connected to the bus.
-
getConnectedTerminalStream
default Stream<? extends Terminal> getConnectedTerminalStream()
Get a stream of the terminals connected to the bus.
-
getType
default IdentifiableType getType()
Description copied from interface:Identifiable
Get identifiable type.- Specified by:
getType
in interfaceIdentifiable<Bus>
- Returns:
- the identifiable type
-
-