Skip to content

Core models

The site, buildings, blocks, zones, surfaces, openings and the rest of the building geometry: every model in dsbxml.core, generated from the code. Each class is available from the package root (from dsbxml import Zone).

dsbXML

Bases: BaseModel

Source code in dsbxml\core.py
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class dsbXML(BaseModel):
    model_config = ConfigDict(populate_by_name=True)

    name: str = attr()
    date: datetime.date = attr()
    version: str = attr()
    objects: str = attr()
    site: Site | None = element(tag="Site", default=None)

    @classmethod
    def from_xml(cls, source: str | bytes) -> dsbXML:  # pylint: disable=arguments-differ
        from lxml import etree

        if isinstance(source, (str, bytes)):
            # huge_tree: large models can contain a single text node over
            # libxml2's default 10 MB limit, which it otherwise refuses with
            # "xmlSAX2Characters: huge text node". DesignBuilder's own files
            # are trusted input, so lifting the limit is acceptable here.
            root = etree.fromstring(source, parser=etree.XMLParser(huge_tree=True))
        else:
            root = source

        try:
            instance = super().from_xml_tree(root)
        except ValidationError as exc:
            raise ModelValidationError(exc, root=root) from exc
        return instance

    def to_xml(self, **kwargs) -> str | bytes:
        """The model as UTF-8 XML with a declaration: bytes, or str for encoding="unicode".

        The tree is written once; it used to be written, parsed back and written again only
        to set the root's tag.
        """
        from lxml import etree

        tree_args = ("skip_empty", "exclude_none", "exclude_unset")
        tree = {k: kwargs.pop(k) for k in tree_args if k in kwargs}
        as_text = kwargs.pop("encoding", None) in ("unicode", str)
        root = self.to_xml_tree(**tree)
        root.tag = "dsbXML"
        for el in root.iter():
            if el.text == "":  # written <X/>, as a parsed tree has it
                el.text = None
        kwargs.setdefault("xml_declaration", True)
        out = etree.tostring(root, encoding="UTF-8", **kwargs)
        return out.decode("UTF-8") if as_text else bytes(out)

model_config = ConfigDict(populate_by_name=True) class-attribute instance-attribute

name = attr() class-attribute instance-attribute

date = attr() class-attribute instance-attribute

version = attr() class-attribute instance-attribute

objects = attr() class-attribute instance-attribute

site = element(tag='Site', default=None) class-attribute instance-attribute

from_xml(source) classmethod

Source code in dsbxml\core.py
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@classmethod
def from_xml(cls, source: str | bytes) -> dsbXML:  # pylint: disable=arguments-differ
    from lxml import etree

    if isinstance(source, (str, bytes)):
        # huge_tree: large models can contain a single text node over
        # libxml2's default 10 MB limit, which it otherwise refuses with
        # "xmlSAX2Characters: huge text node". DesignBuilder's own files
        # are trusted input, so lifting the limit is acceptable here.
        root = etree.fromstring(source, parser=etree.XMLParser(huge_tree=True))
    else:
        root = source

    try:
        instance = super().from_xml_tree(root)
    except ValidationError as exc:
        raise ModelValidationError(exc, root=root) from exc
    return instance

to_xml(**kwargs)

The model as UTF-8 XML with a declaration: bytes, or str for encoding="unicode".

The tree is written once; it used to be written, parsed back and written again only to set the root's tag.

Source code in dsbxml\core.py
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def to_xml(self, **kwargs) -> str | bytes:
    """The model as UTF-8 XML with a declaration: bytes, or str for encoding="unicode".

    The tree is written once; it used to be written, parsed back and written again only
    to set the root's tag.
    """
    from lxml import etree

    tree_args = ("skip_empty", "exclude_none", "exclude_unset")
    tree = {k: kwargs.pop(k) for k in tree_args if k in kwargs}
    as_text = kwargs.pop("encoding", None) in ("unicode", str)
    root = self.to_xml_tree(**tree)
    root.tag = "dsbXML"
    for el in root.iter():
        if el.text == "":  # written <X/>, as a parsed tree has it
            el.text = None
    kwargs.setdefault("xml_declaration", True)
    out = etree.tostring(root, encoding="UTF-8", **kwargs)
    return out.decode("UTF-8") if as_text else bytes(out)

Site

Bases: BaseModel

