Package com.powsybl.sld.svg

Class FeederInfo

java.lang.Object

com.powsybl.sld.svg.FeederInfo

public class FeederInfo
extends Object

Class used to describe an information element which is displayed below feeders, which contains one or more of the following:

• an arrow whose direction is specified
• a string on its right
• a string on its left

Each of these three element part is optional

Author:

Giovanni Ferrari , Thomas Adam

Constructor Summary

Constructors

Constructor	Description
FeederInfo(String componentType, double value)
FeederInfo(String componentType, double value, String userDefinedId)
FeederInfo(String componentType, DiagramLabelProvider.Direction arrowDirection, String leftLabel, String rightLabel)
FeederInfo(String componentType, DiagramLabelProvider.Direction arrowDirection, String leftLabel, String rightLabel, String userDefinedId)

Method Summary

Modifier and Type	Method	Description
String	getComponentType()
Optional<DiagramLabelProvider.Direction>	getDirection()
Optional<String>	getLeftLabel()
Optional<String>	getRightLabel()
String	getUserDefinedId()
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Constructor Detail

FeederInfo

public FeederInfo(String componentType,
                  DiagramLabelProvider.Direction arrowDirection,
                  String leftLabel,
                  String rightLabel)

FeederInfo

public FeederInfo(String componentType,
                  DiagramLabelProvider.Direction arrowDirection,
                  String leftLabel,
                  String rightLabel,
                  String userDefinedId)

FeederInfo

public FeederInfo(String componentType,
                  double value)

FeederInfo

public FeederInfo(String componentType,
                  double value,
                  String userDefinedId)

Method Detail

isEmpty

public boolean isEmpty()

getUserDefinedId

public String getUserDefinedId()

getComponentType

public String getComponentType()

getDirection

public Optional<DiagramLabelProvider.Direction> getDirection()

getLeftLabel

public Optional<String> getLeftLabel()

getRightLabel

public Optional<String> getRightLabel()