Package com.powsybl.sld.model

Class VoltageLevelGraph

java.lang.Object

com.powsybl.sld.model.AbstractGraph

com.powsybl.sld.model.AbstractLineGraph

com.powsybl.sld.model.AbstractBaseGraph

com.powsybl.sld.model.VoltageLevelGraph

All Implemented Interfaces:

BaseGraph, Graph, LineGraph

public class VoltageLevelGraph
extends AbstractBaseGraph

This class builds the connectivity among the elements of a voltageLevel buildGraphAndDetectCell establishes the List of nodes, edges and nodeBuses cells is built by the PatternCellDetector Class

Author:

Benoit Jeanson , Nicolas Duchene, Geoffroy Jamgotchian , Franck Lecuyer

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	VALUE_SHIFT_FEEDER

Fields inherited from class com.powsybl.sld.model.AbstractBaseGraph

multiTermNodes, twtEdges

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VoltageLevelGraph(VoltageLevelInfos voltageLevelInfos, boolean useName, boolean forVoltageLevelDiagram)

Method Summary

Modifier and Type	Method	Description
void	addCell(Cell c)
Edge	addEdge(Node n1, Node n2)	Add an edge between the two nodes
void	addNode(Node node)
void	conditionalExtensionOfNodeConnectedToBus(Predicate<Node> condition)
static VoltageLevelGraph	create(VoltageLevelInfos voltageLevelInfos, boolean useName, boolean forVoltageLevelDiagram)
void	extendBusConnectedToBus()
void	extendFirstOutsideNode()
void	extendSwitchBetweenBus(SwitchNode nodeSwitch)
Stream<BusCell>	getBusCells()
Set<Cell>	getCells()
List<List<Node>>	getConnexComponents(List<Node> nodesIn)
Point	getCoord()
List<Edge>	getEdges()
Set<Edge>	getEdgeSet()
Double	getExternCellHeight(BusCell.Direction direction)
List<FeederNode>	getFeederNodes()
double	getFirstBusY(LayoutParameters layoutParam)
String	getId()
double	getLastBusY(LayoutParameters layoutParam)
int	getMaxH()
int	getMaxHorizontalBusPosition()
int	getMaxV()
int	getMaxVerticalBusPosition()
int	getNextCellIndex()
Node	getNode(String id)
List<BusNode>	getNodeBuses()
List<Node>	getNodes()
Set<Node>	getNodeSet()
BusNode	getVHNodeBus(int v, int h)
VoltageLevelGraph	getVLGraph(String voltageLevelId)
VoltageLevelInfos	getVoltageLevelInfos()
double	getX()
double	getY()
void	handleMultiTermsNodeRotation()
void	insertFictitiousNodesAtFeeders()	Insert fictitious node(s) before feeders in order for the feeder to be properly displayed: feeders need at least one inserted fictitious node to have enough space to display the feeder arrows.
InternalNode	insertInternalNode(Node node1, Node node2, String id)
boolean	isForVoltageLevelDiagram()
boolean	isPositionNodeBusesCalculated()
boolean	isUseName()
void	logCellDetectionStatus()
void	removeCell(Cell c)
void	removeNode(Node node)
void	removeUnnecessaryFictitiousNodes()
void	replaceNode(Node nodeOrigin, Node newNode)	Replace a node with another node which is not yet in the graph.
void	resetCoords()
void	setCoord(double x, double y)
void	setExternCellHeight(Map<BusCell.Direction,Double> externCellHeight)
void	setMaxBusPosition()
void	setMaxHorizontalBusPosition(int maxHorizontalBusPosition)
void	setMaxVerticalBusPosition(int maxVerticalBusPosition)
void	substituteFictitiousNodesMirroringBusNodes()
void	substituteNode(Node nodeOrigin, Node newNode)	Substitute a node with another node already in the graph.
void	substituteSingularFictitiousByFeederNode()
org.jgrapht.Graph<Node,Edge>	toJgrapht()
void	writeJson(com.fasterxml.jackson.core.JsonGenerator generator)

Methods inherited from class com.powsybl.sld.model.AbstractBaseGraph

addMultiTermNode, addTwtEdge, getMultiTermNodes, getTwtEdges, writeBranchFields

Methods inherited from class com.powsybl.sld.model.AbstractLineGraph

addLineEdge, getLineEdges

Methods inherited from class com.powsybl.sld.model.AbstractGraph

getHeight, getWidth, isGenerateCoordsInJson, setGenerateCoordsInJson, setSize, writeJson, writeJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.powsybl.sld.model.Graph

getHeight, getWidth, isGenerateCoordsInJson, setGenerateCoordsInJson, writeJson, writeJson

Methods inherited from interface com.powsybl.sld.model.LineGraph

addLineEdge, getLineEdges

Field Detail

VALUE_SHIFT_FEEDER

protected static final int VALUE_SHIFT_FEEDER

See Also:

Constant Field Values

Constructor Detail

VoltageLevelGraph

protected VoltageLevelGraph(VoltageLevelInfos voltageLevelInfos,
                            boolean useName,
                            boolean forVoltageLevelDiagram)

Method Detail

create

