FlowLib.Engine.FlowController Class Reference

Represents the controller of flow. More...

Public Member Functions
	FlowController ()
	Constructor.
Block	CreateBlock (BlockDescriptor blockDescriptor)
	Creates block by descriptor.
Block	CreateBlock (Block blockOriginal)
	Creates block by existing block.
void	AddBlock (Block block)
	Adds block.
Connection	AddConnection (Port sourcePort, Port destinationPort)
	Creates a connection between blocks.
void	CreateConnections (List< ConnectionDescriptor > descriptors)
	Creates a connections between blocks by descriptors.
void	RemoveBlock (Block block)
	Removes block.
Block	GetBlock (int blockID)
	Returns block by ID.

Properties
int	Count [get]
	Count of blocks.
Block	this[int index] [get]
	Indexer of blocks.
string	Name [get, set]
	Name of flow.

Events
BlockCreated	BlockCreated
	Event of block created.

Private Attributes
string	name = ""
	Name of the flow.
List< Block >	blockList
	List of blocks.
int	currentBlockID = 1
	Latest block ID.

Detailed Description

Represents the controller of flow.

Member Function Documentation

AddBlock()

void FlowLib.Engine.FlowController.AddBlock

(

Block

block

)

Adds block.

Parameters

block

AddConnection()

Connection FlowLib.Engine.FlowController.AddConnection	(	Port	sourcePort,
		Port	destinationPort )

Creates a connection between blocks.

Parameters

sourcePort	Source port.
destinationPort	Destination port.

Returns

Created connection.

Exceptions

ConnectionIsExistException

Excepption when connection is exist.

CreateBlock() [1/2]

Block FlowLib.Engine.FlowController.CreateBlock

(

Block

blockOriginal

)

Creates block by existing block.

Parameters

blockDescriptor

Descriptor.

Returns

The created block.

CreateBlock() [2/2]

Block FlowLib.Engine.FlowController.CreateBlock

(

BlockDescriptor

blockDescriptor

)

Creates block by descriptor.

Parameters

blockDescriptor

Descriptor.

Returns

The created block.

CreateConnections()

void FlowLib.Engine.FlowController.CreateConnections

(

List< ConnectionDescriptor >

descriptors

)

Creates a connections between blocks by descriptors.

Parameters

descriptors

List of descriptors.

GetBlock()

Block FlowLib.Engine.FlowController.GetBlock

(

int

blockID

)

Returns block by ID.

Parameters

blockID

ID of block.

Returns

The block.

RemoveBlock()

void FlowLib.Engine.FlowController.RemoveBlock

(

Block

block

)

Removes block.

Parameters

block

The block.

Property Documentation

this[int index]

Block FlowLib.Engine.FlowController.this[int index]

get

Indexer of blocks.

Parameters

index

Index of block.

Returns

The block.

---

The documentation for this class was generated from the following file:

• Z:/x4t/src/Flow.Engine/Flow.Engine/FlowController.cs