Skip to content

BIM Controller

clear_errors()

clear errors

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
26
27
28
29
30
31
def clear_errors() -> None:
    """clear errors

    Returns:
        None
    """

convert_exchange_objects(exchange_objects)

converts a list of Exchange Objects to Cadwork Elements

Parameters:

Name Type Description Default
exchange_objects List[int]

exchange_objects

required

Returns:

Type Description
List[int]

List[int]

Source code in src/bim_controller/__init__.pyi
117
118
119
120
121
122
123
124
125
def convert_exchange_objects(exchange_objects: List[int]) -> List[int]:
    """converts a list of Exchange Objects to Cadwork Elements

    Parameters:
        exchange_objects: exchange_objects

    Returns:
        List[int]
    """

export_bcf(file_path)

export bcf

Parameters:

Name Type Description Default
file_path str

file_path

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
74
75
76
77
78
79
80
81
82
def export_bcf(file_path: str) -> bool:
    """export bcf

    Parameters:
        file_path: file_path

    Returns:
        bool
    """

export_ifc(element_i_ds, file_path)

export ifc

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
file_path str

file_path

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
84
85
86
87
88
89
90
91
92
93
def export_ifc(element_i_ds: List[int], file_path: str) -> bool:
    """export ifc

    Parameters:
        element_i_ds: element_i_ds
        file_path: file_path

    Returns:
        bool
    """

export_ifc2x3_silently(element_i_ds, file_path)

export ifc2x3 silently

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
file_path str

file_path

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
127
128
129
130
131
132
133
134
135
136
def export_ifc2x3_silently(element_i_ds: List[int], file_path: str) -> bool:
    """export ifc2x3 silently

    Parameters:
        element_i_ds: element_i_ds
        file_path: file_path

    Returns:
        bool
    """

export_ifc2x3_silently_with_options(element_i_ds, file_path, options)

export ifc2x3 silently with options

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
file_path str

file_path

required
options ifc_options

options

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
149
150
151
152
153
154
155
156
157
158
159
def export_ifc2x3_silently_with_options(element_i_ds: List[int], file_path: str, options: ifc_options) -> bool:
    """export ifc2x3 silently with options

    Parameters:
        element_i_ds: element_i_ds
        file_path: file_path
        options: options

    Returns:
        bool
    """

export_ifc4_silently(element_i_ds, file_path)

export ifc4 silently

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
file_path str

file_path

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
138
139
140
141
142
143
144
145
146
147
def export_ifc4_silently(element_i_ds: List[int], file_path: str) -> bool:
    """export ifc4 silently

    Parameters:
        element_i_ds: element_i_ds
        file_path: file_path

    Returns:
        bool
    """

export_ifc4_silently_with_options(element_i_ds, file_path, options)

export ifc4 silently with options

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
file_path str

file_path

required
options ifc_options

options

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
161
162
163
164
165
166
167
168
169
170
171
def export_ifc4_silently_with_options(element_i_ds: List[int], file_path: str, options: ifc_options) -> bool:
    """export ifc4 silently with options

    Parameters:
        element_i_ds: element_i_ds
        file_path: file_path
        options: options

    Returns:
        bool
    """

get_all_buildings()

get all buildings

Returns:

Type Description
List[str]

List[str]

Source code in src/bim_controller/__init__.pyi
263
264
265
266
267
268
def get_all_buildings() -> List[str]:
    """get all buildings

    Returns:
        List[str]
    """

get_all_storeys(building)

get all storeys

Parameters:

Name Type Description Default
building str

building

required

Returns:

Type Description
List[str]

List[str]

Source code in src/bim_controller/__init__.pyi
270
271
272
273
274
275
276
277
278
def get_all_storeys(building: str) -> List[str]:
    """get all storeys

    Parameters:
        building: building

    Returns:
        List[str]
    """

get_building(element)

get building

Parameters:

Name Type Description Default
element int

element

required

Returns:

Type Description
str

str

Source code in src/bim_controller/__init__.pyi
212
213
214
215
216
217
218
219
220
def get_building(element: int) -> str:
    """get building

    Parameters:
        element: element

    Returns:
        str
    """

get_element_id_from_base64_ifc_guid(a1)

get element id from base64 ifc guid

Parameters:

Name Type Description Default
a1 str

a1

required

Returns:

Type Description
int

int