Source code in dsbxml\core.py
67
68
69
70
71
72
73
74
75
76
77
78
79
class Site(BaseModel):
    count: int = attr()
    handle: int = attr()
    attributes: NameAttributes = element(
        tag="Attributes", default_factory=lambda: NameAttributes()
    )
    tables: Tables | None = element(tag="Tables", default=None)
    assembly_library: AssemblyLibrary | None = element(tag="AssemblyLibrary", default=None)
    buildings: Buildings | None = element(tag="Buildings", default=None)

    @field_serializer("handle")
    def serialize_handle(self, _) -> int:
        return current_site_handle()

count = attr() class-attribute instance-attribute

handle = attr() class-attribute instance-attribute

attributes = element(tag='Attributes', default_factory=(lambda: NameAttributes())) class-attribute instance-attribute

tables = element(tag='Tables', default=None) class-attribute instance-attribute

assembly_library = element(tag='AssemblyLibrary', default=None) class-attribute instance-attribute

buildings = element(tag='Buildings', default=None) class-attribute instance-attribute

serialize_handle(_)

Source code in dsbxml\core.py
77
78
79
@field_serializer("handle")
def serialize_handle(self, _) -> int:
    return current_site_handle()

AssemblyLibrary

Bases: BaseModel

Source code in dsbxml\core.py
82
83
84
85
86
87
88
89
90
91
92
93
94
class AssemblyLibrary(BaseModel):
    assemblyHandle: int = attr()
    # DesignBuilder writes <AssemblyLibrary assemblyHandle="0"/> with no
    # <Assembly> children when a model has no assemblies.
    assembly: list[Assembly] = element(tag="Assembly", default_factory=list)

    @field_serializer("assemblyHandle")
    def serialize_assembly_handle(self, value: int) -> int:
        # The library's handle is the next free assembly handle, so it follows
        # the assemblies it holds. A library without assemblies keeps its own.
        if not self.assembly:
            return value
        return max(item.assemblyHandle for item in self.assembly) + 1

assemblyHandle = attr() class-attribute instance-attribute

assembly = element(tag='Assembly', default_factory=list) class-attribute instance-attribute

serialize_assembly_handle(value)

Source code in dsbxml\core.py
88
89
90
91
92
93
94
@field_serializer("assemblyHandle")
def serialize_assembly_handle(self, value: int) -> int:
    # The library's handle is the next free assembly handle, so it follows
    # the assemblies it holds. A library without assemblies keeps its own.
    if not self.assembly:
        return value
    return max(item.assemblyHandle for item in self.assembly) + 1

Assembly

Bases: BaseModel

Source code in dsbxml\core.py
 97
 98
 99
100
101
102
103
class Assembly(BaseModel):
    assemblyHandle: int = attr()
    componentBlockHandle: int = attr()
    reference: str = attr()
    handle_point: HandlePoint = element(tag="HandlePoint")
    component_blocks: ComponentBlocks = element(tag="ComponentBlocks")
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

assemblyHandle = attr() class-attribute instance-attribute

componentBlockHandle = attr() class-attribute instance-attribute

reference = attr() class-attribute instance-attribute

handle_point = element(tag='HandlePoint') class-attribute instance-attribute

component_blocks = element(tag='ComponentBlocks') class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

ComponentBlocks

Bases: BaseModel

Source code in dsbxml\core.py
106
107
class ComponentBlocks(BaseModel):
    component_block: list[ComponentBlock] = element(tag="ComponentBlock", default_factory=list)

component_block = element(tag='ComponentBlock', default_factory=list) class-attribute instance-attribute

ComponentBlock

Bases: BaseModel

Source code in dsbxml\core.py
110
111
112
class ComponentBlock(BaseModel):
    type: str = attr()
    body: Body = element(tag="Body")

type = attr() class-attribute instance-attribute

body = element(tag='Body') class-attribute instance-attribute

Body

Bases: BaseModel

Source code in dsbxml\core.py
115
116
117
118
119
120
121
122
123
124
125
126
class Body(BaseModel):
    volume: XSDFloat = attr()
    extrusionHeight: XSDFloat = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    vertices: Vertices = element(tag="Vertices")
    surfaces: Surfaces = element(tag="Surfaces")
    void_perimeter_list: VoidPerimeterList | None = element(
        tag="VoidPerimeterList", default=None
    )
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

volume = attr() class-attribute instance-attribute

extrusionHeight = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

vertices = element(tag='Vertices') class-attribute instance-attribute

surfaces = element(tag='Surfaces') class-attribute instance-attribute

void_perimeter_list = element(tag='VoidPerimeterList', default=None) class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

Surfaces

Bases: BaseModel

