vcProduct
A product instance is a data object corresponding to a specific vcProductType and associated to a dynamic vcComponent that gives it a physical presence in the 3D world. The product type of vcProduct instance can change during its lifetime, but is always explicitly defined. Every vcProduct is always linked to exactly one dynamic vcComponent, and this linking doesn’t change during the product’s lifetime.
Properties
| Name | Type | Access | Description |
|
Properties |
List of vcProperty | R | Gets the properties that have vcProperty implementation. |
| ProductType | vcProductType | R | The type of this product. |
| Component | vcComponent | R | The component associated with this product instance. |
| CurrentProcessFlowState | vcProcessFlowState | RW | Current FlowState of the product. |
| TransportSolution | vcTransportSolution | RW |
Latest transport solution assigned to this product instance. Note that the product may already have reached the destination node and continued further by other means. |
| LastEnteredNode | vcTransportNode | R | Gets the transport node this product instance has last arrived in. Can be used to determine the product’s position along its transport solution. |
| NextProcessFlowInfo | vcNextProcessFlowInfo | RW | Information used to determine next FlowState of a product. |
| WorldPositionMatrix | vcMatrix | RW | Gets (as a copy) or sets the product instance position in world coordinates. This takes into account the defined offset between the product’s component and the product itself. |
Methods
| Name | Return Type | Parameters | Description |
| changeType | Boolean |
vcProductType newType, [Boolean deleteAttachedComponents] |
Recreates this product instance and its visualization component to match the new product type defined by newType. An optional argument deleteAttachedComponents can be used to delete any other components attached to the component of this product instance. Returns True if successful, False otherwise. Any errors messages are concatenated into a Python error message. |
| deleteProperty | None | vcProperty property | Deletes a property from this product instance. |
| enterProcess | None | vcProcessRoutine currentRoutine |
Registers start of given process for this product, updating the CurrentProcessFlowState and NextProcessFlowInfo based on the applicable flow sequence. currentRoutine - The process implementation this product enters. |
| exitCurrentProcess | None | Boolean clearNextFlowInfo |
Registers that this product has left the current process, clearing CurrentProcessFlowState. The NextProcessFlowInfo should be cleared when the product is about to enter an assembly or product bundle. clearNextFlowInfo - Whether to clear NextProcessFlowInfo. |
| getProperty | vcProperty | String propertyName | Returns a property from this product instance. |
| createProperty | vcProperty | vcProperty property | Creates a new property to this product instance. |