vcAssemblyProductType
Assembly product type is a subcategory of a product type that represents an assembly. Assembly product type defines how an assembly is formed from multiple product types, and this information is used to create vcProduct instances with assembly structure metadata.
Inherits: vcProductType
Properties
| Name | Type | Access | Description |
| AssemblyConfigurationCount | Integer | R | Configuration count |
| RootStep | vcAssemblyStep | R | The root step of the assembly product type. The root step cannot be removed. |
| AssemblySteps | List of vcAssemblyStep | R | List of all assembly steps defined for the assembly product type. |
Methods
| Name | Return Type | Parameters | Description |
| canBeAddedTo | Boolean | vcAssemblyStep parent, vcAssemblyStep child | Returns boolean if child step can be added as a child to theparent step. If the relation already exists, returns False. |
| canBeMovedTo | Boolean | vcAssemblyStep parent, vcAssemblyStep child, Integer index | Returns boolean if child step can be moved to be a child of the parent step at a specified index. If index is outside the range of existing steps, the method checks if the step can be appended to existing steps of the parent. If child is already at the requested location within children of parent, returns False. |
| cloneStepFrom | vcAssemblyStep | vcAssemblyStep parent, vcAssemblyStep stepToClone, Integer index | Creates a copy of stepToClone and adds it as a child to parent at specified index. If index is outside the range of existing steps, the created copy is appended to existing steps of the parent. If successful, returns the cloned step. |
| createConfig | vcAssemblyConfiguration | None | Creates configuration |
| createStepTo | vcAssemblyStep |
vcAssemblyStep parent, Integer index or vcAssemblyStep parent, String name, Integer index |
Create a new assembly step and adds it as a child to parent at specified index. If index is outside the range of existing steps, the created step is appended to existing steps of the parent. If successful, returns the created step. |
| deleteConfig | None |
or Integer index |
Deletes configuration by name or index |
| deleteStep | None | vcAssemblyStep step | Deleted the given step. |
| getConfig | vcAssemblyConfiguration |
String name or Integer index |
Gets configuration by name or index |
| moveStepTo | None | vcAssemblyStep parent, vcAssemblyStep stepToMove, Integer index | Moves stepToMove and adds it as a child to parent at specified index. If index is outside the range of existing steps, the moved step is appended to existing steps of the parent. |
Events
| Name | Parameters | Description |
| OnStepAdded | vcAssemblyStep, Integer index | Triggered when a step has been added to the assembly product type. Index identifies the current location of the step within its parent. |
| OnStepRemoving | vcAssemblyStep, Integer index | Triggered when a step is being removed from the assembly product type. Index identifies the current location of the step within its parent. |