vcAction

vcAction is a container of information and user-defined properties for an action that can be executed during a simulation."; Actions are used together with vcActionContainers to send messages between components. The content and interpretation of actions are up to the Python scripts in each simulation.

See in: Overview

Module: vcBehaviors

Parent: vcObject

Children -

Referenced by: vcActionContainer.Actions, vcActionContainer.PendingActions, vcActionContainer.createAction(), vcActionContainer.createPendingAction(), ... (see more)

vcActionContainer.Actions
vcActionContainer.PendingActions
vcActionContainer.createAction()
vcActionContainer.createPendingAction()
vcActionContainer.popPending()
vcActionContainer.start()

Properties

Learn how to use properties here. The properties are also inherited from the parent class.

Name	Type	Access	Description
ActionContainer	vcActionContainer	R	Gets the container where this action was created in.
ActionTime	Real	R	Gets the creation time of this action in simulation seconds.
Filter	String	RW	Gets or sets a filter for limiting what resource can perform the action.
From	vcActionContainer	RW	Gets or sets the original sender of this action. See more Generally, this is used to track and manipulate where an action is sent from. For example, an action might be forwarded and passed to different resources (Providers) and task managers (Brokers).
Message	String	RW	Gets or sets status information about the action's execution.
Name	String	RW	Gets or sets name of this action.
Properties	vcPropertyContainer	R	Gets the properties of the action.
Receiver	vcActionContainer	RW	Gets or sets the receiver of this action in its current workflow. See more For example, an action might need to be handled at a workstation before the action is sent to a target defined by its To property.
Sender	vcActionContainer	RW	Gets or sets the current sender of this action. See more Generally, this is used to clearly identify which object is responsible for sending this action.
To	vcActionContainer	RW	Gets or sets the final target where this action should be sent to. See more In some cases, an action's final destination might be redefined to handle issues such as quality inspections, rerouting of materials, and availability of resource providers.

Methods

Learn how to use methods here. The methods are also inherited from the parent class.

Name	Return Type	Parameters	Description
delete	None	None	Removes this action from the ActionContainer and then deletes it. See more If the action is currently being processed the deletion gets scheduled but the wrapper gets invalidated immediately. Exceptions: RuntimeError: When the action has already been scheduled for deletion.
send	None	Optional Keyword[container = vcActionContainer]	Sends this action to containers for processing as a pending action. See more Parameters: Optional: container (vcActionContainer): The container to send this action to. If given, gets assigned to the Receiver property. If not given or None, this action gets broadcasted to all Providers and Brokers in the parent ActionContainer.
sendMessage	None	String message, Optional Keyword[container = vcActionContainer]	Sends this action with a given message either to specific or all connected action containers. See more Functionally the same as the send method, but also assigns the Message property. Generally, the message of an action defines the action's status (Started, Completed, Aborted) or request type (Query, Use, BackOrder) and is used by an action container to execute the action. In some cases, the message is used to filter actions. Parameters: message (str): Message to send. Optional: container (vcActionContainer): The receiving action container.