Package com.powsybl.iidm.network

Interface HvdcLine

All Superinterfaces:

Extendable<HvdcLine>, Identifiable<HvdcLine>

All Known Implementing Classes:

HvdcLineAdapter

public interface HvdcLine
extends Identifiable<HvdcLine>

A HVDC line connected to two HVDC converters on DC side. It has to be connected to the same HvdcConverterStation subclass.

Characteristics

Attribute	Type	Unit	Required	Defaut value	Description
Id	String	-	yes	-	Unique identifier of the HVDC line
Name	String	-	yes	-	Human-readable name of the HVDC line
R	double	Ω	yes	-	The resistance of the HVDC line
ConvertersMode	ConvertersMode	-	yes	-	The converter's mode
NominalV	double	kV	yes	-	The nominal voltage
ActivePowerSetpoint	double	MW	yes	-	The active power setpoint
MaxP	double	MW	yes	-	The maximum active power
ConverterStationId1	String	-	yes	-	The ID of the HVDC converter station connected on side 1
ConverterStationId2	String	-	yes	-	The ID of the HVDC converter station connected on side 2

Author:

Geoffroy Jamgotchian , Mathieu Bague

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HvdcLine.ConvertersMode	Converters mode used to known the sign of the active power of the HVDC line.
static class	HvdcLine.Side

Method Summary

Modifier and Type	Method	Description
double	getActivePowerSetpoint()	Get the active power setpoint (in MW).
HvdcLine.ConvertersMode	getConvertersMode()	Get converters mode.
default HvdcConverterStation<?>	getConverterStation(HvdcLine.Side side)	Get the HVDC converter station connected to a side
HvdcConverterStation<?>	getConverterStation1()	Get the HVDC converter station connected on side 1.
HvdcConverterStation<?>	getConverterStation2()	Get the HVDC converter station connected on side 2.
double	getMaxP()	Get the maximum active power (in MW).
Network	getNetwork()	Get the network this HVDC line belongs.
double	getNominalV()	Get the nominal voltage (in Kv).
double	getR()	Get resistance (in Ω) of the line.
void	remove()	Remove the HVDC line
HvdcLine	setActivePowerSetpoint(double activePowerSetpoint)	Set the active power setpoint (in MW).
HvdcLine	setConvertersMode(HvdcLine.ConvertersMode mode)	Change converters mode.
HvdcLine	setMaxP(double maxP)	Set the maximum active power (in MW).
HvdcLine	setNominalV(double nominalV)	Set the nominal voltage.
HvdcLine	setR(double r)	Set the resistance (in Ω) of the line.

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, getOptionalName, getProperties, getProperty, getProperty, getPropertyNames, hasAliases, hasProperty, hasProperty, isFictitious, removeAlias, setFictitious, setProperty

Method Detail

getNetwork

Network getNetwork()

Get the network this HVDC line belongs.

Specified by:

getNetwork in interface Identifiable<HvdcLine>

Returns:

the network this HVDC line belongs

getConvertersMode

HvdcLine.ConvertersMode getConvertersMode()

Get converters mode.

Returns:

converters mode

setConvertersMode

HvdcLine setConvertersMode(HvdcLine.ConvertersMode mode)

Change converters mode.

Parameters:

mode - converters mode

Returns:

the station itself to allow method chaining.

getR

double getR()

Get resistance (in Ω) of the line.

Returns:

the resistance of the line

setR

HvdcLine setR(double r)

Set the resistance (in Ω) of the line.

Parameters:

r - the resistance of the line

Returns:

the HVDC line itself to allow method chaining

getNominalV

double getNominalV()

Get the nominal voltage (in Kv).

Returns:

the nominal voltage.

setNominalV

HvdcLine setNominalV(double nominalV)

Set the nominal voltage.

Parameters:

nominalV - the nominal voltage.

Returns:

the HVDC line itself to allow method chaining

getActivePowerSetpoint

double getActivePowerSetpoint()

Get the active power setpoint (in MW).

Returns:

the active power setpoint

setActivePowerSetpoint

HvdcLine setActivePowerSetpoint(double activePowerSetpoint)

Set the active power setpoint (in MW).

Parameters:

activePowerSetpoint - the active power setpoint

Returns:

the HVDC line itself to allow method chaining

getMaxP

double getMaxP()

Get the maximum active power (in MW).

Returns:

the maximum active power

setMaxP

HvdcLine setMaxP(double maxP)

Set the maximum active power (in MW).

Parameters:

maxP - the maximum active power

Returns:

the HVDC line itself to allow method chaining

getConverterStation

default HvdcConverterStation<?> getConverterStation(HvdcLine.Side side)

Get the HVDC converter station connected to a side

Returns:

the HVDC converter station connected to the side

getConverterStation1

HvdcConverterStation<?> getConverterStation1()

Get the HVDC converter station connected on side 1.

Returns:

the HVDC converter station connected on side 1

getConverterStation2

HvdcConverterStation<?> getConverterStation2()

Get the HVDC converter station connected on side 2.

Returns:

the HVDC converter station connected on side 2

remove

void remove()

Remove the HVDC line