Source code in dsbxml\core.py
129
130
class Surfaces(BaseModel):
    surface: list[Surface] = element(tag="Surface")

surface = element(tag='Surface') class-attribute instance-attribute

Surface

Bases: BaseModel

Source code in dsbxml\core.py
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
class Surface(BaseModel):
    type: str = attr()
    area: XSDFloat = attr()
    alpha: XSDFloat = attr()
    phi: XSDFloat = attr()
    # name="defaultOpenings": the real attribute casing in DesignBuilder XML
    defaultopenings: str | None = attr(name="defaultOpenings", default=None)
    adjacentPartitionHandle: int = attr()
    thickness: XSDFloat = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    vertex_indices: str | None = element(tag="VertexIndices", default=None)
    # Always present in real files, empty when the surface has no holes; an
    # empty string is written back as an empty element (the schema requires it).
    hole_indices: str = element(tag="HoleIndices", default="")
    openings: Openings | None = element(tag="Openings", default=None)
    adjacencies: Adjacencies | None = element(tag="Adjacencies", default=None)
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

type = attr() class-attribute instance-attribute

area = attr() class-attribute instance-attribute

alpha = attr() class-attribute instance-attribute

phi = attr() class-attribute instance-attribute

defaultopenings = attr(name='defaultOpenings', default=None) class-attribute instance-attribute

adjacentPartitionHandle = attr() class-attribute instance-attribute

thickness = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

vertex_indices = element(tag='VertexIndices', default=None) class-attribute instance-attribute

hole_indices = element(tag='HoleIndices', default='') class-attribute instance-attribute

openings = element(tag='Openings', default=None) class-attribute instance-attribute

adjacencies = element(tag='Adjacencies', default=None) class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

Openings

Bases: BaseModel

Source code in dsbxml\core.py
154
155
class Openings(BaseModel):
    opening: list[Opening] = element(tag="Opening", default_factory=list)

opening = element(tag='Opening', default_factory=list) class-attribute instance-attribute

Opening

Bases: BaseModel

Source code in dsbxml\core.py
158
159
160
161
162
163
class Opening(BaseModel):
    type: str = attr()
    polygon: Polygon = element(tag="Polygon")
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)
    # Real files always have a <SegmentList> here: empty, with lines, or with a CFD boundary.
    segment_list: OpeningSegmentList | None = element(tag="SegmentList", default=None)

type = attr() class-attribute instance-attribute

polygon = element(tag='Polygon') class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

segment_list = element(tag='SegmentList', default=None) class-attribute instance-attribute

Adjacencies

Bases: BaseModel

Source code in dsbxml\core.py
166
167
class Adjacencies(BaseModel):
    adjacency: list[Adjacency] = element(tag="Adjacency", default_factory=list)

adjacency = element(tag='Adjacency', default_factory=list) class-attribute instance-attribute

Adjacency

Bases: BaseModel

Source code in dsbxml\core.py
170
171
172
173
174
175
176
class Adjacency(BaseModel):
    type: str = attr()
    adjacencyDistance: XSDFloat = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    adjacency_polygon_list: AdjacencyPolygonList = element(tag="AdjacencyPolygonList")

type = attr() class-attribute instance-attribute

adjacencyDistance = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

adjacency_polygon_list = element(tag='AdjacencyPolygonList') class-attribute instance-attribute

AdjacencyPolygonList

Bases: BaseModel

Source code in dsbxml\core.py
179
180
class AdjacencyPolygonList(BaseModel):
    polygon: list[Polygon] = element(tag="Polygon")

polygon = element(tag='Polygon') class-attribute instance-attribute

Buildings

Bases: BaseModel

Source code in dsbxml\core.py
183
184
185
186
187
188
189
190
class Buildings(BaseModel):
    numberOfBuildings: int | None = attr(default=None)
    building: list[Building] = element(tag="Building", default_factory=list)

    @field_validator("numberOfBuildings", mode="before")
    @classmethod
    def _coerce_empty_int(cls, v):
        return None if v == "" else v

numberOfBuildings = attr(default=None) class-attribute instance-attribute

building = element(tag='Building', default_factory=list) class-attribute instance-attribute

Building

Bases: BaseModel

