Skip to content

ifc_2x3_element_type

ifc_2x3_element_type

Source code in src/cadwork/ifc_2x3_element_type.pyi 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 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
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
class ifc_2x3_element_type:

    def is_none(self) -> bool:
        """is none

        Returns:
            bool
        """

    def is_ifc_beam(self) -> bool:
        """is ifc beam

        Returns:
            bool
        """

    def is_ifc_column(self) -> bool:
        """is ifc column

        Returns:
            bool
        """

    def is_ifc_curtain_wall(self) -> bool:
        """is ifc curtain wall

        Returns:
            bool
        """

    def is_ifc_door(self) -> bool:
        """is ifc door

        Returns:
            bool
        """

    def is_ifc_member(self) -> bool:
        """is ifc member

        Returns:
            bool
        """

    def is_ifc_plate(self) -> bool:
        """is ifc plate

        Returns:
            bool
        """

    def is_ifc_railing(self) -> bool:
        """is ifc railing

        Returns:
            bool
        """

    def is_ifc_ramp(self) -> bool:
        """is ifc ramp

        Returns:
            bool
        """

    def is_ifc_ramp_flight(self) -> bool:
        """is ifc ramp flight

        Returns:
            bool
        """

    def is_ifc_roof(self) -> bool:
        """is ifc roof

        Returns:
            bool
        """

    def is_ifc_slab(self) -> bool:
        """is ifc slab

        Returns:
            bool
        """

    def is_ifc_stair(self) -> bool:
        """is ifc stair

        Returns:
            bool
        """

    def is_ifc_stair_flight(self) -> bool:
        """is ifc stair flight

        Returns:
            bool
        """

    def is_ifc_wall(self) -> bool:
        """is ifc wall

        Returns:
            bool
        """

    def is_ifc_wall_standard_case(self) -> bool:
        """is ifc wall standard case

        Returns:
            bool
        """

    def is_ifc_window(self) -> bool:
        """is ifc window

        Returns:
            bool
        """

    def is_ifc_building_element_proxy(self) -> bool:
        """is ifc building element proxy

        Returns:
            bool
        """

    def is_ifc_chimney(self) -> bool:
        """is ifc chimney

        Returns:
            bool
        """

    def is_ifc_covering(self) -> bool:
        """is ifc covering

        Returns:
            bool
        """

    def is_ifc_footing(self) -> bool:
        """is ifc footing

        Returns:
            bool
        """

    def is_ifc_furnishing_element(self) -> bool:
        """is ifc furnishing element

        Returns:
            bool
        """

    def is_ifc_opening_element(self) -> bool:
        """is ifc opening element

        Returns:
            bool
        """

    def is_ifc_space(self) -> bool:
        """is ifc space

        Returns:
            bool
        """

    def is_ifc_flow_segment(self) -> bool:
        """is ifc flow segment

        Returns:
            bool
        """

    def is_ifc_building_element_part(self) -> bool:
        """is ifc building element part

        Returns:
            bool
        """

    def is_ifc_discrete_accessory(self) -> bool:
        """is ifc discrete accessory

        Returns:
            bool
        """

    def is_ifc_fastener(self) -> bool:
        """is ifc fastener

        Returns:
            bool
        """

    def is_ifc_mechanical_fastener(self) -> bool:
        """is ifc mechanical fastener

        Returns:
            bool
        """

    def set_none(self) -> None:
        """set none

        Returns:
            None
        """

    def set_ifc_beam(self) -> None:
        """set ifc beam

        Returns:
            None
        """

    def set_ifc_column(self) -> None:
        """set ifc column

        Returns:
            None
        """

    def set_ifc_curtain_wall(self) -> None:
        """set ifc curtain wall

        Returns:
            None
        """

    def set_ifc_door(self) -> None:
        """set ifc door

        Returns:
            None
        """

    def set_ifc_member(self) -> None:
        """set ifc member

        Returns:
            None
        """

    def set_ifc_plate(self) -> None:
        """set ifc plate

        Returns:
            None
        """

    def set_ifc_railing(self) -> None:
        """set ifc railing

        Returns:
            None
        """

    def set_ifc_ramp(self) -> None:
        """set ifc ramp

        Returns:
            None
        """

    def set_ifc_ramp_flight(self) -> None:
        """set ifc ramp flight

        Returns:
            None
        """

    def set_ifc_roof(self) -> None:
        """set ifc roof

        Returns:
            None
        """

    def set_ifc_slab(self) -> None:
        """set ifc slab

        Returns:
            None
        """

    def set_ifc_stair(self) -> None:
        """set ifc stair

        Returns:
            None
        """

    def set_ifc_stair_flight(self) -> None:
        """set ifc stair flight

        Returns:
            None
        """

    def set_ifc_wall(self) -> None:
        """set ifc wall

        Returns:
            None
        """

    def set_ifc_wall_standard_case(self) -> None:
        """set ifc wall standard case

        Returns:
            None
        """

    def set_ifc_window(self) -> None:
        """set ifc window

        Returns:
            None
        """

    def set_ifc_building_element_proxy(self) -> None:
        """set ifc building element proxy

        Returns:
            None
        """

    def set_ifc_chimney(self) -> None:
        """set ifc chimney

        Returns:
            None
        """

    def set_ifc_covering(self) -> None:
        """set ifc covering

        Returns:
            None
        """

    def set_ifc_footing(self) -> None:
        """set ifc footing

        Returns:
            None
        """

    def set_ifc_furnishing_element(self) -> None:
        """set ifc furnishing element

        Returns:
            None
        """

    def set_ifc_opening_element(self) -> None:
        """set ifc opening element

        Returns:
            None
        """

    def set_ifc_space(self) -> None:
        """set ifc space

        Returns:
            None
        """

    def set_ifc_flow_segment(self) -> None:
        """set ifc flow segment

        Returns:
            None
        """

    def set_ifc_building_element_part(self) -> None:
        """set ifc building element part

        Returns:
            None
        """

    def set_ifc_discrete_accessory(self) -> None:
        """set ifc discrete accessory

        Returns:
            None
        """

    def set_ifc_fastener(self) -> None:
        """set ifc fastener

        Returns:
            None
        """

    def set_ifc_mechanical_fastener(self) -> None:
        """set ifc mechanical fastener

        Returns:
            None
        """

    def __repr__(self) -> str:
        """  repr  

        Returns:
            str
        """

