Skip to content

BIM Controller

bim_controller special

clear_errors()

clear errors

Returns:

Type Description
None

None

Source code in bim_controller/__init__.py
def clear_errors() -> None:
    """clear errors
    Args:

    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 bim_controller/__init__.py
def convert_exchange_objects(exchange_objects: List[int]) -> List[int]:
    """converts a list of Exchange Objects to Cadwork Elements 
    Args:
        exchange_objects ( List[int]): 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 bim_controller/__init__.py
def export_bcf(file_path: str) -> bool:
    """export bcf
    Args:
        file_path ( str): 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 bim_controller/__init__.py
def export_ifc(element_i_ds: List[int], file_path: str) -> bool:
    """export ifc
    Args:
        element_i_ds ( List[int]): element_i_ds
        file_path ( str): 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 bim_controller/__init__.py
def export_ifc2x3_silently(element_i_ds: List[int], file_path: str) -> bool:
    """export ifc2x3 silently
    Args:
        element_i_ds ( List[int]): element_i_ds
        file_path ( str): 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 bim_controller/__init__.py
def export_ifc2x3_silently_with_options(element_i_ds: List[int], file_path: str, options: ifc_options) -> bool:
    """export ifc2x3 silently with options
    Args:
        element_i_ds ( List[int]): element_i_ds
        file_path ( str): file_path
        options ( ifc_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 bim_controller/__init__.py
def export_ifc4_silently(element_i_ds: List[int], file_path: str) -> bool:
    """export ifc4 silently
    Args:
        element_i_ds ( List[int]): element_i_ds
        file_path ( str): 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 bim_controller/__init__.py
def export_ifc4_silently_with_options(element_i_ds: List[int], file_path: str, options: ifc_options) -> bool:
    """export ifc4 silently with options
    Args:
        element_i_ds ( List[int]): element_i_ds
        file_path ( str): file_path
        options ( ifc_options): options

    Returns:
        bool
    """

get_all_buildings()

get all buildings

Returns:

Type Description
List[str]

List[str]

Source code in bim_controller/__init__.py
def get_all_buildings() -> List[str]:
    """get all buildings
    Args:

    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 bim_controller/__init__.py
def get_all_storeys(building: str) -> List[str]:
    """get all storeys
    Args:
        building ( str): 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 bim_controller/__init__.py
def get_building(element: int) -> str:
    """get building
    Args:
        element ( int): 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 bim_controller/__init__.py
def get_element_id_from_base64_ifc_guid(a1: str) -> int:
    """get element id from base64 ifc guid
    Args:
        a1 ( str): 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 bim_controller/__init__.py
def get_ifc2x3_element_type(element_id: int) -> ifc_2x3_element_type:
    """get ifc2x3 element type
    Args:
        element_id ( int): 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 bim_controller/__init__.py
def get_ifc2x3_element_type_display_string(element_type: None) -> str:
    """get ifc2x3 element type display string
    Args:
        element_type ( None): 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 bim_controller/__init__.py
def get_ifc2x3_element_type_string(element_type: None) -> str:
    """get ifc2x3 element type string
    Args:
        element_type ( None): 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$"). (str)

Source code in bim_controller/__init__.py
def get_ifc_base64_guid(element_id: int) -> str:
    """Get IFC base64 Guid from element ID 
    Args:
        element_id ( int): element_id

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

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 bim_controller/__init__.py
def get_ifc_guid(element_id: int) -> str:
    """get ifc guid
    Args:
        element_id ( int): element_id

    Returns:
        str
    """

get_last_error(a0)

get last error

Parameters:

Name Type Description Default
a0 int

a0

required

Returns:

Type Description
str

str

Source code in bim_controller/__init__.py
def get_last_error(a0: int) -> str:
    """get last error
    Args:
        a0 ( int): 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 bim_controller/__init__.py
def get_storey(element: int) -> str:
    """get storey
    Args:
        element ( int): 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 bim_controller/__init__.py
def get_storey_height(building: str, storey: str) -> float:
    """get storey height
    Args:
        building ( str): building
        storey ( str): 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 bim_controller/__init__.py
def import_bcf(file_path: str) -> bool:
    """import bcf
    Args:
        file_path ( str): 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 bim_controller/__init__.py
def import_ifc_as_graphical_object(file_path: str) -> bool:
    """import ifc as graphical object
    Args:
        file_path ( str): 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 bim_controller/__init__.py
def import_ifc_return_exchange_objects(file_path: str) -> List[int]:
    """imports an IFC File and returns the ids of the Exchange Objects 
    Args:
        file_path ( str): 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 bim_controller/__init__.py
def set_building_and_storey(element_id_list: List[int], building: str, storey: str) -> None:
    """set building and storey
    Args:
        element_id_list ( List[int]): element_id_list
        building ( str): building
        storey ( str): 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 bim_controller/__init__.py
def set_ifc2x3_element_type(element_i_ds: List[int], element_type: None) -> None:
    """set ifc2x3 element type
    Args:
        element_i_ds ( List[int]): element_i_ds
        element_type ( None): element_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 bim_controller/__init__.py
def set_storey_height(building: str, storey: str, height: float) -> None:
    """set storey height
    Args:
        building ( str): building
        storey ( str): storey
        height ( float): height

    Returns:
        None
    """