Package com.inductiveautomation.ignition.alarming.designer.workspace

Class PipelineBlockModel

java.lang.Object

com.inductiveautomation.ignition.common.util.AbstractChangeable

com.inductiveautomation.ignition.alarming.designer.workspace.PipelineBlockModel

All Implemented Interfaces:

Changeable, BlockDiagramModel

public class PipelineBlockModel
extends AbstractChangeable
implements BlockDiagramModel

Field Summary

Fields

Modifier and Type	Field	Description
static final Property<Dimension>	SIZE

Fields inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable

changeEvent, listenerList

Constructor Summary

Constructors

Constructor	Description
PipelineBlockModel(DesignerContext context, ProjectResource resource)
PipelineBlockModel(DesignerContext context, ResourcePath resourcePath)

Method Summary

Modifier and Type	Method	Description
void	addBlock(Block block)	Add a new block to this model.
void	addConnection(AnchorPoint origin, AnchorPoint terminus)	Add a connection between two blocks.
void	addConnection(AnchorPoint origin, UUID destinationBlockId)
void	deleteBlock(Block block)	Delete the given block from the model.
void	deleteConnection(AnchorPoint origin, AnchorPoint terminus)	Remove a connection.
PipelineBlockPrototype	findPrototype(String factoryId)
Block	getBlock(UUID id)	Find the block with the given id, or null if no such block exists
Iterable<? extends Block>	getBlocks()	Provide an iterable collection for all the blocks in this model
UUID	getConnectedSetRoot()	If this diagram logically supports the idea of a "connected set" of vertices, this is the ID of the block that is the root of the connected set
Collection<Connection>	getConnections()
String	getDiagramName()	The name of the diagram will be used as the tab name
Dimension	getDiagramSize()	The size of the block and connector diagram canvas
PipelineDescriptor	getPipeline()
ResourcePath	getResourcePath()	The resource path of the project resource this block model is contained in
boolean	isConnectionValid(AnchorPoint addingStartAnchor, AnchorPoint addingEndAnchor)	Check whether a connection between the given anchor points is semantically valid or not
void	setDiagramSize(Dimension dim)

Methods inherited from class com.inductiveautomation.ignition.common.util.AbstractChangeable

addChangeListener, fireStateChanged, getChangeListeners, removeChangeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.inductiveautomation.ignition.designer.blockandconnector.model.BlockDiagramModel

addChangeListener, removeChangeListener

Field Details

SIZE

public static final Property<Dimension> SIZE

Constructor Details

PipelineBlockModel

public PipelineBlockModel(DesignerContext context,
 ResourcePath resourcePath)
                   throws SerializationException,
ResourceNotFoundException

Throws:

SerializationException

ResourceNotFoundException

PipelineBlockModel

public PipelineBlockModel(DesignerContext context,
 ProjectResource resource)
                   throws SerializationException

Throws:

SerializationException

Method Details

getPipeline

public PipelineDescriptor getPipeline()

getResourcePath

public ResourcePath getResourcePath()

Description copied from interface: BlockDiagramModel

The resource path of the project resource this block model is contained in

Specified by:

getResourcePath in interface BlockDiagramModel

getDiagramName

public String getDiagramName()

Description copied from interface: BlockDiagramModel

The name of the diagram will be used as the tab name

Specified by:

getDiagramName in interface BlockDiagramModel

getDiagramSize

public Dimension getDiagramSize()

Description copied from interface: BlockDiagramModel

The size of the block and connector diagram canvas

Specified by:

getDiagramSize in interface BlockDiagramModel

setDiagramSize

public void setDiagramSize(Dimension dim)

Specified by:

setDiagramSize in interface BlockDiagramModel

getBlock

public Block getBlock(UUID id)

Description copied from interface: BlockDiagramModel

Find the block with the given id, or null if no such block exists

Specified by:

getBlock in interface BlockDiagramModel

getConnectedSetRoot

public UUID getConnectedSetRoot()

Description copied from interface: BlockDiagramModel

If this diagram logically supports the idea of a "connected set" of vertices, this is the ID of the block that is the root of the connected set

Specified by:

getConnectedSetRoot in interface BlockDiagramModel

isConnectionValid

public boolean isConnectionValid(AnchorPoint addingStartAnchor,
 AnchorPoint addingEndAnchor)

Description copied from interface: BlockDiagramModel

Check whether a connection between the given anchor points is semantically valid or not

Specified by:

isConnectionValid in interface BlockDiagramModel

addBlock

public void addBlock(Block block)

Description copied from interface: BlockDiagramModel

Add a new block to this model. You must fire a change after this

Specified by:

addBlock in interface BlockDiagramModel

deleteBlock

public void deleteBlock(Block block)

Description copied from interface: BlockDiagramModel

Delete the given block from the model. You must fire a change after this

Specified by:

deleteBlock in interface BlockDiagramModel

getBlocks

public Iterable<? extends Block> getBlocks()

Description copied from interface: BlockDiagramModel

Provide an iterable collection for all the blocks in this model

Specified by:

getBlocks in interface BlockDiagramModel

findPrototype

public PipelineBlockPrototype findPrototype(String factoryId)

addConnection

public void addConnection(AnchorPoint origin,
 AnchorPoint terminus)

Description copied from interface: BlockDiagramModel

Add a connection between two blocks. You must fire a change after this

Specified by:

addConnection in interface BlockDiagramModel

addConnection

public void addConnection(AnchorPoint origin,
 UUID destinationBlockId)

deleteConnection

public void deleteConnection(AnchorPoint origin,
 AnchorPoint terminus)

Description copied from interface: BlockDiagramModel

Remove a connection. You must fire a change after this.

Specified by:

deleteConnection in interface BlockDiagramModel

getConnections

public Collection<Connection> getConnections()

Specified by:

getConnections in interface BlockDiagramModel