Package com.powsybl.sld.model.nodes

Class AbstractNode

java.lang.Object

com.powsybl.sld.model.nodes.AbstractNode

All Implemented Interfaces:

Node

Direct Known Subclasses:

ConnectivityNode, EquipmentNode

public abstract class AbstractNode
extends Object
implements Node

Author:

Benoit Jeanson , Nicolas Duchene, Geoffroy Jamgotchian , Franck Lecuyer

Nested Class Summary

Nested classes/interfaces inherited from interface com.powsybl.sld.model.nodes.Node

Node.NodeType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractNode(Node.NodeType type, String id, String componentType, boolean fictitious)	Constructor

Method Summary

Modifier and Type	Method	Description
void	addAdjacentEdge(Edge e)
boolean	checkNodeSimilarity(Node n)	Check similarity with another node
protected Orientation	defaultOrientation()
List<Edge>	getAdjacentEdges()
List<Node>	getAdjacentNodes()
int	getCardinality(VoltageLevelGraph vlGraph)
String	getComponentType()
Point	getCoordinates()
Direction	getDirection()
String	getId()
Optional<String>	getLabel()
Optional<Integer>	getOrder()
Orientation	getOrientation()
Node.NodeType	getType()
double	getX()	Get abscissa within current voltage level
double	getY()	Get ordinate within current voltage level
boolean	isFictitious()
void	removeAdjacentEdge(Edge e)
void	removeOrder()
void	setCoordinates(double x, double y)
void	setCoordinates(Point coord)
void	setDirection(Direction direction)
void	setLabel(String label)
void	setOrder(int order)
void	setOrientation(Orientation orientation)
void	setType(Node.NodeType type)
void	setX(double x)
void	setY(double y)
boolean	similarToAFeederNode(Node n)
String	toString()
void	writeJson(com.fasterxml.jackson.core.JsonGenerator generator, boolean includeCoordinates)
protected void	writeJsonContent(com.fasterxml.jackson.core.JsonGenerator generator, boolean includeCoordinates)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNode

protected AbstractNode(Node.NodeType type,
                       String id,
                       String componentType,
                       boolean fictitious)

Constructor

Method Detail

getComponentType

public String getComponentType()

Specified by:

getComponentType in interface Node

isFictitious

public boolean isFictitious()

Specified by:

isFictitious in interface Node

setType

public void setType(Node.NodeType type)

Specified by:

setType in interface Node

getId

public String getId()

Specified by:

getId in interface Node

getLabel

public Optional<String> getLabel()

Specified by:

getLabel in interface Node

setLabel

public void setLabel(String label)

Specified by:

setLabel in interface Node

getAdjacentNodes

public List<Node> getAdjacentNodes()

Specified by:

getAdjacentNodes in interface Node

getAdjacentEdges

public List<Edge> getAdjacentEdges()

Specified by:

getAdjacentEdges in interface Node

addAdjacentEdge

public void addAdjacentEdge(Edge e)

Specified by:

addAdjacentEdge in interface Node

removeAdjacentEdge

public void removeAdjacentEdge(Edge e)

Specified by:

removeAdjacentEdge in interface Node

getCoordinates

public Point getCoordinates()

Specified by:

getCoordinates in interface Node

setCoordinates

public void setCoordinates(Point coord)

Specified by:

setCoordinates in interface Node

setCoordinates

public void setCoordinates(double x,
                           double y)

Specified by:

setCoordinates in interface Node

getX

public double getX()

Get abscissa within current voltage level

Specified by:

getX in interface Node

Returns:

abscissa within voltage level

getY

public double getY()

Get ordinate within current voltage level

Specified by:

getY in interface Node

Returns:

ordinate within voltage level

setX

public void setX(double x)

Specified by:

setX in interface Node

setY

public void setY(double y)

Specified by:

setY in interface Node

getType

public Node.NodeType getType()

Specified by:

getType in interface Node

getOrder

public Optional<Integer> getOrder()

Specified by:

getOrder in interface Node

setOrder

public void setOrder(int order)

Specified by:

setOrder in interface Node

removeOrder

public void removeOrder()

Specified by:

removeOrder in interface Node

getDirection

public Direction getDirection()

Specified by:

getDirection in interface Node

setDirection

public void setDirection(Direction direction)

Specified by:

setDirection in interface Node

getOrientation

public Orientation getOrientation()

Specified by:

getOrientation in interface Node

setOrientation

public void setOrientation(Orientation orientation)

Specified by:

setOrientation in interface Node

defaultOrientation

protected Orientation defaultOrientation()

checkNodeSimilarity

public boolean checkNodeSimilarity(Node n)

Check similarity with another node

Specified by:

checkNodeSimilarity in interface Node

Parameters:

n - the node to compare with

Returns:

true IF the both are the same OR they are both Busbar OR they are both EQ(but not Busbar); false otherwise

similarToAFeederNode

public boolean similarToAFeederNode(Node n)

Specified by:

similarToAFeederNode in interface Node

getCardinality

public int getCardinality(VoltageLevelGraph vlGraph)

Specified by:

getCardinality in interface Node

writeJsonContent

protected void writeJsonContent(com.fasterxml.jackson.core.JsonGenerator generator,
                                boolean includeCoordinates)
                         throws IOException

Throws:

IOException

writeJson

public void writeJson(com.fasterxml.jackson.core.JsonGenerator generator,
                      boolean includeCoordinates)
               throws IOException

Specified by:

writeJson in interface Node

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object