ifcopenshell.api#

High level user-oriented IFC authoring capabilities

Subpackages#

Package Contents#

ifcopenshell.api.post_listeners#
ifcopenshell.api.pre_listeners#
ifcopenshell.api.add_post_listener(usecase_path, name, callback)#

Add a post listener

Parameters
  • usecase_path – string, ifcopenshell api use case path

  • name – string, name of listener

  • callback – callback function

ifcopenshell.api.add_pre_listener(usecase_path, name, callback)#

Add a pre listener

Parameters
  • usecase_path – string, ifcopenshell api use case path

  • name – string, name of listener

  • callback – callback function

ifcopenshell.api.extract_docs(module, usecase)#
ifcopenshell.api.remove_all_listeners()#
ifcopenshell.api.remove_post_listener(usecase_path, name, callback)#

Remove a post listener

Parameters
  • usecase_path – string, ifcopenshell api use case path

  • name – string, name of listener

  • callback – callback function

ifcopenshell.api.remove_pre_listener(usecase_path, name, callback)#

Remove a pre listener

Parameters
  • usecase_path – string, ifcopenshell api use case path

  • name – string, name of listener

  • callback – callback function

ifcopenshell.api.run(usecase_path, ifc_file=None, should_run_listeners=True, **settings)#