vcComponentFlowProxy

vcComponentFlowProxy gives information about components attempting to enter a flow proxy, and then routes components by testing the available capacity of connected behaviors.

Inherits: vcFlow

Properties

Name Type Access Description
ComponentSignal vcComponentSignal RW Defines the signal used for signaling what component has been transferred into proxy.

This property and PortSignal should be used to determine what and where a component has entered the proxy.

DynamicConnections Boolean RW Defines if the connectors of proxy are dynamic. That is, connections will be established during a simulation by using a Python script or command.
InternalConnectorCount Integer R Gets the number of connectors in proxy.

An internal connector is always paired with an external connector, so this count will match the count for the proxy's external connectors.

PortSignal vcIntegerSignal RW Defines the signal used for signaling which connector a component used to enter proxy.

The value is the index position of the connector in the proxy's list of connectors.

Methods

Name Return Type Parameters Description
connectInternally None Integer index, vcConnector to_connector Connects an internal connector at a given index in proxy to a given connector.
createConnector vcConnector None Creates a new connector in proxy.

This creates a pair of internal and external connectors.

deleteConnector None Integer index Deletes a connector at a given index from proxy.

This deletes a pair of internal and external connectors.

getInternalConnector vcConnector Integer index Returns an internal connector at a given index in proxy.
resetConnectorPort None Integer index Resets a connector at a given index in proxy, thereby disconnecting the connector from all of its connections.