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 | |
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 | |
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 | |
Site
¶
Bases: BaseModel
Source code in dsbxml\core.py
67 68 69 70 71 72 73 74 75 76 77 78 79 | |
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 | |
AssemblyLibrary
¶
Bases: BaseModel
Source code in dsbxml\core.py
82 83 84 85 86 87 88 89 90 91 92 93 94 | |
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 | |
Assembly
¶
Bases: BaseModel
Source code in dsbxml\core.py
97 98 99 100 101 102 103 | |
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
¶
ComponentBlock
¶
Body
¶
Bases: BaseModel
Source code in dsbxml\core.py
115 116 117 118 119 120 121 122 123 124 125 126 | |
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
¶
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 | |
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
¶
Opening
¶
Bases: BaseModel
Source code in dsbxml\core.py
158 159 160 161 162 163 | |
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
¶
Adjacency
¶
Bases: BaseModel
Source code in dsbxml\core.py
170 171 172 173 174 175 176 | |
AdjacencyPolygonList
¶
Buildings
¶
Bases: BaseModel
Source code in dsbxml\core.py
183 184 185 186 187 188 189 190 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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
¶
Zone
¶
Bases: BaseModel
Source code in dsbxml\core.py
272 273 274 275 276 277 278 279 280 281 282 | |
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 | |
Perimeter
¶
BaseProfileBody
¶
Polygon
¶
Bases: BaseModel
Source code in dsbxml\core.py
299 300 301 302 303 304 305 | |
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
¶
PolygonHole
¶
Bases: BaseModel
Source code in dsbxml\core.py
312 313 314 315 316 | |
LightSensorOne
¶
LightSensorTwo
¶
InnerSurfaceBody
¶
BookmarkBuildings
¶
ConstructionLines
¶
Bases: BaseModel
Source code in dsbxml\core.py
337 338 339 340 | |
construction_line = element(tag='ConstructionLine', default_factory=list)
class-attribute
instance-attribute
¶
ConstructionLine
¶
CPlanes
¶
Planes
¶
Plane
¶
Bases: BaseModel
Source code in dsbxml\core.py
356 357 358 359 | |
AssemblyInstances
¶
Bases: BaseModel
Source code in dsbxml\core.py
362 363 364 365 | |
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 | |
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
¶
Matrix
¶
ProfileOutlines
¶
ProfileOutline
¶
VoidBodies
¶
VoidBody
¶
VoidPerimeterList
¶
CFDFans
¶
CFDFan
¶
CFDBoundary
¶
Bases: BaseModel
Source code in dsbxml\core.py
417 418 419 420 421 422 423 424 425 426 427 428 429 | |
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
HVAC_Zones_Coloured.xml (DesignBuilder 7) has twelve openings whose
Source code in dsbxml\core.py
432 433 434 435 436 437 438 439 | |
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 | |