Package com.powsybl.ucte.network

Class UcteNodeCode

java.lang.Object

com.powsybl.ucte.network.UcteNodeCode

All Implemented Interfaces:

Comparable<UcteNodeCode>

public class UcteNodeCode
extends Object
implements Comparable<UcteNodeCode>

Author:

Geoffroy Jamgotchian

Constructor Summary

Constructors

Constructor	Description
UcteNodeCode(UcteCountryCode ucteCountryCode, String geographicalSpot, UcteVoltageLevelCode voltageLevelCode, Character busbar)

Method Summary

Modifier and Type	Method	Description
int	compareTo(UcteNodeCode ucteNodeCode)
boolean	equals(Object obj)
Character	getBusbar()	Gets letter or figure for differentiating bus bars (optional).
String	getGeographicalSpot()	Gets short description of the geographical spot.
UcteCountryCode	getUcteCountryCode()	Gets UCTE country code.
UcteVoltageLevelCode	getVoltageLevelCode()	Gets voltage level.
int	hashCode()
static boolean	isUcteNodeId(String id)
static Optional<UcteNodeCode>	parseUcteNodeCode(String id)	Convert a string into a UcteNodeCode if possible, i.e. the string is compatible with the ucteNodeCode format
void	setBusbar(Character busbar)	Sets letter or figure for differentiating bus bars (optional).
void	setGeographicalSpot(String geographicalSpot)	Sets short description of the geographical spot.
void	setUcteCountryCode(UcteCountryCode ucteCountryCode)	Sets UCTE country code.
void	setVoltageLevelCode(UcteVoltageLevelCode voltageLevelCode)	Sets voltage level.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UcteNodeCode

public UcteNodeCode(UcteCountryCode ucteCountryCode,
                    String geographicalSpot,
                    UcteVoltageLevelCode voltageLevelCode,
                    Character busbar)

Method Detail

getUcteCountryCode

public UcteCountryCode getUcteCountryCode()

Gets UCTE country code.

Returns:

UCTE country code

setUcteCountryCode

public void setUcteCountryCode(UcteCountryCode ucteCountryCode)

Sets UCTE country code.

Parameters:

ucteCountryCode - UCTE country code

getGeographicalSpot

public String getGeographicalSpot()

Gets short description of the geographical spot.

Returns:

short description of the geographical spot

setGeographicalSpot

public void setGeographicalSpot(String geographicalSpot)

Sets short description of the geographical spot.

Parameters:

geographicalSpot - short description of the geographical spot

getVoltageLevelCode

public UcteVoltageLevelCode getVoltageLevelCode()

Gets voltage level.

Returns:

voltage level

setVoltageLevelCode

public void setVoltageLevelCode(UcteVoltageLevelCode voltageLevelCode)

Sets voltage level.

Parameters:

voltageLevelCode - voltage level

getBusbar

public Character getBusbar()

Gets letter or figure for differentiating bus bars (optional).

Returns:

letter or figure for differentiating bus bars

setBusbar

public void setBusbar(Character busbar)

Sets letter or figure for differentiating bus bars (optional).

Parameters:

busbar - letter or figure for differentiating bus bars

parseUcteNodeCode

public static Optional<UcteNodeCode> parseUcteNodeCode(String id)

Convert a string into a UcteNodeCode if possible, i.e. the string is compatible with the ucteNodeCode format

Parameters:

id - to convert into a UcteNodeCode

Returns:

an Optional that may contain a UcteNodeCode

isUcteNodeId

public static boolean isUcteNodeId(String id)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(UcteNodeCode ucteNodeCode)

Specified by:

compareTo in interface Comparable<UcteNodeCode>