__repr__()

repr

Returns:

Type Description
str

str
Source code in src/cadwork/ifc_2x3_element_type.pyi 
409
410
411
412
413
414
def __repr__(self) -> str:
    """  repr  

    Returns:
        str
    """

is_ifc_beam()

is ifc beam

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
10
11
12
13
14
15
def is_ifc_beam(self) -> bool:
    """is ifc beam

    Returns:
        bool
    """

is_ifc_building_element_part()

is ifc building element part

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
178
179
180
181
182
183
def is_ifc_building_element_part(self) -> bool:
    """is ifc building element part

    Returns:
        bool
    """

is_ifc_building_element_proxy()

is ifc building element proxy

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
122
123
124
125
126
127
def is_ifc_building_element_proxy(self) -> bool:
    """is ifc building element proxy

    Returns:
        bool
    """

is_ifc_chimney()

is ifc chimney

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
129
130
131
132
133
134
def is_ifc_chimney(self) -> bool:
    """is ifc chimney

    Returns:
        bool
    """

is_ifc_column()

is ifc column

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
17
18
19
20
21
22
def is_ifc_column(self) -> bool:
    """is ifc column

    Returns:
        bool
    """

is_ifc_covering()

is ifc covering

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
136
137
138
139
140
141
def is_ifc_covering(self) -> bool:
    """is ifc covering

    Returns:
        bool
    """

is_ifc_curtain_wall()

is ifc curtain wall

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
24
25
26
27
28
29
def is_ifc_curtain_wall(self) -> bool:
    """is ifc curtain wall

    Returns:
        bool
    """

is_ifc_discrete_accessory()

is ifc discrete accessory

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
185
186
187
188
189
190
def is_ifc_discrete_accessory(self) -> bool:
    """is ifc discrete accessory

    Returns:
        bool
    """

is_ifc_door()

is ifc door

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
31
32
33
34
35
36
def is_ifc_door(self) -> bool:
    """is ifc door

    Returns:
        bool
    """

is_ifc_fastener()

is ifc fastener

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
192
193
194
195
196
197
def is_ifc_fastener(self) -> bool:
    """is ifc fastener

    Returns:
        bool
    """

is_ifc_flow_segment()

is ifc flow segment

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
171
172
173
174
175
176
def is_ifc_flow_segment(self) -> bool:
    """is ifc flow segment

    Returns:
        bool
    """

is_ifc_footing()