Source code in dsbxml\core.py
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
class Building(BaseModel):
    currentComponentBlockHandle: int = attr()
    currentAssemblyInstanceHandle: int = attr()
    currentPlaneHandle: int = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    building_blocks: BuildingBlocks | None = element(tag="BuildingBlocks", default=None)
    component_blocks: ComponentBlocks | None = element(tag="ComponentBlocks", default=None)
    assembly_instances: AssemblyInstances | None = element(
        tag="AssemblyInstances", default=None
    )
    profile_outlines: ProfileOutlines | None = element(tag="ProfileOutlines", default=None)
    construction_lines: ConstructionLines | None = element(
        tag="ConstructionLines", default=None
    )
    planes: Planes | None = element(tag="Planes", default=None)
    hvac_network: HVACNetwork | None = element(tag="HVACNetwork", default=None)
    bookmark_buildings: BookmarkBuildings | None = element(
        tag="BookmarkBuildings", default=None
    )
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

currentComponentBlockHandle = attr() class-attribute instance-attribute

currentAssemblyInstanceHandle = attr() class-attribute instance-attribute

currentPlaneHandle = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

building_blocks = element(tag='BuildingBlocks', default=None) class-attribute instance-attribute

component_blocks = element(tag='ComponentBlocks', default=None) class-attribute instance-attribute

assembly_instances = element(tag='AssemblyInstances', default=None) class-attribute instance-attribute

profile_outlines = element(tag='ProfileOutlines', default=None) class-attribute instance-attribute

construction_lines = element(tag='ConstructionLines', default=None) class-attribute instance-attribute

planes = element(tag='Planes', default=None) class-attribute instance-attribute

hvac_network = element(tag='HVACNetwork', default=None) class-attribute instance-attribute

bookmark_buildings = element(tag='BookmarkBuildings', default=None) class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

BuildingBlocks

Bases: BaseModel

Source code in dsbxml\core.py
217
218
219
class BuildingBlocks(BaseModel):
    # The schema allows <BuildingBlocks/> with no blocks (minOccurs="0").
    building_block: list[BuildingBlock] = element(tag="BuildingBlock", default_factory=list)

building_block = element(tag='BuildingBlock', default_factory=list) class-attribute instance-attribute

BuildingBlock

Bases: BaseModel

Source code in dsbxml\core.py
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
class BuildingBlock(BaseModel):
    type: str = attr()
    height: XSDFloat = attr()
    roofSlope: XSDFloat = attr()
    roofOverlap: XSDFloat = attr()
    roofType: str = attr()
    wallSlope: XSDFloat = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    component_blocks: ComponentBlocks | None = element(tag="ComponentBlocks", default=None)
    cfd_fans: CFDFans | None = element(tag="CFDFans", default=None)
    assembly_instances: AssemblyInstances | None = element(
        tag="AssemblyInstances", default=None
    )
    profile_outlines: ProfileOutlines | None = element(tag="ProfileOutlines", default=None)
    internal_partitions: InternalPartitions | None = element(
        tag="InternalPartitions", default=None
    )
    void_bodies: VoidBodies | None = element(tag="VoidBodies", default=None)
    zones: Zones | None = element(tag="Zones", default=None)
    profile_body: ProfileBody | None = element(tag="ProfileBody", default=None)
    perimeter: Perimeter | None = element(tag="Perimeter", default=None)
    base_profile_body: BaseProfileBody | None = element(tag="BaseProfileBody", default=None)
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

type = attr() class-attribute instance-attribute

height = attr() class-attribute instance-attribute

roofSlope = attr() class-attribute instance-attribute

roofOverlap = attr() class-attribute instance-attribute

roofType = attr() class-attribute instance-attribute

wallSlope = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

component_blocks = element(tag='ComponentBlocks', default=None) class-attribute instance-attribute

cfd_fans = element(tag='CFDFans', default=None) class-attribute instance-attribute

assembly_instances = element(tag='AssemblyInstances', default=None) class-attribute instance-attribute

profile_outlines = element(tag='ProfileOutlines', default=None) class-attribute instance-attribute

internal_partitions = element(tag='InternalPartitions', default=None) class-attribute instance-attribute

void_bodies = element(tag='VoidBodies', default=None) class-attribute instance-attribute

zones = element(tag='Zones', default=None) class-attribute instance-attribute

profile_body = element(tag='ProfileBody', default=None) class-attribute instance-attribute

perimeter = element(tag='Perimeter', default=None) class-attribute instance-attribute

base_profile_body = element(tag='BaseProfileBody', default=None) class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

InternalPartitions

Bases: BaseModel

Source code in dsbxml\core.py
249
250
251
252
class InternalPartitions(BaseModel):
    internal_partition: list[InternalPartition] = element(
        tag="InternalPartition", default_factory=list
    )

internal_partition = element(tag='InternalPartition', default_factory=list) class-attribute instance-attribute

