com.powsybl.sensitivity.factors.functions

Class BranchIntensity

java.lang.Object

com.powsybl.sensitivity.SensitivityFunction

com.powsybl.sensitivity.factors.functions.BranchIntensity

public class BranchIntensity
extends SensitivityFunction

Sensitivity function on a network branch intensity Only available in AC computation mode

Constructor Summary

Constructors

Constructor and Description
BranchIntensity(java.lang.String id, java.lang.String name, java.lang.String branchId) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBranchId() Get the id of the network branch composing the sensitivity function

Methods inherited from class com.powsybl.sensitivity.SensitivityFunction

getId, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

BranchIntensity

public BranchIntensity(java.lang.String id,
                       java.lang.String name,
                       java.lang.String branchId)

Constructor

Parameters:

id - unique identifier of the function

name - readable name of the function

branchId - id of the network branch which intensity is used as sensitivity function

Throws:

java.lang.NullPointerException - if branchId is null

Method Detail

getBranchId

public java.lang.String getBranchId()

Get the id of the network branch composing the sensitivity function

Returns:

the id of the network branch