Class BranchFlow
- java.lang.Object
-
- com.powsybl.sensitivity.SensitivityFunction
-
- com.powsybl.sensitivity.factors.functions.BranchFlow
-
public class BranchFlow extends SensitivityFunction
Sensitivity function on a network branch flow- Author:
- Sebastien Murgey <sebastien.murgey at rte-france.com>
-
-
Constructor Summary
Constructors Constructor Description BranchFlow(String id, String name, String branchId)
Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getBranchId()
Get the id of the network branch composing the sensitivity function-
Methods inherited from class com.powsybl.sensitivity.SensitivityFunction
getId, getName
-
-
-
-
Constructor Detail
-
BranchFlow
public BranchFlow(String id, String name, String branchId)
Constructor- Parameters:
id
- unique identifier of the functionname
- readable name of the functionbranchId
- id of the network branch which flow is used as sensitivity function- Throws:
NullPointerException
- if branchId is null
-
-
Method Detail
-
getBranchId
public String getBranchId()
Get the id of the network branch composing the sensitivity function- Returns:
- the network branch id
-
-