use_frame
Kind: Function
Domain: Core runtime
Canonical import: from cadflow import use_frame
Signature
def use_frame(frame: 'CoordinateFrame') -> 'Iterator[None]'
Description
Public function in the CadFlow core runtime API.
Other public imports
from cadflow.frame import use_frame
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
frame | 'CoordinateFrame' | yes | - | Not explicitly described in the source docstring. |
Returns
Type: 'Iterator[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.
Behavior and constraints
- The contract below is generated from the current public runtime signature. Check domain notes for ownership and workflow constraints.
Import check
from cadflow import use_frame