com.powsybl.ucte.network

Class UcteElementId

java.lang.Object

com.powsybl.ucte.network.UcteElementId

All Implemented Interfaces:

Comparable<UcteElementId>

public class UcteElementId
extends Object
implements Comparable<UcteElementId>

Author:

Geoffroy Jamgotchian

Constructor Summary

Constructors

Constructor and Description
UcteElementId(UcteNodeCode nodeCode1, UcteNodeCode nodeCode2, char orderCode)

Method Summary

Modifier and Type	Method and Description
int	compareTo(UcteElementId ucteElementId)
boolean	equals(Object obj)
UcteNodeCode	getNodeCode1() Gets node 1 code.
UcteNodeCode	getNodeCode2() Gets node 2 code.
char	getOrderCode() Gets order code (1, 2, 3 ... 9, A, B, C ...
int	hashCode()
static boolean	isUcteElementId(String id)
static Optional<UcteElementId>	parseUcteElementId(String id)
void	setOrderCode(char orderCode) Sets order code (1, 2, 3 ... 9, A, B, C ...
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UcteElementId

public UcteElementId(UcteNodeCode nodeCode1,
                     UcteNodeCode nodeCode2,
                     char orderCode)

Method Detail

getNodeCode1

public UcteNodeCode getNodeCode1()

Gets node 1 code.

Returns:

node 1 code

getNodeCode2

public UcteNodeCode getNodeCode2()

Gets node 2 code.

Returns:

node 2 code

getOrderCode

public char getOrderCode()

Gets order code (1, 2, 3 ... 9, A, B, C ... Z).

Returns:

order code

setOrderCode

public void setOrderCode(char orderCode)

Sets order code (1, 2, 3 ... 9, A, B, C ... Z).

Parameters:

orderCode - order code

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(UcteElementId ucteElementId)

Specified by:

compareTo in interface Comparable<UcteElementId>

parseUcteElementId

public static Optional<UcteElementId> parseUcteElementId(String id)

isUcteElementId

public static boolean isUcteElementId(String id)