ifcopenshell.api.owner.add_application

Module Contents

class ifcopenshell.api.owner.add_application.Usecase
create_application_organisation()
execute()
ifcopenshell.api.owner.add_application.add_application(file: ifcopenshell.file, application_developer: ifcopenshell.entity_instance | None = None, version: str | None = None, application_full_name: str = 'IfcOpenShell', application_identifier: str = 'IfcOpenShell') → ifcopenshell.entity_instance

Adds a new application

IFC data may be associated with an authoring application to identify which application was responsible for editing or authoring the data. An application is defined by the developing organisation, as well as a full name and identifier. This is akin to how web browsers have an identification string.

Parameters:

  • application_developer (ifcopenshell.entity_instance, optional) – The IfcOrganization responsible for creating the application. Defaults to generating an IfcOpenShell organisation if none is provided.

  • version (str, optional) – The version of the application. Defaults to the ifcopenshell.version data if not specified.

  • application_full_name (str, optional) – The name of the application

  • application_identifier (str, optional) – An identification string for the application intended for computers to read.

Returns:

The newly created IfcApplication

Return type:

ifcopenshell.entity_instance

Example:

application = ifcopenshell.api.owner.add_application(model)