Wall Schema for Iconic CAD Workflow

family: framed_wall_panel version: 1.0

description: >

 Parametric framed wall panel with selectable framed height, module width,
 stud lumber size, stud spacing, and exterior sheathing orientation.

dimension_convention:

 nominal_width_ft_means: framed_module_width
 nominal_height_ft_means: framed_panel_height
 description: >
   Module height refers to the framed panel height (bottom plate to top plate).
   Exterior OSB sheathing may extend above the framing and is not included in
   the nominal module height.

parameters:

 nominal_width_ft:
   type: float
   unit: ft
   min: 1.0
   max: 8.0
   default: 4.0
   description: Framed module width

 nominal_height_ft:
   type: float
   unit: ft
   min: 4.0
   max: 20.0
   default: 9.0
   description: Framed panel height (bottom plate to top plate)

 stud_lumber_nominal:
   type: enum
   allowed:
     - "2x2"
     - "2x3"
     - "2x4"
     - "2x6"
     - "2x8"
     - "2x10"
     - "2x12"
   default: "2x6"
   description: Nominal stud and plate lumber size

 stud_spacing_oc_in:
   type: enum
   allowed:
     - 16
     - 24
   default: 24
   description: Stud spacing on center in inches

 osb_thickness_in:
   type: enum
   allowed:
     - 0.4375
     - 0.5
     - 0.625
     - 0.75
   default: 0.4375
   description: Exterior OSB sheathing thickness

 exterior_face:
   type: enum
   allowed:
     - north
     - south
     - east
     - west
   default: south
   description: Direction faced by the sheathed exterior side

 reference_house_orientation:
   type: enum
   allowed:
     - faces_south
   default: faces_south
   description: Global orientation convention

design_rules:

 sheathing_layers:
   type: fixed
   value: 1

 sheathing_material:
   type: fixed
   value: OSB

 sheathing_side_rule:
   type: fixed
   value: exterior_only

 standard_module_width_ft:
   type: fixed
   value: 4.0

 preferred_module_heights_ft:
   type: list
   values:
     - 8.0
     - 9.0
     - 10.0

interfaces:

 left_edge:
   type: wall_edge
   orientation: west

 right_edge:
   type: wall_edge
   orientation: east

 top_edge:
   type: wall_edge
   orientation: up

 bottom_edge:
   type: wall_edge
   orientation: down

derived_fields:

 stud_actual_thickness_in:
   source: stud_lumber_nominal

 stud_actual_depth_in:
   source: stud_lumber_nominal

 framed_panel_thickness_in:
   formula: stud_actual_depth_in

 overall_panel_thickness_in:
   formula: stud_actual_depth_in + osb_thickness_in

 panel_family_id:
   formula: >
     wall_{nominal_width_ft}x{nominal_height_ft}_{stud_lumber_nominal}_{stud_spacing_oc_in}oc_osb{osb_thickness_in}_{exterior_face}

constraints:

 - nominal_width_ft >= 1.0
 - nominal_width_ft <= 8.0
 - nominal_height_ft >= 4.0
 - nominal_height_ft <= 20.0
 - stud_spacing_oc_in in [16,24]
 - exterior_face in [north,south,east,west]