Package com.powsybl.iidm.network

Interface OverloadManagementSystem.Tripping

All Known Subinterfaces:

OverloadManagementSystem.BranchTripping, OverloadManagementSystem.SwitchTripping, OverloadManagementSystem.ThreeWindingsTransformerTripping

Enclosing interface:

OverloadManagementSystem

public static interface OverloadManagementSystem.Tripping

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	OverloadManagementSystem.Tripping.Type

Method Summary

Modifier and Type	Method	Description
double	getCurrentLimit()	Return the maximum acceptable current value (in A).
String	getKey()	Get the unique key of the tripping.
String	getNameOrKey()	Get the name (if available) or the key of the tripping.
OverloadManagementSystem.Tripping.Type	getType()
boolean	isOpenAction()	Tell if the tripping operation consists in opening (true) or closing (false) the element (branch, three windings transformer or switch) to operate.
OverloadManagementSystem.Tripping	setCurrentLimit(double currentLimit)
OverloadManagementSystem.Tripping	setName(String name)	Set the name of the tripping.
OverloadManagementSystem.Tripping	setOpenAction(boolean open)

Method Details

getType

OverloadManagementSystem.Tripping.Type getType()

getKey

String getKey()

Get the unique key of the tripping.

This key is unique for a single overload management system, but it can be reused for another overload management system).

Returns:

the tripping key

getNameOrKey

String getNameOrKey()

Get the name (if available) or the key of the tripping.

This method result is used for reporting purposes.

Returns:

the name (if available) or the key of the tripping

setName

OverloadManagementSystem.Tripping setName(String name)

Set the name of the tripping.

This name is facultative. It is used only for reporting purposes.

Parameters:

name - the name of the tripping

See Also:

• getNameOrKey()

getCurrentLimit

double getCurrentLimit()

Return the maximum acceptable current value (in A).

Returns:

the maximum current value

setCurrentLimit

OverloadManagementSystem.Tripping setCurrentLimit(double currentLimit)

isOpenAction

boolean isOpenAction()

Tell if the tripping operation consists in opening (true) or closing (false) the element (branch, three windings transformer or switch) to operate.

Returns:

true it the operation consists in opening the element, else false.

setOpenAction

OverloadManagementSystem.Tripping setOpenAction(boolean open)