Source code in src/bim_controller/__init__.pyi
280
281
282
283
284
285
286
287
288
def get_element_id_from_base64_ifc_guid(a1: str) -> int:
    """get element id from base64 ifc guid

    Parameters:
        a1: a1

    Returns:
        int
    """

get_ifc2x3_element_type(element_id)

get ifc2x3 element type

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
ifc_2x3_element_type

ifc_2x3_element_type

Source code in src/bim_controller/__init__.pyi
33
34
35
36
37
38
39
40
41
def get_ifc2x3_element_type(element_id: int) -> ifc_2x3_element_type:
    """get ifc2x3 element type

    Parameters:
        element_id: element_id

    Returns:
        ifc_2x3_element_type
    """

get_ifc2x3_element_type_display_string(element_type)

get ifc2x3 element type display string

Parameters:

Name Type Description Default
element_type None

element_type

required

Returns:

Type Description
str

str

Source code in src/bim_controller/__init__.pyi
253
254
255
256
257
258
259
260
261
def get_ifc2x3_element_type_display_string(element_type: None) -> str:
    """get ifc2x3 element type display string

    Parameters:
        element_type: element_type

    Returns:
        str
    """

get_ifc2x3_element_type_string(element_type)

get ifc2x3 element type string

Parameters:

Name Type Description Default
element_type None

element_type

required

Returns:

Type Description
str

str

Source code in src/bim_controller/__init__.pyi
243
244
245
246
247
248
249
250
251
def get_ifc2x3_element_type_string(element_type: None) -> str:
    """get ifc2x3 element type string

    Parameters:
        element_type: element_type

    Returns:
        str
    """

get_ifc_base64_guid(element_id)

Get IFC base64 Guid from element ID

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

The IFC GUID in base64 string format ("28kif20KPEuBjk2m1N3ep$").

Source code in src/bim_controller/__init__.pyi
290
291
292
293
294
295
296
297
298
def get_ifc_base64_guid(element_id: int) -> str:
    """Get IFC base64 Guid from element ID

    Parameters:
        element_id: element_id

    Returns:
        The IFC GUID in base64 string format ("28kif20KPEuBjk2m1N3ep$").
    """

get_ifc_guid(element_id)

get ifc guid

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
str

str

Source code in src/bim_controller/__init__.pyi
16
17
18
19
20
21
22
23
24
def get_ifc_guid(element_id: int) -> str:
    """get ifc guid

    Parameters:
        element_id: element_id

    Returns:
        str
    """

get_ifc_options()

Get the IfcOptions with the settings used in the document // *

Returns:

Type Description
ifc_options

IfcOptions //

Source code in src/bim_controller/__init__.pyi
193
194
195
196
197
198
def get_ifc_options() -> ifc_options:
    """Get the IfcOptions with the settings used in the document // *

    Returns:
        IfcOptions //
    """

get_ifc_predefined_type(element_id)

Get the IfcPredefinedType of an element.

Parameters:

Name Type Description Default
element_id int

element_id

required

Returns:

Type Description
ifc_predefined_type

IfcPredefinedType Wrapper

Source code in src/bim_controller/__init__.pyi
300
301
302
303
304
305
306
307
308
def get_ifc_predefined_type(element_id: int) -> 'ifc_predefined_type':
    """Get the IfcPredefinedType of an element.

    Parameters:
        element_id: element_id

    Returns:
        IfcPredefinedType Wrapper
    """

get_last_error(a0)

get last error

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in src/bim_controller/__init__.pyi
 6
 7
 8
 9
10
11
12
13
14
def get_last_error(a0: int) -> str:
    """get last error

    Parameters:
        a0: a0

    Returns:
        str
    """

get_storey(element)

get storey

Parameters:

Name Type Description Default
element int

element

required

Returns:

Type Description
str

str

Source code in src/bim_controller/__init__.pyi
222
223
224
225
226
227
228
229
230
def get_storey(element: int) -> str:
    """get storey

    Parameters:
        element: element

    Returns:
        str
    """

get_storey_height(building, storey)

get storey height

Parameters:

Name Type Description Default
building str

building

required
storey str

storey

required

Returns:

Type Description
float

float

Source code in src/bim_controller/__init__.pyi
232
233
234
235
236
237
238
239
240
241
def get_storey_height(building: str, storey: str) -> float:
    """get storey height

    Parameters:
        building: building
        storey: storey

    Returns:
        float
    """