public static VoltageLevelGraph create(VoltageLevelInfos voltageLevelInfos,
                                       boolean useName,
                                       boolean forVoltageLevelDiagram)

getId

public String getId()

isUseName

public boolean isUseName()

isForVoltageLevelDiagram

public boolean isForVoltageLevelDiagram()

getNextCellIndex

public int getNextCellIndex()

removeUnnecessaryFictitiousNodes

public void removeUnnecessaryFictitiousNodes()

logCellDetectionStatus

public void logCellDetectionStatus()

toJgrapht

public org.jgrapht.Graph<Node,Edge> toJgrapht()

addNode

public void addNode(Node node)

removeNode

public void removeNode(Node node)

getNode

public Node getNode(String id)

getVLGraph

public VoltageLevelGraph getVLGraph(String voltageLevelId)

addEdge

public Edge addEdge(Node n1,
                    Node n2)

Add an edge between the two nodes

Parameters:

n1 - first node

n2 - second node

getConnexComponents

public List<List<Node>> getConnexComponents(List<Node> nodesIn)

setMaxBusPosition

public void setMaxBusPosition()

getBusCells

public Stream<BusCell> getBusCells()

insertFictitiousNodesAtFeeders

public void insertFictitiousNodesAtFeeders()

Insert fictitious node(s) before feeders in order for the feeder to be properly displayed: feeders need at least one inserted fictitious node to have enough space to display the feeder arrows. Some special cases: - feeders connected directly to a bus need 3 additional nodes (1 fictitious disconnector, 2 internal nodes) to obey the Leg/Body/Feeder structure - feeders connected to a bus through a disconnector need 2 additional internal nodes to obey the Leg/Body/Feeder structure - 3WT do not need any fictitious node inserted here as they already have the fictitious Middle3WTNode

extendFirstOutsideNode

public void extendFirstOutsideNode()

conditionalExtensionOfNodeConnectedToBus

public void conditionalExtensionOfNodeConnectedToBus(Predicate<Node> condition)

extendBusConnectedToBus

public void extendBusConnectedToBus()

extendSwitchBetweenBus

public void extendSwitchBetweenBus(SwitchNode nodeSwitch)

insertInternalNode

public InternalNode insertInternalNode(Node node1,
                                       Node node2,
                                       String id)

substituteNode

public void substituteNode(Node nodeOrigin,
                           Node newNode)

Substitute a node with another node already in the graph. Use replaceNode(com.powsybl.sld.model.Node, com.powsybl.sld.model.Node) instead if the node newNode is not already in the graph.

Parameters:

nodeOrigin - : node which will be substituted

newNode - : node which will substitute the first one

replaceNode

public void replaceNode(Node nodeOrigin,
                        Node newNode)

Replace a node with another node which is not yet in the graph. Use substituteNode(com.powsybl.sld.model.Node, com.powsybl.sld.model.Node) instead if the node newNode is already in the graph.

Parameters:

nodeOrigin - : node which will be replaced

newNode - : node which will replace the first one

substituteFictitiousNodesMirroringBusNodes

public void substituteFictitiousNodesMirroringBusNodes()

substituteSingularFictitiousByFeederNode

public void substituteSingularFictitiousByFeederNode()

getVHNodeBus

public BusNode getVHNodeBus(int v,
                            int h)

addCell

public void addCell(Cell c)

removeCell

public void removeCell(Cell c)

getNodeBuses

public List<BusNode> getNodeBuses()

getFeederNodes

public List<FeederNode> getFeederNodes()

getNodes

public List<Node> getNodes()

getEdges

public List<Edge> getEdges()

getNodeSet

public Set<Node> getNodeSet()

getEdgeSet

public Set<Edge> getEdgeSet()

getCells

public Set<Cell> getCells()

getVoltageLevelInfos

public VoltageLevelInfos getVoltageLevelInfos()

getCoord

public Point getCoord()

setCoord

public void setCoord(double x,
                     double y)

getX

public double getX()

getY

public double getY()

isPositionNodeBusesCalculated

public boolean isPositionNodeBusesCalculated()

writeJson

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

Specified by:

writeJson in class AbstractGraph

Throws:

IOException

resetCoords

public void resetCoords()

getMaxH

public int getMaxH()

getMaxV

public int getMaxV()

getExternCellHeight

public Double getExternCellHeight(BusCell.Direction direction)

setExternCellHeight

public void setExternCellHeight(Map<BusCell.Direction,Double> externCellHeight)

getMaxHorizontalBusPosition

public int getMaxHorizontalBusPosition()

setMaxHorizontalBusPosition

public void setMaxHorizontalBusPosition(int maxHorizontalBusPosition)

getMaxVerticalBusPosition

public int getMaxVerticalBusPosition()

setMaxVerticalBusPosition

public void setMaxVerticalBusPosition(int maxVerticalBusPosition)

handleMultiTermsNodeRotation

public void handleMultiTermsNodeRotation()

Overrides:

handleMultiTermsNodeRotation in class AbstractBaseGraph

getFirstBusY

public double getFirstBusY(LayoutParameters layoutParam)

getLastBusY

public double getLastBusY(LayoutParameters layoutParam)