InternalPartition

Bases: BaseModel

Source code in dsbxml\core.py
255
256
257
258
259
260
261
262
263
264
class InternalPartition(BaseModel):
    type: str = attr()
    height: XSDFloat = attr()
    area: XSDFloat = attr()
    floatingPartition: bool = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    start_point: WrappedPoint3D | None = element(tag="StartPoint", default=None)
    end_point: WrappedPoint3D | None = element(tag="EndPoint", default=None)

type = attr() class-attribute instance-attribute

height = attr() class-attribute instance-attribute

area = attr() class-attribute instance-attribute

floatingPartition = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

start_point = element(tag='StartPoint', default=None) class-attribute instance-attribute

end_point = element(tag='EndPoint', default=None) class-attribute instance-attribute

Zones

Bases: BaseModel

Source code in dsbxml\core.py
267
268
269
class Zones(BaseModel):
    # The schema allows <Zones/> with no zones (minOccurs="0").
    zone: list[Zone] = element(tag="Zone", default_factory=list)

zone = element(tag='Zone', default_factory=list) class-attribute instance-attribute

Zone

Bases: BaseModel

Source code in dsbxml\core.py
272
273
274
275
276
277
278
279
280
281
282
class Zone(BaseModel):
    parentZoneHandle: str = attr()
    inheritedZoneHandle: str = attr()
    planExtrusion: str = attr()
    innerSurfaceMode: str = attr()
    body: Body = element(tag="Body")
    light_sensor_one: LightSensorOne = element(tag="LightSensorOne")
    light_sensor_two: LightSensorTwo = element(tag="LightSensorTwo")
    label_position: WrappedPoint3D | None = element(tag="LabelPosition", default=None)
    polygon: Polygon | None = element(tag="Polygon", default=None)
    inner_surface_body: InnerSurfaceBody | None = element(tag="InnerSurfaceBody", default=None)

parentZoneHandle = attr() class-attribute instance-attribute

inheritedZoneHandle = attr() class-attribute instance-attribute

planExtrusion = attr() class-attribute instance-attribute

innerSurfaceMode = attr() class-attribute instance-attribute

body = element(tag='Body') class-attribute instance-attribute

light_sensor_one = element(tag='LightSensorOne') class-attribute instance-attribute

light_sensor_two = element(tag='LightSensorTwo') class-attribute instance-attribute

label_position = element(tag='LabelPosition', default=None) class-attribute instance-attribute

polygon = element(tag='Polygon', default=None) class-attribute instance-attribute

inner_surface_body = element(tag='InnerSurfaceBody', default=None) class-attribute instance-attribute

ProfileBody

Bases: BaseModel

Source code in dsbxml\core.py
285
286
287
288
class ProfileBody(BaseModel):
    elementSlope: XSDFloat = attr()
    roofOverlap: XSDFloat = attr()
    body: Body = element(tag="Body")

elementSlope = attr() class-attribute instance-attribute

roofOverlap = attr() class-attribute instance-attribute

body = element(tag='Body') class-attribute instance-attribute

Perimeter

Bases: BaseModel

Source code in dsbxml\core.py
291
292
class Perimeter(BaseModel):
    polygon: Polygon = element(tag="Polygon")

polygon = element(tag='Polygon') class-attribute instance-attribute

BaseProfileBody

Bases: BaseModel

Source code in dsbxml\core.py
295
296
class BaseProfileBody(BaseModel):
    profile_body: ProfileBody = element(tag="ProfileBody")

profile_body = element(tag='ProfileBody') class-attribute instance-attribute

Polygon

Bases: BaseModel

Source code in dsbxml\core.py
299
300
301
302
303
304
305
class Polygon(BaseModel):
    auxiliaryType: str = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    vertices: Vertices | None = element(tag="Vertices", default=None)
    polygon_holes: PolygonHoles | None = element(tag="PolygonHoles", default=None)

auxiliaryType = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

vertices = element(tag='Vertices', default=None) class-attribute instance-attribute

polygon_holes = element(tag='PolygonHoles', default=None) class-attribute instance-attribute

PolygonHoles

Bases: BaseModel

Source code in dsbxml\core.py
308
309
class PolygonHoles(BaseModel):
    polygon_hole: list[PolygonHole] = element(tag="PolygonHole", default_factory=list)

polygon_hole = element(tag='PolygonHole', default_factory=list) class-attribute instance-attribute

PolygonHole

Bases: BaseModel

