vcFlow

vcFlow is a base class for behaviors that support the transfer of components and material flow using connectors/ports.

Inherits: vcBehaviour

Hierarchy

Behaviors that inherit vcFlow do not need to have the capacity to store components rather the ability transfer/pass components in and out of their connectors.

vcFlow

vcComponentFlowProxy

vcContainer

vcComponentContainer

vcPatternContainer

vcComponentCreator

vcMotionPath

vcOneDirectionalPath

vcRoutingRule

vcTwoDirectionalPath

vcTransport

Common Properties

The following properties are common in all flow type behaviors.

Name	Type	Access	Description
CapacityAvailable	Boolean	RW	Defines if flow object will accept an incoming component. This is not the same as a logical capacity test since flow type behaviors do not to store components.
ConnectorCount	Integer	R	Gets the amount of connectors/ports in flow object.
Connectors	List of vcConnector	R	Gets a list of connectors in flow object.
Statistics	vcStatistics	RW	Defines a Statistics behavior that collects data generated by this flow during a simulation.

Behavior Specific Properties

Boolean Property Creator

Boolean Property Creator adds/sets the value of a Boolean type property in a component. It is recommended to use a Python Script to create and set properties.

Name	Type	Access	Description
Create	Boolean	RW	Defines if a property is created when no property in a component matches VariableName.
Enabled	Boolean	RW	Turns on/off the use of the creator.
Value	Boolean	RW	Defines the value of a property in a component matching VariableName.
VariableName	String	RW	Defines the name of a property to create/set in a component.

Container Filler

See vcContainerFiller for more information.

Integer Property Creator

Integer Property Creator adds/sets the value of an integer type property in a component. It is recommended to use a Python Script to create and set properties.

Name	Type	Access	Description
Create	Boolean	RW	Defines if a property is created when no property in a component matches VariableName.
Enabled	Boolean	RW	Turns on/off the use of the creator.
Value	Integer	RW	Defines the value of a property in a component matching VariableName.
VariableName	String	RW	Defines the name of a property to create/set in a component.

Real Property Creator

Real Property Creator adds/sets the value of a real number type property in a component. It is recommended to use a Python Script to create and set properties.

Name	Type	Access	Description
Create	Boolean	RW	Defines if a property is created when no property in a component matches VariableName.
Enabled	Boolean	RW	Turns on/off the use of the creator.
Value	Real	RW	Defines the value of a property in a component matching VariableName.
VariableName	String	RW	Defines the name of a property to create/set in a component.

String property Creator

String Property Creator adds/sets the value of a string type property in a component. It is recommended to use a Python Script to create and set properties.

Name	Type	Access	Description
Create	Boolean	RW	Defines if a property is created when no property in a component matches VariableName.
Enabled	Boolean	RW	Turns on/off the use of the creator.
Value	String	RW	Defines the value of a property in a component matching VariableName.
VariableName	String	RW	Defines the name of a property to create/set in a component.

Methods

Name	Return Type	Parameters	Description
checkCapacity	Boolean	vcComponent component, Integer index	Tests if the flow object has the capacity to store a given component that passes through a connector at a given index. Generally, this method is used to test the arrival of components at different connectors in order to route components effectively and avoid bottlenecks. The test passes if CapacityAvailable is set to True. In cases where the flow object has physical capacity to store components, the test depends on the container's ComponentCount and Capacity properties as well as the capacity test used by a connector. See vcConnector for more information.
getConnectorCount	Integer	None	Gets the number of connectors/ports in the flow object.
getConnector	vcConnector	Integer index or String name	Returns a connector at a given index or one that matches a given name in the flow object; otherwise returns None.
setConnection	vcConnector	Integer index, vcConnector to_connector	Connects a connector at a given index in the flow object to a given connector.