Component
Kind: Class
Domain: Assembly
Canonical import: from cadflow import Component
Signature
class Component(component_id: 'str', item: 'AssemblyItem', placement: 'Placement', name: 'Optional[str]' = None) -> None
Description
Assembly-local instance of a Part or subassembly.
Other public imports
from cadflow.assembly import Component
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
component_id | 'str' | yes | - | Not explicitly described in the source docstring. |
item | 'AssemblyItem' | yes | - | Not explicitly described in the source docstring. |
placement | 'Placement' | yes | - | Not explicitly described in the source docstring. |
name | 'Optional[str]' | no | None | Not explicitly described in the source docstring. |
Returns
Type: None
The source docstring does not declare additional return semantics.
Errors
The source docstring does not declare a narrower exception contract. Invalid types, values, ownership, paths, or backend state may still raise the corresponding public error.
Data fields
| Name | Type | Default |
|---|---|---|
component_id | 'str' | required |
item | 'AssemblyItem' | required |
placement | 'Placement' | required |
name | 'Optional[str]' | None |
Public members
| Member | Kind | Signature | Description |
|---|---|---|---|
to_dict | method | (self) -> 'Dict[str, Any]' | See the member signature. |
Behavior and constraints
- Instances are immutable dataclass values; update workflows return a replacement value.
Import check
from cadflow import Component