Source code in dsbxml\core.py
312
313
314
315
316
class PolygonHole(BaseModel):
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    vertices: Vertices = element(tag="Vertices")

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

vertices = element(tag='Vertices') class-attribute instance-attribute

LightSensorOne

Bases: BaseModel

Source code in dsbxml\core.py
319
320
321
class LightSensorOne(BaseModel):
    index: int = attr()
    Point3d: str = element(tag="Point3D")

index = attr() class-attribute instance-attribute

Point3d = element(tag='Point3D') class-attribute instance-attribute

LightSensorTwo

Bases: BaseModel

Source code in dsbxml\core.py
324
325
326
class LightSensorTwo(BaseModel):
    index: int = attr()
    Point3d: str = element(tag="Point3D")

index = attr() class-attribute instance-attribute

Point3d = element(tag='Point3D') class-attribute instance-attribute

InnerSurfaceBody

Bases: BaseModel

Source code in dsbxml\core.py
329
330
class InnerSurfaceBody(BaseModel):
    body: Body = element(tag="Body")

body = element(tag='Body') class-attribute instance-attribute

BookmarkBuildings

Bases: BaseModel

Source code in dsbxml\core.py
333
334
class BookmarkBuildings(BaseModel):
    numberOfBuildings: int = attr()

numberOfBuildings = attr() class-attribute instance-attribute

ConstructionLines

Bases: BaseModel

Source code in dsbxml\core.py
337
338
339
340
class ConstructionLines(BaseModel):
    construction_line: list[ConstructionLine] = element(
        tag="ConstructionLine", default_factory=list
    )

construction_line = element(tag='ConstructionLine', default_factory=list) class-attribute instance-attribute

ConstructionLine

Bases: BaseModel

Source code in dsbxml\core.py
343
344
345
class ConstructionLine(BaseModel):
    line: Line = element(tag="Line")
    planes: CPlanes = element(tag="Planes")

line = element(tag='Line') class-attribute instance-attribute

planes = element(tag='Planes') class-attribute instance-attribute

CPlanes

Bases: BaseModel

Source code in dsbxml\core.py
348
349
class CPlanes(BaseModel):
    polygon: list[Polygon] = element(tag="Polygon")

polygon = element(tag='Polygon') class-attribute instance-attribute

Planes

Bases: BaseModel

Source code in dsbxml\core.py
352
353
class Planes(BaseModel):
    plane: list[Plane] = element(tag="Plane", default_factory=list)

plane = element(tag='Plane', default_factory=list) class-attribute instance-attribute

Plane

Bases: BaseModel

Source code in dsbxml\core.py
356
357
358
359
class Plane(BaseModel):
    type: int = attr()
    polygon: Polygon = element(tag="Polygon")
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

type = attr() class-attribute instance-attribute

polygon = element(tag='Polygon') class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

AssemblyInstances

Bases: BaseModel

Source code in dsbxml\core.py
362
363
364
365
class AssemblyInstances(BaseModel):
    assembly_instance: list[AssemblyInstance] = element(
        tag="AssemblyInstance", default_factory=list
    )

assembly_instance = element(tag='AssemblyInstance', default_factory=list) class-attribute instance-attribute

AssemblyInstance

Bases: BaseModel

Source code in dsbxml\core.py
368
369
370
371
372
373
374
375
376
377
378
class AssemblyInstance(BaseModel):
    assemblyHandle: int = attr()
    reflected: int = attr()
    active: int = attr()
    object_ids: Annotated[ObjectIDs, Field(default_factory=ObjectIDs)] = element(
        tag="ObjectIDs"
    )
    assembly_instance_transformation_matrix: AssemblyInstanceTransformationMatrix = element(
        tag="AssemblyInstanceTransformationMatrix"
    )
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

assemblyHandle = attr() class-attribute instance-attribute

reflected = attr() class-attribute instance-attribute

active = attr() class-attribute instance-attribute

object_ids = element(tag='ObjectIDs') class-attribute instance-attribute

assembly_instance_transformation_matrix = element(tag='AssemblyInstanceTransformationMatrix') class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

AssemblyInstanceTransformationMatrix

Bases: BaseModel

Source code in dsbxml\core.py
381
382
class AssemblyInstanceTransformationMatrix(BaseModel):
    matrix: Matrix = element(tag="Matrix")

matrix = element(tag='Matrix') class-attribute instance-attribute

Matrix

Bases: BaseModel

Source code in dsbxml\core.py
385
386
class Matrix(BaseModel):
    matrix_row: list[str] = element(tag="MatrixRow")