import_bcf(file_path)

import bcf

Parameters:

Name Type Description Default
file_path str

file_path

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
64
65
66
67
68
69
70
71
72
def import_bcf(file_path: str) -> bool:
    """import bcf

    Parameters:
        file_path: file_path

    Returns:
        bool
    """

import_ifc_as_graphical_object(file_path)

import ifc as graphical object

Parameters:

Name Type Description Default
file_path str

file_path

required

Returns:

Type Description
bool

bool

Source code in src/bim_controller/__init__.pyi
54
55
56
57
58
59
60
61
62
def import_ifc_as_graphical_object(file_path: str) -> bool:
    """import ifc as graphical object

    Parameters:
        file_path: file_path

    Returns:
        bool
    """

import_ifc_return_exchange_objects(file_path)

imports an IFC File and returns the ids of the Exchange Objects

Parameters:

Name Type Description Default
file_path str

file_path

required

Returns:

Type Description
List[int]

List[int]

Source code in src/bim_controller/__init__.pyi
 95
 96
 97
 98
 99
100
101
102
103
def import_ifc_return_exchange_objects(file_path: str) -> List[int]:
    """imports an IFC File and returns the ids of the Exchange Objects

    Parameters:
        file_path: file_path

    Returns:
        List[int]
    """

set_building_and_storey(element_id_list, building, storey)

set building and storey

Parameters:

Name Type Description Default
element_id_list List[int]

element_id_list

required
building str

building

required
storey str

storey

required

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
200
201
202
203
204
205
206
207
208
209
210
def set_building_and_storey(element_id_list: List[int], building: str, storey: str) -> None:
    """set building and storey

    Parameters:
        element_id_list: element_id_list
        building: building
        storey: storey

    Returns:
        None
    """

set_ifc2x3_element_type(element_i_ds, element_type)

set ifc2x3 element type

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
element_type None

element_type

required

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
43
44
45
46
47
48
49
50
51
52
def set_ifc2x3_element_type(element_i_ds: List[int], element_type: None) -> None:
    """set ifc2x3 element type

    Parameters:
        element_i_ds: element_i_ds
        element_type: element_type

    Returns:
        None
    """

set_ifc_predefined_type(element_i_ds, predefined_type)

Set a predefined type to elements. Attention, if you change the PredefinedType of the elements, you are responsible for ensuring that valid types are set

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required
predefined_type None

predefined_type

required

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
310
311
312
313
314
315
316
317
318
319
def set_ifc_predefined_type(element_i_ds: List[int], predefined_type: None) -> None:
    """Set a predefined type to elements. Attention, if you change the PredefinedType of the elements, you are responsible for ensuring that valid types are set

    Parameters:
        element_i_ds: element_i_ds
        predefined_type: predefined_type

    Returns:
        None
    """

set_storey_height(building, storey, height)

set storey height

Parameters:

Name Type Description Default
building str

building

required
storey str

storey

required
height float

height

required

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
105
106
107
108
109
110
111
112
113
114
115
def set_storey_height(building: str, storey: str, height: float) -> None:
    """set storey height

    Parameters:
        building: building
        storey: storey
        height: height

    Returns:
        None
    """

update_bmt_structure_building_storey(element_i_ds)

This function takes the specified elements and inserts them into the BMT structure and adds them to the assigned Building and Storey.

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
183
184
185
186
187
188
189
190
191
def update_bmt_structure_building_storey(element_i_ds: List[int]) -> None:
    """This function takes the specified elements and inserts them into the BMT structure and adds them to the assigned Building and Storey.

    Parameters:
        element_i_ds: element_i_ds

    Returns:
        None
    """

update_bmt_structure_created_elements(element_i_ds)

This function takes the specified elements and inserts them into the BMT structure and adds them to the active building and storey.

Parameters:

Name Type Description Default
element_i_ds List[int]

element_i_ds

required

Returns:

Type Description
None

None

Source code in src/bim_controller/__init__.pyi
173
174
175
176
177
178
179
180
181
def update_bmt_structure_created_elements(element_i_ds: List[int]) -> None:
    """This function takes the specified elements and inserts them into the BMT structure and adds them to the active building and storey.

    Parameters:
        element_i_ds: element_i_ds

    Returns:
        None
    """