Package com.powsybl.sld.model.blocks

Interface Block

All Known Subinterfaces:

ComposedBlock, LegBlock, PrimaryBlock

All Known Implementing Classes:

AbstractBlock, AbstractComposedBlock, AbstractPrimaryBlock, BodyParallelBlock, BodyPrimaryBlock, FeederPrimaryBlock, LegParralelBlock, LegPrimaryBlock, SerialBlock, UndefinedBlock

public interface Block

Author:

Benoit Jeanson , Nicolas Duchene, Geoffroy Jamgotchian , Franck Lecuyer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Block.Extremity
static class	Block.Type

Method Summary

Modifier and Type	Method	Description
void	accept(BlockVisitor blockVisitor)
List<Block>	findBlockEmbeddingNode(Node node)
int	getCardinality(Block.Extremity extremity)
int	getCardinality(Node commonNode)
Coord	getCoord()
Node	getEndingNode()
Optional<Block.Extremity>	getExtremity(Node node)
Node	getExtremityNode(Block.Extremity extremity)
default int	getOrder()	Calculates all the blocks dimensions and find the order of the layout.block inside the cell
Orientation	getOrientation()
Position	getPosition()
Node	getStartingNode()
Block.Type	getType()
boolean	isEmbeddingNodeType(Node.NodeType type)
void	reverseBlock()
void	setCardinality(Block.Extremity extremity, int i)
void	setOrientation(Orientation orientation)
void	setOrientation(Orientation orientation, boolean recursively)
void	setParentBlock(Block parentBlock)
void	sizing()	Calculate maximal pxWidth that layout.block can use in a cell without modifying root pxWidth
void	writeJson(com.fasterxml.jackson.core.JsonGenerator generator, boolean includeCoordinates)

Method Detail

getExtremityNode

Node getExtremityNode(Block.Extremity extremity)

getExtremity

Optional<Block.Extremity> getExtremity(Node node)

getStartingNode

Node getStartingNode()

getEndingNode

Node getEndingNode()

reverseBlock

void reverseBlock()

isEmbeddingNodeType

boolean isEmbeddingNodeType(Node.NodeType type)

findBlockEmbeddingNode

List<Block> findBlockEmbeddingNode(Node node)

setParentBlock

void setParentBlock(Block parentBlock)

getPosition

Position getPosition()

getCoord

Coord getCoord()

sizing

void sizing()

Calculate maximal pxWidth that layout.block can use in a cell without modifying root pxWidth

accept

void accept(BlockVisitor blockVisitor)

getOrder

default int getOrder()

Calculates all the blocks dimensions and find the order of the layout.block inside the cell

setCardinality

void setCardinality(Block.Extremity extremity,
                    int i)

getCardinality

int getCardinality(Block.Extremity extremity)

getCardinality

int getCardinality(Node commonNode)

setOrientation

void setOrientation(Orientation orientation)

setOrientation

void setOrientation(Orientation orientation,
                    boolean recursively)

getOrientation

Orientation getOrientation()

getType

Block.Type getType()

writeJson

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

Throws:

IOException