is ifc footing

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
143
144
145
146
147
148
def is_ifc_footing(self) -> bool:
    """is ifc footing

    Returns:
        bool
    """

is_ifc_furnishing_element()

is ifc furnishing element

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
150
151
152
153
154
155
def is_ifc_furnishing_element(self) -> bool:
    """is ifc furnishing element

    Returns:
        bool
    """

is_ifc_mechanical_fastener()

is ifc mechanical fastener

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
199
200
201
202
203
204
def is_ifc_mechanical_fastener(self) -> bool:
    """is ifc mechanical fastener

    Returns:
        bool
    """

is_ifc_member()

is ifc member

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
38
39
40
41
42
43
def is_ifc_member(self) -> bool:
    """is ifc member

    Returns:
        bool
    """

is_ifc_opening_element()

is ifc opening element

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
157
158
159
160
161
162
def is_ifc_opening_element(self) -> bool:
    """is ifc opening element

    Returns:
        bool
    """

is_ifc_plate()

is ifc plate

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
45
46
47
48
49
50
def is_ifc_plate(self) -> bool:
    """is ifc plate

    Returns:
        bool
    """

is_ifc_railing()

is ifc railing

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
52
53
54
55
56
57
def is_ifc_railing(self) -> bool:
    """is ifc railing

    Returns:
        bool
    """

is_ifc_ramp()

is ifc ramp

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
59
60
61
62
63
64
def is_ifc_ramp(self) -> bool:
    """is ifc ramp

    Returns:
        bool
    """

is_ifc_ramp_flight()

is ifc ramp flight

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
66
67
68
69
70
71
def is_ifc_ramp_flight(self) -> bool:
    """is ifc ramp flight

    Returns:
        bool
    """

is_ifc_roof()

is ifc roof

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
73
74
75
76
77
78
def is_ifc_roof(self) -> bool:
    """is ifc roof

    Returns:
        bool
    """

is_ifc_slab()

is ifc slab

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
80
81
82
83
84
85
def is_ifc_slab(self) -> bool:
    """is ifc slab

    Returns:
        bool
    """

is_ifc_space()

is ifc space

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
164
165
166
167
168
169
def is_ifc_space(self) -> bool:
    """is ifc space

    Returns:
        bool
    """

is_ifc_stair()

is ifc stair

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
87
88
89
90
91
92
def is_ifc_stair(self) -> bool:
    """is ifc stair

    Returns:
        bool
    """

is_ifc_stair_flight()

is ifc stair flight

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
94
95
96
97
98
99
def is_ifc_stair_flight(self) -> bool:
    """is ifc stair flight

    Returns:
        bool
    """

is_ifc_wall()

is ifc wall

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
101
102
103
104
105
106
def is_ifc_wall(self) -> bool:
    """is ifc wall

    Returns:
        bool
    """

is_ifc_wall_standard_case()

is ifc wall standard case

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
108
109
110
111
112
113
def is_ifc_wall_standard_case(self) -> bool:
    """is ifc wall standard case

    Returns:
        bool
    """

is_ifc_window()

is ifc window

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
115
116
117
118
119
120
def is_ifc_window(self) -> bool:
    """is ifc window

    Returns:
        bool
    """

is_none()

is none

Returns:

Type Description
bool

bool
Source code in src/cadwork/ifc_2x3_element_type.pyi 
3
4
5
6
7
8
def is_none(self) -> bool:
    """is none

    Returns:
        bool
    """

set_ifc_beam()

set ifc beam

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
213
214
215
216
217
218
def set_ifc_beam(self) -> None:
    """set ifc beam

    Returns:
        None
    """

set_ifc_building_element_part()

set ifc building element part

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
381
382
383
384
385
386
def set_ifc_building_element_part(self) -> None:
    """set ifc building element part

    Returns:
        None
    """

set_ifc_building_element_proxy()

set ifc building element proxy

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
325
326
327
328
329
330
def set_ifc_building_element_proxy(self) -> None:
    """set ifc building element proxy

    Returns:
        None
    """

set_ifc_chimney()

set ifc chimney

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
332
333
334
335
336
337
def set_ifc_chimney(self) -> None:
    """set ifc chimney

    Returns:
        None
    """

set_ifc_column()

set ifc column

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
220
221
222
223
224
225
def set_ifc_column(self) -> None:
    """set ifc column

    Returns:
        None
    """

set_ifc_covering()