matrix_row = element(tag='MatrixRow') class-attribute instance-attribute

ProfileOutlines

Bases: BaseModel

Source code in dsbxml\core.py
389
390
class ProfileOutlines(BaseModel):
    profile_outline: list[ProfileOutline] = element(tag="ProfileOutline", default_factory=list)

profile_outline = element(tag='ProfileOutline', default_factory=list) class-attribute instance-attribute

ProfileOutline

Bases: BaseModel

Source code in dsbxml\core.py
393
394
class ProfileOutline(BaseModel):
    body: Body = element(tag="Body")

body = element(tag='Body') class-attribute instance-attribute

VoidBodies

Bases: BaseModel

Source code in dsbxml\core.py
397
398
class VoidBodies(BaseModel):
    void_body: list[VoidBody] = element(tag="VoidBody", default_factory=list)

void_body = element(tag='VoidBody', default_factory=list) class-attribute instance-attribute

VoidBody

Bases: BaseModel

Source code in dsbxml\core.py
401
402
class VoidBody(BaseModel):
    profile_body: ProfileBody = element(tag="ProfileBody")

profile_body = element(tag='ProfileBody') class-attribute instance-attribute

VoidPerimeterList

Bases: BaseModel

Source code in dsbxml\core.py
405
406
class VoidPerimeterList(BaseModel):
    polygon: list[Polygon] = element(tag="Polygon", default_factory=list)

polygon = element(tag='Polygon', default_factory=list) class-attribute instance-attribute

CFDFans

Bases: BaseModel

Source code in dsbxml\core.py
409
410
class CFDFans(BaseModel):
    cfd_fan: list[CFDFan] = element(tag="CFDFan", default_factory=list)

cfd_fan = element(tag='CFDFan', default_factory=list) class-attribute instance-attribute

CFDFan

Bases: BaseModel

Source code in dsbxml\core.py
413
414
class CFDFan(BaseModel):
    component_block: ComponentBlock = element(tag="ComponentBlock")

component_block = element(tag='ComponentBlock') class-attribute instance-attribute

CFDBoundary

Bases: BaseModel

Source code in dsbxml\core.py
417
418
419
420
421
422
423
424
425
426
427
428
429
class CFDBoundary(BaseModel):
    type: str = attr()
    polygon: Polygon = element(tag="Polygon")
    cfd_boundary_settings: CFDBoundarySettings = element(tag="CFDBoundarySettings")
    minimum_refinement_region_point: WrappedPoint3D = element(
        tag="MinimumRefinementRegionPoint"
    )
    maximum_refinement_region_point: WrappedPoint3D = element(
        tag="MaximumRefinementRegionPoint"
    )
    # Empty in every file seen (whitespace only); what it lists when filled is not known.
    cfd_boundary_component_list: str = element(tag="CFDBoundaryComponentList", default="")
    attributes: KeyAttributes | None = element(tag="Attributes", default=None)

type = attr() class-attribute instance-attribute

polygon = element(tag='Polygon') class-attribute instance-attribute

cfd_boundary_settings = element(tag='CFDBoundarySettings') class-attribute instance-attribute

minimum_refinement_region_point = element(tag='MinimumRefinementRegionPoint') class-attribute instance-attribute

maximum_refinement_region_point = element(tag='MaximumRefinementRegionPoint') class-attribute instance-attribute

cfd_boundary_component_list = element(tag='CFDBoundaryComponentList', default='') class-attribute instance-attribute

attributes = element(tag='Attributes', default=None) class-attribute instance-attribute

OpeningSegmentList

Bases: SegmentList

An opening's : lines, or the CFD boundary drawn on the opening.

HVAC_Zones_Coloured.xml (DesignBuilder 7) has twelve openings whose holds a with its settings as child elements.

Source code in dsbxml\core.py
432
433
434
435
436
437
438
439
class OpeningSegmentList(SegmentList):
    """An opening's <SegmentList>: lines, or the CFD boundary drawn on the opening.

    HVAC_Zones_Coloured.xml (DesignBuilder 7) has twelve openings whose <SegmentList> holds a
    <CFDBoundary> with its settings as child elements.
    """

    cfd_boundary: CFDBoundary | None = element(tag="CFDBoundary", default=None)

cfd_boundary = element(tag='CFDBoundary', default=None) class-attribute instance-attribute

CFDBoundarySettings

Bases: BaseModel

