vcAction

vcAction is a container of information and user-defined properties for an action that can be executed during a simulation.

Properties

Name	Type	Access	Description
ActionContainer	vcActionContainer	R	Gets the action container of action.
ActionTime	Real	R	Gets the creation time of action.
AllProperties	List of vcProperty	R	Gets a list of all user-defined properties for the action.
Filter	String	RW	Defines a filter for limiting what resource can perform the action.
From	vcActionContainer	RW	Defines the original sender of this action. 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 and task managers.
Message	String	RW	Defines the status information about the action's execution.
Name	String	RW	Defines the name of action.
Properties	List of vcProperty	R	Gets a list of all user-defined properties created for the action after the action container was loaded.
Receiver	vcActionContainer	RW	Defines the receiver of action in its current workflow. 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	Defines the current sender of the action. Generally, this is used to clearly identify which object is responsible for sending this action.
To	vcActionContainer	RW	Defines the final target where the action should be sent to. 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.

Name	Return Type	Parameters	Description
createProperty	vcProperty	Enumeration type, String name, [Enumeration constraints]	Adds a new user-defined property of a given type and name to action, and then returns the new property. An optional constraints argument can be given to define the constraints of the property, which must be given at the time of creation. See Property constants for available property types and constraints.
deleteProperty	None	vcProperty property	Deletes a given property from action.
getProperty	vcProperty	String name	Returns the first property matching a given name in action; otherwise returns None.
send	None	[vcActionContainer container]	Sends action to the defined container. If no arguments are given, the action is broadcast to all connected Action Containers.
sendMessage	None	String message, [vcActionContainer container]	Sends action with a given message to all connected Action Containers. An optional container argument can be given to specify which action container receives the action. Generally, the message of an action defines the action's type and is used by an action container to execute the action. In some cases, the message is used to filter actions.