set ifc covering

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
339
340
341
342
343
344
def set_ifc_covering(self) -> None:
    """set ifc covering

    Returns:
        None
    """

set_ifc_curtain_wall()

set ifc curtain wall

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
227
228
229
230
231
232
def set_ifc_curtain_wall(self) -> None:
    """set ifc curtain wall

    Returns:
        None
    """

set_ifc_discrete_accessory()

set ifc discrete accessory

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
388
389
390
391
392
393
def set_ifc_discrete_accessory(self) -> None:
    """set ifc discrete accessory

    Returns:
        None
    """

set_ifc_door()

set ifc door

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
234
235
236
237
238
239
def set_ifc_door(self) -> None:
    """set ifc door

    Returns:
        None
    """

set_ifc_fastener()

set ifc fastener

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
395
396
397
398
399
400
def set_ifc_fastener(self) -> None:
    """set ifc fastener

    Returns:
        None
    """

set_ifc_flow_segment()

set ifc flow segment

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
374
375
376
377
378
379
def set_ifc_flow_segment(self) -> None:
    """set ifc flow segment

    Returns:
        None
    """

set_ifc_footing()

set ifc footing

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
346
347
348
349
350
351
def set_ifc_footing(self) -> None:
    """set ifc footing

    Returns:
        None
    """

set_ifc_furnishing_element()

set ifc furnishing element

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
353
354
355
356
357
358
def set_ifc_furnishing_element(self) -> None:
    """set ifc furnishing element

    Returns:
        None
    """

set_ifc_mechanical_fastener()

set ifc mechanical fastener

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
402
403
404
405
406
407
def set_ifc_mechanical_fastener(self) -> None:
    """set ifc mechanical fastener

    Returns:
        None
    """

set_ifc_member()

set ifc member

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
241
242
243
244
245
246
def set_ifc_member(self) -> None:
    """set ifc member

    Returns:
        None
    """

set_ifc_opening_element()

set ifc opening element

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
360
361
362
363
364
365
def set_ifc_opening_element(self) -> None:
    """set ifc opening element

    Returns:
        None
    """

set_ifc_plate()

set ifc plate

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
248
249
250
251
252
253
def set_ifc_plate(self) -> None:
    """set ifc plate

    Returns:
        None
    """

set_ifc_railing()

set ifc railing

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
255
256
257
258
259
260
def set_ifc_railing(self) -> None:
    """set ifc railing

    Returns:
        None
    """

set_ifc_ramp()

set ifc ramp

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
262
263
264
265
266
267
def set_ifc_ramp(self) -> None:
    """set ifc ramp

    Returns:
        None
    """

set_ifc_ramp_flight()

set ifc ramp flight

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
269
270
271
272
273
274
def set_ifc_ramp_flight(self) -> None:
    """set ifc ramp flight

    Returns:
        None
    """

set_ifc_roof()

set ifc roof

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
276
277
278
279
280
281
def set_ifc_roof(self) -> None:
    """set ifc roof

    Returns:
        None
    """

set_ifc_slab()

set ifc slab

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
283
284
285
286
287
288
def set_ifc_slab(self) -> None:
    """set ifc slab

    Returns:
        None
    """

set_ifc_space()

set ifc space

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
367
368
369
370
371
372
def set_ifc_space(self) -> None:
    """set ifc space

    Returns:
        None
    """

set_ifc_stair()

set ifc stair

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
290
291
292
293
294
295
def set_ifc_stair(self) -> None:
    """set ifc stair

    Returns:
        None
    """

set_ifc_stair_flight()

set ifc stair flight

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
297
298
299
300
301
302
def set_ifc_stair_flight(self) -> None:
    """set ifc stair flight

    Returns:
        None
    """

set_ifc_wall()

set ifc wall

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
304
305
306
307
308
309
def set_ifc_wall(self) -> None:
    """set ifc wall

    Returns:
        None
    """

set_ifc_wall_standard_case()

set ifc wall standard case

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
311
312
313
314
315
316
def set_ifc_wall_standard_case(self) -> None:
    """set ifc wall standard case

    Returns:
        None
    """

set_ifc_window()

set ifc window

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
318
319
320
321
322
323
def set_ifc_window(self) -> None:
    """set ifc window

    Returns:
        None
    """

set_none()

set none

Returns:

Type Description
None

None
Source code in src/cadwork/ifc_2x3_element_type.pyi 
206
207
208
209
210
211
def set_none(self) -> None:
    """set none

    Returns:
        None
    """