Package com.powsybl.iidm.modification.scalable

Class DanglingLineScalable

java.lang.Object

com.powsybl.iidm.modification.scalable.DanglingLineScalable

All Implemented Interfaces:

Scalable

public class DanglingLineScalable
extends Object

Author:

Coline Piloquet

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.iidm.modification.scalable.Scalable

Scalable.ScalingConvention

Field Summary

Fields

Modifier and Type	Field	Description
protected String	id
protected double	maxValue
protected double	minValue

Method Summary

Modifier and Type	Method	Description
List<Injection>	filterInjections(Network network)	Scans all the expected injections of the scalable.
void	filterInjections(Network n, List<Injection> injections, List<String> notFoundInjections)	Scans all the expected injections of the scalable.
List<Injection>	filterInjections(Network network, List<String> notFound)	Scans all the expected injections of the scalable.
double	initialValue(Network n)	Get the constant active power in MW injected at the network.
List<Generator>	listGenerators(Network n)	Deprecated. listGenerators should be replaced by filterInjections
void	listGenerators(Network network, List<Generator> generators, List<String> notFoundGenerators)	Deprecated. listGenerators should be replaced by filterInjections
List<Generator>	listGenerators(Network n, List<String> notFoundGenerators)	Deprecated. listGenerators should be replaced by filterInjections
double	maximumValue(Network n)	Get the maximal active power in MW.
double	maximumValue(Network n, Scalable.ScalingConvention scalingConvention)	Get the maximal active power in MW with scaling convention.
double	minimumValue(Network n)	Get the minimal active power in MW.
double	minimumValue(Network n, Scalable.ScalingConvention scalingConvention)	Get the minimal active power in MW with scaling convention.
void	reset(Network n)	Set the constant active power to zero.
double	scale(Network n, double asked)	Scale the given network using Generator convention by default.
double	scale(Network n, double asked, Scalable.ScalingConvention scalingConvention)	Scale the given network.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.powsybl.iidm.modification.scalable.Scalable

scaleWithConstantPowerFactor, scaleWithConstantPowerFactor

Field Detail

id

protected final String id

minValue

protected final double minValue

maxValue

protected final double maxValue

Method Detail

reset

public void reset(Network n)

Description copied from interface: Scalable

Set the constant active power to zero.

maximumValue

public double maximumValue(Network n,
                           Scalable.ScalingConvention scalingConvention)

Get the maximal active power in MW with scaling convention.

There is no default value for the maximum value.

See Also:

Scalable.ScalingConvention

minimumValue

public double minimumValue(Network n,
                           Scalable.ScalingConvention scalingConvention)

Get the minimal active power in MW with scaling convention.

There is no default value for the minimum value.

See Also:

Scalable.ScalingConvention

filterInjections

public void filterInjections(Network n,
                             List<Injection> injections,
                             List<String> notFoundInjections)

Description copied from interface: Scalable

Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list. Otherwise, its identifier is added to the "notFound" list.

Parameters:

n - network

injections - network injections used in the scalable

notFoundInjections - expected injections not found in the network

scale

public double scale(Network n,
                    double asked,
                    Scalable.ScalingConvention scalingConvention)

Scale the given network. The actual scaling value may be different to the one asked, if the Scalable limit is reached.

If scalingConvention is LOAD, the load active power increases for positive "asked" and decreases inversely If scalingConvention is GENERATOR, the load active power decreases for positive "asked" and increases inversely

Parameters:

n - network

asked - value asked to adjust the scalable active power

scalingConvention - power convention used for scaling

Returns:

the actual value of the scalable active power adjustment

See Also:

Scalable.ScalingConvention

maximumValue

public double maximumValue(Network n)

Description copied from interface: Scalable

Get the maximal active power in MW. Uses Generator convention by default

Specified by:

maximumValue in interface Scalable

minimumValue

public double minimumValue(Network n)

Description copied from interface: Scalable

Get the minimal active power in MW. Uses Generator convention by default

Specified by:

minimumValue in interface Scalable

scale

public double scale(Network n,
                    double asked)

Description copied from interface: Scalable

Scale the given network using Generator convention by default. The actual scaling value may be different to the one asked, if the Scalable limit is reached.

Specified by:

scale in interface Scalable

Parameters:

n - network

asked - value asked to adjust the scalable active power

Returns:

the actual value of the scalable active power adjustment

initialValue

public double initialValue(Network n)

Description copied from interface: Scalable

Get the constant active power in MW injected at the network.

filterInjections

public List<Injection> filterInjections(Network network,
                                        List<String> notFound)

Description copied from interface: Scalable

Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list. Otherwise, its identifier is added to the "notFound" list.

Specified by:

filterInjections in interface Scalable

Parameters:

network - network

notFound - expected injections not found in the network

Returns:

network injections used in the scalable

filterInjections

public List<Injection> filterInjections(Network network)

Description copied from interface: Scalable

Scans all the expected injections of the scalable. If the injection can be found in given network, it is added the the injections list.

Specified by:

filterInjections in interface Scalable

Parameters:

network - network

Returns:

network injections used in the scalable

listGenerators

@Deprecated
public List<Generator> listGenerators(Network n,
                                      List<String> notFoundGenerators)

Deprecated.

listGenerators should be replaced by filterInjections

Specified by:

listGenerators in interface Scalable

listGenerators

@Deprecated
public List<Generator> listGenerators(Network n)

Deprecated.

listGenerators should be replaced by filterInjections

Specified by:

listGenerators in interface Scalable

listGenerators

@Deprecated
public void listGenerators(Network network,
                           List<Generator> generators,
                           List<String> notFoundGenerators)

Deprecated.

listGenerators should be replaced by filterInjections

Specified by:

listGenerators in interface Scalable