export_contact_simulation_json_rpath
Kind: Function
Domain: Simulation handoff
Canonical import: from cadflow import export_contact_simulation_json_rpath
Signature
def export_contact_simulation_json_rpath(model: 'ContactSimulationModel', path: 'str | Path', *, indent: 'int | None' = 2) -> 'Path'
Description
Public function in the CadFlow simulation handoff API.
Other public imports
from cadflow.simulation import export_contact_simulation_json_rpath
Parameters
| Name | Type | Required | Default | Source description |
|---|---|---|---|---|
model | 'ContactSimulationModel' | yes | - | Not explicitly described in the source docstring. |
path | 'str | Path' | yes | - | Not explicitly described in the source docstring. |
indent | 'int | None' | no | 2 | Not explicitly described in the source docstring. |
Returns
Type: 'Path'
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
- This operation writes an external artifact. Validate the returned path or output file before delivery.
- Serialized data is intended to remain JSON-safe and should be schema-validated when crossing trust boundaries.
Import check
from cadflow import export_contact_simulation_json_rpath