x4Trace Documentation v1.0
Loading...
Searching...
No Matches
FlowLib.Engine.Port Class Reference

Represents a port of block. More...

Public Member Functions

 Port (Block block, int number)
 Constructor.
 
void AddConnection (Connection connection)
 Adds connection to port.
 
void RemoveConnection (Connection connection)
 Removes connection.
 
void DeleteAllConnections ()
 Deletes all connection of port.
 
Connection GetConnectionByDestination (Port destinationPort)
 returns connection by destination port.
 

Properties

string Text [get, set]
 Text of port.
 
int Number [get, set]
 Number of port.
 
string PortKey [get, set]
 Key of port.
 
int Count [get]
 Count of connections.
 
Connection this[int index] [get]
 Indexer of connections.
 
Block Block [get]
 Parent block.
 
int IsDefault [get, set]
 Is default port.
 
int IsEnabled [get, set]
 Is enabled port.
 
string TypeText [get, set]
 Text of type.
 
object Tag [get, set]
 Tag.
 
decimal SamplingPercentage [get, set]
 Percentage of sampling inspection.
 

Private Attributes

int number = 0
 Number of port.
 
string text = ""
 Text of port.
 
string typeText = ""
 Text of port type.
 
string portKey = ""
 Key of port.
 
int isDefault = 0
 Is default port.
 
int isEnabled = 1
 Is enabled port.
 
decimal samplingPercentage = 0
 Percentage of sampling inspection.
 
Block block
 Parent block.
 
List< Connectionconnections
 Connection list to other blocks.
 
object tag
 Tag of port.
 

Detailed Description

Represents a port of block.

Constructor & Destructor Documentation

◆ Port()

FlowLib.Engine.Port.Port ( Block block,
int number )

Constructor.

Parameters
blockParent block.
numberNumber of block.

Member Function Documentation

◆ AddConnection()

void FlowLib.Engine.Port.AddConnection ( Connection connection)

Adds connection to port.

Parameters
connectionConnection to add.

◆ GetConnectionByDestination()

Connection FlowLib.Engine.Port.GetConnectionByDestination ( Port destinationPort)

returns connection by destination port.

Parameters
destinationPortPort of destination.
Returns
The connection.

◆ RemoveConnection()

void FlowLib.Engine.Port.RemoveConnection ( Connection connection)

Removes connection.

Parameters
connectionConnection to remove.

Property Documentation

◆ this[int index]

Connection FlowLib.Engine.Port.this[int index]
get

Indexer of connections.

Parameters
indexIndex of connection.
Returns
The connection at index.

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