Source code in dsbxml\core.py
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
class CFDBoundarySettings(BaseModel):
    # Child elements, as DesignBuilder writes them (HVAC_Zones_Coloured.xml).
    temperature: XSDFloat = element(tag="Temperature")
    flowRate: XSDFloat = element(tag="FlowRate")
    xDirectionDischargeAngle: XSDFloat = element(tag="XDirectionDischargeAngle")
    yDirectionDischargeAngle: XSDFloat = element(tag="YDirectionDischargeAngle")
    multiWayDiffuserDischargeAngle: XSDFloat = element(tag="MultiWayDiffuserDischargeAngle")
    twoWayDiffuserDischargeDirection: int = element(tag="TwoWayDiffuserDischargeDirection")
    minimumDischargeVelocity: XSDFloat = element(tag="MinimumDischargeVelocity")
    actualDischargeVelocity: XSDFloat = element(tag="ActualDischargeVelocity")
    heatFlux: XSDFloat = element(tag="HeatFlux")
    pressure: XSDFloat = element(tag="Pressure")
    pressureType: int = element(tag="PressureType")
    moistureSource: XSDFloat = element(tag="MoistureSource")
    contaminantSource: XSDFloat = element(tag="ContaminantSource")
    relativeHumidity: XSDFloat = element(tag="RelativeHumidity")
    nonOrthoElementWidth: XSDFloat = element(tag="NonOrthoElementWidth")
    nonOrthoElementHeight: XSDFloat = element(tag="NonOrthoElementHeight")
    nonOrthoFaceOffset: XSDFloat = element(tag="NonOrthoFaceOffset")
    nonOrthoElementXSpacing: XSDFloat = element(tag="NonOrthoElementXSpacing")
    nonOrthoElementYSpacing: XSDFloat = element(tag="NonOrthoElementYSpacing")
    nonOrthoElementXEdgeOffset: XSDFloat = element(tag="NonOrthoElementXEdgeOffset")
    nonOrthoElementYEdgeOffset: XSDFloat = element(tag="NonOrthoElementYEdgeOffset")
    diffuser_element_dimension: XSDFloat = element(tag="DiffuserElementDimension")
    refinement_region_distance: XSDFloat = element(tag="RefinementRegionDistance")
    refinement_region_level: int = element(tag="RefinementRegionLevel")

temperature = element(tag='Temperature') class-attribute instance-attribute

flowRate = element(tag='FlowRate') class-attribute instance-attribute

xDirectionDischargeAngle = element(tag='XDirectionDischargeAngle') class-attribute instance-attribute

yDirectionDischargeAngle = element(tag='YDirectionDischargeAngle') class-attribute instance-attribute

multiWayDiffuserDischargeAngle = element(tag='MultiWayDiffuserDischargeAngle') class-attribute instance-attribute

twoWayDiffuserDischargeDirection = element(tag='TwoWayDiffuserDischargeDirection') class-attribute instance-attribute

minimumDischargeVelocity = element(tag='MinimumDischargeVelocity') class-attribute instance-attribute

actualDischargeVelocity = element(tag='ActualDischargeVelocity') class-attribute instance-attribute

heatFlux = element(tag='HeatFlux') class-attribute instance-attribute

pressure = element(tag='Pressure') class-attribute instance-attribute

pressureType = element(tag='PressureType') class-attribute instance-attribute

moistureSource = element(tag='MoistureSource') class-attribute instance-attribute

contaminantSource = element(tag='ContaminantSource') class-attribute instance-attribute

relativeHumidity = element(tag='RelativeHumidity') class-attribute instance-attribute

nonOrthoElementWidth = element(tag='NonOrthoElementWidth') class-attribute instance-attribute

nonOrthoElementHeight = element(tag='NonOrthoElementHeight') class-attribute instance-attribute

nonOrthoFaceOffset = element(tag='NonOrthoFaceOffset') class-attribute instance-attribute

nonOrthoElementXSpacing = element(tag='NonOrthoElementXSpacing') class-attribute instance-attribute

nonOrthoElementYSpacing = element(tag='NonOrthoElementYSpacing') class-attribute instance-attribute

nonOrthoElementXEdgeOffset = element(tag='NonOrthoElementXEdgeOffset') class-attribute instance-attribute

nonOrthoElementYEdgeOffset = element(tag='NonOrthoElementYEdgeOffset') class-attribute instance-attribute

diffuser_element_dimension = element(tag='DiffuserElementDimension') class-attribute instance-attribute

refinement_region_distance = element(tag='RefinementRegionDistance') class-attribute instance-attribute

refinement_region_level = element(tag='RefinementRegionLevel') class-attribute instance-attribute