com.anylogic.engine

Class FlowchartPort<InMessageType,OutMessageType>

java.lang.Object

com.anylogic.engine.Port<InMessageType,OutMessageType>

com.anylogic.engine.FlowchartPort<InMessageType,OutMessageType>

Type Parameters:

InMessageType - the type of messages being received by the port

OutMessageType - the type of messages being sent by the port

All Implemented Interfaces:

com.anylogic.engine.internal.Child, java.io.Serializable

Direct Known Subclasses:

FlowchartMappedPort

public abstract class FlowchartPort<InMessageType,OutMessageType>
extends Port<InMessageType,OutMessageType>

Special Port class for flowchart blocks. See also Port

Since:

7.0

Author:

AnyLogic North America, LLC https://anylogic.com

See Also:

Port, Serialized Form

Constructor Summary

Constructors

Constructor and Description
FlowchartPort(FlowchartBlock ao)

Method Summary

Modifier and Type	Method and Description
abstract long	count() Returns the number of agents passed through this port so far
FlowchartBlock	getAgent() Returns the agent that owns the port.
FlowchartBlock	getFlowchartBlockRepresentative() Returns the flowchart block which is the representative block for this port.
FlowchartBlock	getFlowchartBlockRepresentative(Agent agent) This method is internal and shouldn't be called by user.
boolean	isCannotAccept() Returns true if this (input) port can't accept agents at the current time.
abstract boolean	isError() Returns true if there is an error with this port, e.g.
boolean	isPortStateAnimated() Returns true if states of port are shown (usually by colored outline).
boolean	isReadyToExit() Returns true if there is some agent ready to exit this (output) port.
abstract void	markError() Marks this port as having error
java.lang.String	toString() Returns formatted number of agents passed through this port so far

Methods inherited from class com.anylogic.engine.Port

connect, disconnect, disconnectAndUnmapAll, getActiveObject, getDownLinks, getFlatLinks, getFullName, getName, getStatechartLinks, getUpLinks, map, map, onDestroy, receive, restoreOwner, send, unmap, unmap

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FlowchartPort

public FlowchartPort(FlowchartBlock ao)

Method Detail

getAgent

public FlowchartBlock getAgent()

Description copied from class: Port

Returns the agent that owns the port.

Overrides:

getAgent in class Port<InMessageType,OutMessageType>

Returns:

The agent owning this port.

Since:

8.0

getFlowchartBlockRepresentative

public FlowchartBlock getFlowchartBlockRepresentative()

Returns the flowchart block which is the representative block for this port.
The returned value differs from getAgent() in case when this is the port of the block from internal flowchart of some other flowchart-block.

getFlowchartBlockRepresentative

@AnyLogicInternalAPI
public FlowchartBlock getFlowchartBlockRepresentative(Agent agent)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

isPortStateAnimated

@AnyLogicInternalLibraryAPI
public boolean isPortStateAnimated()

Returns true if states of port are shown (usually by colored outline). Port state may be one of following: "open for receive", "busy", "ready to transmit" etc.

Returns:

true if port states are shown, false otherwise

Since:

8.0

markError

public abstract void markError()

Marks this port as having error

isError

public abstract boolean isError()

Returns true if there is an error with this port, e.g. "the agent at the head of the queue has spent a non-zero time at this port".

Returns:

true if there is an error with this port

isReadyToExit

public boolean isReadyToExit()

Returns true if there is some agent ready to exit this (output) port.

Since:

8.0

isCannotAccept

public boolean isCannotAccept()

Returns true if this (input) port can't accept agents at the current time.

Since:

8.0

count

public abstract long count()

Returns the number of agents passed through this port so far

Returns:

the number of agents passed through this port so far

toString

public java.lang.String toString()

Returns formatted number of agents passed through this port so far

Overrides:

toString in class Port<InMessageType,OutMessageType>

Returns:

formatted count()