ifcopenshell.api.structural.add_structural_activity

Module Contents

ifcopenshell.api.structural.add_structural_activity.add_structural_activity(file: ifcopenshell.file, applied_load: ifcopenshell.entity_instance, structural_member: ifcopenshell.entity_instance, ifc_class: str = 'IfcStructuralPlanarAction', predefined_type: str = 'CONST', global_or_local: Literal['GLOBAL_COORDS', 'LOCAL_COORDS'] = 'GLOBAL_COORDS') → None

Adds a new structural activity

A structural activity is either a structural action or a reaction. It may be applied to a point, a curve, or a planar surface, and may be a constant load, linear, etc.

The activity must be defined using an applied load, and associated with a structural member.

Parameters:

  • ifc_class (str) – Choose from any subtype of IfcStructuralActivity.

  • predefined_type (str) – View the IFC documentation for what valid predefined types may be chosen.

  • global_or_local (str) – The location coordinates of the load is always defined locally relative to the structural member the activity is assigned to. However, the directions of the applied load may either be specified globally or locally depending on how this argument is set. Choose from GLOBAL_COORDS or LOCAL_COORDS.

  • applied_load (ifcopenshell.entity_instance) – The IfcStructuralLoad that is applied in this activity.

  • structural_member (ifcopenshell.entity_instance) – The IfcStructuralMember that the load is applied to.

Returns:

The newly created entity based on the ifc_class

Return type:

ifcopenshell.entity_instance