update_compartment
Update a compartment's dimensions, origin, or surface materials by specifying only the parameters to change, leaving others unchanged.
Instructions
Update parameters of an existing compartment.
Selects the compartment by comp_id and changes only the parameters you provide; any left as None is unchanged. Use this to attach surface materials to the first compartment (created bare by create_model) or to revise any compartment later. Any surface material id given must already exist in the model — add it first with add_material. The compartment's id itself is the selector and is not changed here.
Parameters
model_id : str Id of the model to modify. comp_id : str Id of the compartment to update. width : float or None, optional New width of the compartment as measured on the X axis from its origin. Default units: m. None leaves it unchanged. depth : float or None, optional New depth of the compartment as measured on the Y axis from its origin. Default units: m. None leaves it unchanged. height : float or None, optional New height of the compartment as measured on the Z axis from its origin. Default units: m. None leaves it unchanged. ceiling_mat_id : str or None, optional Material id defining the ceiling surface. None leaves it unchanged. ceiling_thickness : float or None, optional Thickness of the ceiling surface. Default units: m. None leaves it unchanged. wall_mat_id : str or None, optional Material id defining the wall surfaces. None leaves it unchanged. wall_thickness : float or None, optional Thickness of the wall surfaces. Default units: m. None leaves it unchanged. floor_mat_id : str or None, optional Material id defining the floor surface. None leaves it unchanged. floor_thickness : float or None, optional Thickness of the floor surface. Default units: m. None leaves it unchanged. origin_x : float or None, optional Absolute x coordinate of the lower, left, front corner of the room. Negative values are not allowed. Default units: m. None leaves it unchanged. origin_y : float or None, optional Absolute y coordinate of the lower, left, front corner of the room. Negative values are not allowed. Default units: m. None leaves it unchanged. origin_z : float or None, optional Height of the floor of the compartment with respect to the station elevation. Default units: m. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | ||
| width | No | ||
| height | No | ||
| comp_id | Yes | ||
| model_id | Yes | ||
| origin_x | No | ||
| origin_y | No | ||
| origin_z | No | ||
| wall_mat_id | No | ||
| floor_mat_id | No | ||
| ceiling_mat_id | No | ||
| wall_thickness | No | ||
| floor_thickness | No | ||
| ceiling_thickness | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |