diff --git a/src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py b/src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py index 58bf9daa13..3e9f866435 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py +++ b/src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py @@ -63,13 +63,13 @@ class Usecase: :param products: The list of parts of the aggregate, typically of IfcElement or IfcSpatialStructureElement subclass - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :param relating_object: The whole of the aggregate, typically an IfcElement or IfcSpatialStructureElement subclass - :type relating_object: ifcopenshell.entity_instance.entity_instance + :type relating_object: ifcopenshell.entity_instance :return: The IfcRelAggregate relationship instance or `None` if `products` was empty list. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/aggregate/unassign_object.py b/src/ifcopenshell-python/ifcopenshell/api/aggregate/unassign_object.py index e4d0e35def..c766a4f019 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/aggregate/unassign_object.py +++ b/src/ifcopenshell-python/ifcopenshell/api/aggregate/unassign_object.py @@ -39,7 +39,7 @@ class Usecase: :param products: The list of parts of the aggregate, typically of IfcElements or IfcSpatialStructureElement subclass - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py b/src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py index 42365ca802..1e2cd98bc5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py +++ b/src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py @@ -30,7 +30,7 @@ class Usecase: :param product: The product you want to edit. This may be any rooted IFC entity. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/boundary/assign_connection_geometry.py b/src/ifcopenshell-python/ifcopenshell/api/boundary/assign_connection_geometry.py index 205eba2ce7..8f23a60bb6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/boundary/assign_connection_geometry.py +++ b/src/ifcopenshell-python/ifcopenshell/api/boundary/assign_connection_geometry.py @@ -31,7 +31,7 @@ class Usecase: :param rel_space_boundary: The space boundary relationship to assign the connection geometry to. - :type rel_space_boundary: ifcopenshell.entity_instance.entity_instance + :type rel_space_boundary: ifcopenshell.entity_instance :param outer_boundary: A list of 2D points representing an open polyline. The last point will connect to the first point. Each point is represented by an interable of 2 floats. The coordinates of diff --git a/src/ifcopenshell-python/ifcopenshell/api/boundary/copy_boundary.py b/src/ifcopenshell-python/ifcopenshell/api/boundary/copy_boundary.py index af78438421..2f8b092c51 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/boundary/copy_boundary.py +++ b/src/ifcopenshell-python/ifcopenshell/api/boundary/copy_boundary.py @@ -24,7 +24,7 @@ class Usecase: """Copies a space boundary :param boundary: The IfcRelSpaceBoundary you want to copy. - :type boundary: ifcopenshell.entity_instance.entity_instance + :type boundary: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/boundary/edit_attributes.py b/src/ifcopenshell-python/ifcopenshell/api/boundary/edit_attributes.py index a67b3fb2bb..4be540f7a2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/boundary/edit_attributes.py +++ b/src/ifcopenshell-python/ifcopenshell/api/boundary/edit_attributes.py @@ -25,22 +25,22 @@ class Usecase: manual assignment of the space boundary attributes. :param entity: The IfcRelSpaceBoundary to modify - :type entity: ifcopenshell.entity_instance.entity_instance + :type entity: ifcopenshell.entity_instance :param relating_space: The IfcSpace or IfcExternalSpatialElement that the space boundary is related to. - :type relating_space: ifcopenshell.entity_instance.entity_instance + :type relating_space: ifcopenshell.entity_instance :param related_building_element: The IfcElement that defines the boundary, typically an IfcWall. - :type relating_space: ifcopenshell.entity_instance.entity_instance + :type relating_space: ifcopenshell.entity_instance :param parent_boundary: A parent IfcRelSpaceBoundary, only provided if this is an inner boundary. This can apply to 1st and 2nd level boundaries. - :type parent_boundary: ifcopenshell.entity_instance.entity_instance, + :type parent_boundary: ifcopenshell.entity_instance, optional :param corresponding_boundary: The other IfcRelSpaceBoundary on the other side of the related element. The pair together represents a thermal boundary. This only applies to 2nd level boundaries. - :type corresponding_boundary: ifcopenshell.entity_instance.entity_instance, + :type corresponding_boundary: ifcopenshell.entity_instance, optional :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/boundary/remove_boundary.py b/src/ifcopenshell-python/ifcopenshell/api/boundary/remove_boundary.py index 2d77f74f06..6744da820c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/boundary/remove_boundary.py +++ b/src/ifcopenshell-python/ifcopenshell/api/boundary/remove_boundary.py @@ -28,7 +28,7 @@ class Usecase: boundary and its connection geometry is removed. :param boundary: The IfcRelSpaceBoundary you want to remove. - :type boundary: ifcopenshell.entity_instance.entity_instance + :type boundary: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/classification/add_classification.py b/src/ifcopenshell-python/ifcopenshell/api/classification/add_classification.py index d59a4e9343..580c036a5f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/classification/add_classification.py +++ b/src/ifcopenshell-python/ifcopenshell/api/classification/add_classification.py @@ -59,9 +59,9 @@ class Usecase: classification library. The latter approach is preferred if you are using a commonly known system such as Uniclass, as this will ensure all metadata is added correctly. - :type classification: str,ifcopenshell.entity_instance.entity_instance + :type classification: str,ifcopenshell.entity_instance :return: The added IfcClassification element - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/classification/add_reference.py b/src/ifcopenshell-python/ifcopenshell/api/classification/add_reference.py index 9057f7a25f..db1bab41bf 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/classification/add_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/classification/add_reference.py @@ -66,11 +66,11 @@ class Usecase: :param product: The list of IFC objects, properties, or resources you want to associate the classification reference to. - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :param reference: The classification reference entity taken from an IFC classification library. If you supply this parameter, you will use option 2. - :type reference: ifcopenshell.entity_instance.entity_instance, optional + :type reference: ifcopenshell.entity_instance, optional :param identification: If you choose option 1 and do not specify a reference, you may manually specify an identification code. The code is typically a short identifier and may have punctuation to separate @@ -82,7 +82,7 @@ class Usecase: :param classification: The IfcClassification entity in your IFC model (not the library, if you are doing option 2) that the reference is part of. - :type classification: ifcopenshell.entity_instance.entity_instance + :type classification: ifcopenshell.entity_instance :param is_lightweight: If you are doing option 2, choose whether or not to only add that particular reference (lighweight) or also add all of its parent references in the classification hierarchy (not @@ -98,7 +98,7 @@ class Usecase: :return: The newly added IfcClassificationReference or `None` if `products` was empty list. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/classification/edit_classification.py b/src/ifcopenshell-python/ifcopenshell/api/classification/edit_classification.py index bd590ddd38..9925c59f54 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/classification/edit_classification.py +++ b/src/ifcopenshell-python/ifcopenshell/api/classification/edit_classification.py @@ -25,7 +25,7 @@ class Usecase: IfcClassification, consult the IFC documentation. :param classification: The IfcClassification entity you want to edit - :type classification: ifcopenshell.entity_instance.entity_instance + :type classification: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/classification/edit_reference.py b/src/ifcopenshell-python/ifcopenshell/api/classification/edit_reference.py index 4b47aebc71..4acf396adb 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/classification/edit_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/classification/edit_reference.py @@ -25,7 +25,7 @@ class Usecase: IfcClassificationReference, consult the IFC documentation. :param reference: The IfcClassificationReference entity you want to edit - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/classification/remove_classification.py b/src/ifcopenshell-python/ifcopenshell/api/classification/remove_classification.py index 2cf46cb091..42a5dcacd0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/classification/remove_classification.py +++ b/src/ifcopenshell-python/ifcopenshell/api/classification/remove_classification.py @@ -29,7 +29,7 @@ class Usecase: removed from a project. :param classification: The IfcClassification entity you want to remove - :type classification: ifcopenshell.entity_instance.entity_instance + :type classification: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/classification/remove_reference.py b/src/ifcopenshell-python/ifcopenshell/api/classification/remove_reference.py index d4e8d802a6..ea61fb002d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/classification/remove_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/classification/remove_reference.py @@ -35,10 +35,10 @@ class Usecase: :param reference: The IfcClassificationReference entity of the relationship you want to remove. - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param product: The list fo object entities of the relationship you want to remove. - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :raises TypeError: If file is IFC2X3 and `products` has non-IfcRoot elements. diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric.py index 2941eb8308..b84e2f3cc9 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric.py @@ -29,9 +29,9 @@ class Usecase: to meet the objective of the constraint. :param objective: The IfcObjective that this metric is a benchmark of. - :type objective: ifcopenshell.entity_instance.entity_instance + :type objective: ifcopenshell.entity_instance :return: The newly created IfcMetric entity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/add_objective.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/add_objective.py index 578c7da3de..40fb46dfd2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/add_objective.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/add_objective.py @@ -30,7 +30,7 @@ class Usecase: quantities. See ifcopenshell.api.constraint.add_metric for more information. :return: The newly created IfcObjective entity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/assign_constraint.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/assign_constraint.py index 759fab9a5e..dfc826faf8 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/assign_constraint.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/assign_constraint.py @@ -40,12 +40,12 @@ class Usecase: :param products: The list of products the constraint applies to. This is anything which can have properties or quantities. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param constraint: The IfcObjective constraint - :type constraint: ifcopenshell.entity_instance.entity_instance + :type constraint: ifcopenshell.entity_instance :return: The new or updated IfcRelAssociatesConstraint relationship or `None` if `products` was an empty list. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.py index 3bb6c852ba..72fead7d88 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.py @@ -25,7 +25,7 @@ class Usecase: IfcMetric, consult the IFC documentation. :param metric: The IfcMetric you want to edit. - :type metric: ifcopenshell.entity_instance.entity_instance + :type metric: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_objective.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_objective.py index 96ac354702..dff4985539 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_objective.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/edit_objective.py @@ -25,7 +25,7 @@ class Usecase: IfcObjective, consult the IFC documentation. :param objective: The IfcObjective you want to edit. - :type objective: ifcopenshell.entity_instance.entity_instance + :type objective: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_constraint.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_constraint.py index d2d797ce0f..e7dab1afb0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_constraint.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_constraint.py @@ -30,7 +30,7 @@ class Usecase: unclear. :param constraint: The IfcObjective you want to remove. - :type constraint: ifcopenshell.entity_instance.entity_instance + :type constraint: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_metric.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_metric.py index 86ab642b7a..6eaf012fa2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_metric.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/remove_metric.py @@ -25,7 +25,7 @@ class Usecase: and objectives. :param metric: The IfcMetric you want to remove. - :type metric: ifcopenshell.entity_instance.entity_instance + :type metric: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/constraint/unassign_constraint.py b/src/ifcopenshell-python/ifcopenshell/api/constraint/unassign_constraint.py index dbc1e1b7fb..3b6471713e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/constraint/unassign_constraint.py +++ b/src/ifcopenshell-python/ifcopenshell/api/constraint/unassign_constraint.py @@ -34,9 +34,9 @@ class Usecase: other products. :param products: The list of products the constraint applies to. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param constraint: The IfcObjective constraint - :type constraint: ifcopenshell.entity_instance.entity_instance + :type constraint: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/context/add_context.py b/src/ifcopenshell-python/ifcopenshell/api/context/add_context.py index e7f96a77d7..02156daf0b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/context/add_context.py +++ b/src/ifcopenshell-python/ifcopenshell/api/context/add_context.py @@ -102,10 +102,10 @@ class Usecase: :param parent: the parent context. Must be left as None (the default) for contexts, and only set for subcontexts. Note that there are only contexts and subcontexts, a subcontext cannot have any children. - :type parent: ifcopenshell.entity_instance.entity_instance, optional + :type parent: ifcopenshell.entity_instance, optional :return: the newly created IfcGeometricRepresentationContext or IfcGeometricRepresentationSubContext entity - :rtype: ifcopenshell.entity_instance.entity_instance, optional + :rtype: ifcopenshell.entity_instance, optional Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/context/edit_context.py b/src/ifcopenshell-python/ifcopenshell/api/context/edit_context.py index 698a8da6ac..50f4612c75 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/context/edit_context.py +++ b/src/ifcopenshell-python/ifcopenshell/api/context/edit_context.py @@ -25,7 +25,7 @@ class Usecase: IfcGeometricRepresentationContext, consult the IFC documentation. :param context: The IfcGeometricRepresentationContext entity you want to edit - :type context: ifcopenshell.entity_instance.entity_instance + :type context: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/context/remove_context.py b/src/ifcopenshell-python/ifcopenshell/api/context/remove_context.py index edd4f1d723..b0025efbdb 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/context/remove_context.py +++ b/src/ifcopenshell-python/ifcopenshell/api/context/remove_context.py @@ -27,7 +27,7 @@ class Usecase: removed. If a context is removed, then any subcontexts are also removed. :param context: The IfcGeometricRepresentationContext entity to remove - :type context: ifcopenshell.entity_instance.entity_instance + :type context: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/control/assign_control.py b/src/ifcopenshell-python/ifcopenshell/api/control/assign_control.py index 867089137f..4d1ecb128d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/control/assign_control.py +++ b/src/ifcopenshell-python/ifcopenshell/api/control/assign_control.py @@ -37,12 +37,12 @@ class Usecase: :param relating_control: The IfcControl entity that is creating the control or constraint - :type relating_control: ifcopenshell.entity_instance.entity_instance + :type relating_control: ifcopenshell.entity_instance :param related_object: The IfcObjectDefinition that is being controlled - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The newly created IfcRelAssignsToControl. If relationship already existed before and wasn't changed then returns None. - :rtype: ifcopenshell.entity_instance.entity_instance, None + :rtype: ifcopenshell.entity_instance, None Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/control/unassign_control.py b/src/ifcopenshell-python/ifcopenshell/api/control/unassign_control.py index 33ee89db4d..72996ad62a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/control/unassign_control.py +++ b/src/ifcopenshell-python/ifcopenshell/api/control/unassign_control.py @@ -27,12 +27,12 @@ class Usecase: :param relating_control: The IfcControl entity that is creating the control or constraint - :type relating_control: ifcopenshell.entity_instance.entity_instance + :type relating_control: ifcopenshell.entity_instance :param related_object: The IfcObjectDefinition that is being controlled - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: If the control still is related to other objects, the IfcRelAssignsToControl is returned, otherwise None. - :rtype: ifcopenshell.entity_instance.entity_instance, None + :rtype: ifcopenshell.entity_instance, None Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item.py b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item.py index 0674d1def4..26a0bba442 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item.py @@ -29,13 +29,13 @@ class Usecase: :param cost_schedule: If the cost item is to be added as a root or top level cost item to a cost schedule, the IfcCostSchedule may be specified. This is mutually exlclusive to the cost_item parameter. - :type cost_schedule: ifcopenshell.entity_instance.entity_instance + :type cost_schedule: ifcopenshell.entity_instance :param cost_item: If the cost item is to be added as a subitem to an existing cost item, the parent IfcCostItem may be specified. This is mutually exclusive to the cost_schedule parameter. - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :return: The newly created IfcCostItem - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item_quantity.py index 3402c1828e..fabe443460 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item_quantity.py @@ -50,12 +50,12 @@ class Usecase: using another API call. :param cost_item: The IfcCostItem to add the quantity to - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :param ifc_class: The type of quantity to add :type ifc_class: str, optional :return: The newly created quantity entity, chosen from the ifc_class parameter - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_schedule.py index 1d9882ff45..fa97a893f3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_schedule.py @@ -43,7 +43,7 @@ class Usecase: IfcCostScheduleTypeEnum :type predefined_type: str, optional :return: The newly created IfcCostSchedule entity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_value.py b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_value.py index edc84d7fc3..e7a481e8b2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_value.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_value.py @@ -46,9 +46,9 @@ class Usecase: :param parent: A parent IfcCostItem, if specifying a price directly to a cost item, or a top-level price component. Alternatively, this can be set to a IfcCostValue, if specifying price subcomponents. - :type parent: ifcopenshell.entity_instance.entity_instance + :type parent: ifcopenshell.entity_instance :return: The newly created IfcCostValue - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_item_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_item_quantity.py index b09e7f07fa..d4c6b6be69 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_item_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_item_quantity.py @@ -40,9 +40,9 @@ class Usecase: ifcopenshell.api.control.assign_control. :param cost_item: The IfcCostItem to assign parametric quantities to - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :param products: The IfcObjects to assign parametric quantities to - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param prop_name: The name of the quantity. If this is not specified, then it is assumed that there is no calculated quantity, and the number of objects are counted instead. diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_value.py b/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_value.py index fd814b4dd5..fb89fe7432 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_value.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_value.py @@ -35,9 +35,9 @@ class Usecase: rates as a "template" to quickly populate your rates from. :param cost_item: The IfcCostItem that you want to copy the values to - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :param cost_rate: The IfcCostItem that you want to copy the values from - :type cost_rate: ifcopenshell.entity_instance.entity_instance + :type cost_rate: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item.py b/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item.py index 2127bde2a6..ec2d147731 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item.py @@ -32,9 +32,9 @@ class Usecase: * The copy will have duplicated nested cost items :param cost_item: The cost item to be duplicated - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :return: The duplicated cost item or the list of duplicated cost items if the latter has children - :rtype: ifcopenshell.entity_instance.entity_instance or list of ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance or list of ifcopenshell.entity_instance Example: .. code:: python diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item_values.py b/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item_values.py index a931b52c52..6bc0677b28 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item_values.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item_values.py @@ -29,9 +29,9 @@ class Usecase: parametrically linked, so if one value changes, the other will not. :param source: The IfcCostItem to copy cost values from - :type source: ifcopenshell.entity_instance.entity_instance + :type source: ifcopenshell.entity_instance :param destination: The IfcCostItem to copy cost values from - :type destination: ifcopenshell.entity_instance.entity_instance + :type destination: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item.py b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item.py index 3b570ef388..cc0a187177 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item.py @@ -25,7 +25,7 @@ class Usecase: IfcCostItem, consult the IFC documentation. :param cost_item: The IfcCostItem entity you want to edit - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item_quantity.py index 2684d1e394..3ba4e9f498 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item_quantity.py @@ -25,7 +25,7 @@ class Usecase: IfcPhysicalQuantity, consult the IFC documentation. :param physical_quantity: The IfcPhysicalQuantity entity you want to edit - :type physical_quantity: ifcopenshell.entity_instance.entity_instance + :type physical_quantity: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_schedule.py index ab38f62d8e..bdfb856cc1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_schedule.py @@ -25,7 +25,7 @@ class Usecase: IfcCostSchedule, consult the IFC documentation. :param cost_schedule: The IfcCostSchedule entity you want to edit - :type cost_schedule: ifcopenshell.entity_instance.entity_instance + :type cost_schedule: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py index 818cd4a84b..75ce055eb1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py @@ -29,7 +29,7 @@ class Usecase: IfcCostValue, consult the IFC documentation. :param cost_value: The IfcCostValue entity you want to edit - :type cost_value: ifcopenshell.entity_instance.entity_instance + :type cost_value: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value_formula.py b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value_formula.py index ede08a966d..8dada5dc98 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value_formula.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value_formula.py @@ -33,7 +33,7 @@ class Usecase: For more information, see ifcopenshell.util.cost :param cost_value: The IfcCostValue to set the values of - :type cost_value: ifcopenshell.entity_instance.entity_instance + :type cost_value: ifcopenshell.entity_instance :param formula: The formula following the language of ifcopenshell.util.cost :type formula: str :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item.py b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item.py index 06d1f2ef26..5596ceff13 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item.py @@ -30,7 +30,7 @@ class Usecase: retained. :param cost_item: The IfcCostItem entity you want to remove - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item_quantity.py index bf562c46e7..fae8e1cd37 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item_quantity.py @@ -26,9 +26,9 @@ class Usecase: removed. :param cost_item: The IfcCostItem that the quantity is assigned to - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :param physical_quantity: The IfcPhysicalQuantity to remove - :type physical_quantity: ifcopenshell.entity_instance.entity_instance + :type physical_quantity: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_schedule.py index 79438a5461..51feebb76e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_schedule.py @@ -29,7 +29,7 @@ class Usecase: including all cost items. :param cost_schedule: The IfcCostSchedule entity you want to remove - :type cost_schedule: ifcopenshell.entity_instance.entity_instance + :type cost_schedule: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_value.py b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_value.py index 6c4a346f02..4af7322899 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_value.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_value.py @@ -26,9 +26,9 @@ class Usecase: :param parent: The IfcCostItem, IfcConstructionResource, or IfcCostValue that the IfcCostValue is assigned to. - :type parent: ifcopenshell.entity_instance.entity_instance + :type parent: ifcopenshell.entity_instance :param cost_value: The IfcCostValue that you want to remove - :type parent: ifcopenshell.entity_instance.entity_instance + :type parent: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/cost/unassign_cost_item_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/cost/unassign_cost_item_quantity.py index 967cec4162..091029f594 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/cost/unassign_cost_item_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/cost/unassign_cost_item_quantity.py @@ -29,10 +29,10 @@ class Usecase: have any impact on the cost item. :param cost_item: The IfcCostItem to remove quantities from - :type cost_item: ifcopenshell.entity_instance.entity_instance + :type cost_item: ifcopenshell.entity_instance :param products: A list of IfcProducts that may have parametrically connected quantities to the cost item - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/add_information.py b/src/ifcopenshell-python/ifcopenshell/api/document/add_information.py index 7106fe7f7b..68c9c53759 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/add_information.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/add_information.py @@ -33,9 +33,9 @@ class Usecase: is considered the latest version and the children are older revisions. :param parent: The parent document, if necessary. - :type parent: ifcopenshell.entity_instance.entity_instance, optional + :type parent: ifcopenshell.entity_instance, optional :return: The newly created IfcDocumentInformation entity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/add_reference.py b/src/ifcopenshell-python/ifcopenshell/api/document/add_reference.py index bcec5da606..80cf91d8a1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/add_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/add_reference.py @@ -39,9 +39,9 @@ class Usecase: :param information: The IfcDocumentInformation that the reference will be created for - :type information: ifcopenshell.entity_instance.entity_instance + :type information: ifcopenshell.entity_instance :return: The newly created IfcDocumentReference entity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/assign_document.py b/src/ifcopenshell-python/ifcopenshell/api/document/assign_document.py index f67cbe890a..f9b433213a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/assign_document.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/assign_document.py @@ -42,15 +42,15 @@ class Usecase: :param product: The list of objects to associate the document to. This could be almost any sensible object in IFC. - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :param document: The IfcDocumentReference to associate to, or alternatively an IfcDocumentInformation, though this is not recommended. - :type document: ifcopenshell.entity_instance.entity_instance + :type document: ifcopenshell.entity_instance :return: The IfcRelAssociatesDocument relationship or `None` if `products` was an empty list or all products were already assigned to the `document`. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/edit_information.py b/src/ifcopenshell-python/ifcopenshell/api/document/edit_information.py index 1d7af0c1b8..96c0120120 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/edit_information.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/edit_information.py @@ -32,7 +32,7 @@ class Usecase: IfcDocumentInformation, consult the IFC documentation. :param reference: The IfcDocumentInformation entity you want to edit - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.py b/src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.py index 538c8d2854..d88afdfc2f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.py @@ -32,7 +32,7 @@ class Usecase: IfcDocumentReference, consult the IFC documentation. :param reference: The IfcDocumentReference entity you want to edit - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/remove_information.py b/src/ifcopenshell-python/ifcopenshell/api/document/remove_information.py index bf26837822..56f57df283 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/remove_information.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/remove_information.py @@ -29,7 +29,7 @@ class Usecase: All references and associations are also removed. :param information: The IfcDocumentInformation to remove - :type information: ifcopenshell.entity_instance.entity_instance + :type information: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/remove_reference.py b/src/ifcopenshell-python/ifcopenshell/api/document/remove_reference.py index 6eee90fb4d..61fd6810c1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/remove_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/remove_reference.py @@ -27,7 +27,7 @@ class Usecase: All associations with objects are removed. :param reference: The IfcDocumentReference to remove - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/document/unassign_document.py b/src/ifcopenshell-python/ifcopenshell/api/document/unassign_document.py index dd43573e65..c4728d5511 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/document/unassign_document.py +++ b/src/ifcopenshell-python/ifcopenshell/api/document/unassign_document.py @@ -32,10 +32,10 @@ class Usecase: :param product: The list of objects that the document reference or information is related to. - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :param document: The IfcDocumentReference (typically) or in rare cases the IfcDocumentInformation that is associated with the product - :type document: ifcopenshell.entity_instance.entity_instance + :type document: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/drawing/assign_product.py b/src/ifcopenshell-python/ifcopenshell/api/drawing/assign_product.py index 11da9c0ee0..051dd985b3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/drawing/assign_product.py +++ b/src/ifcopenshell-python/ifcopenshell/api/drawing/assign_product.py @@ -42,12 +42,12 @@ class Usecase: in 3D. :param relating_product: The IfcProduct the object is related to - :type relating_product: ifcopenshell.entity_instance.entity_instance + :type relating_product: ifcopenshell.entity_instance :param related_object: The object (typically IfcAnnotation) that the product is related to - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The created IfcRelAssignsToProduct relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/drawing/edit_text_literal.py b/src/ifcopenshell-python/ifcopenshell/api/drawing/edit_text_literal.py index c8be879f7f..00b8bc4f82 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/drawing/edit_text_literal.py +++ b/src/ifcopenshell-python/ifcopenshell/api/drawing/edit_text_literal.py @@ -25,7 +25,7 @@ class Usecase: IfcTextLiteral, consult the IFC documentation. :param reference: The IfcTextLiteral entity you want to edit - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/drawing/unassign_product.py b/src/ifcopenshell-python/ifcopenshell/api/drawing/unassign_product.py index 8b0e514935..91ee7ded3d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/drawing/unassign_product.py +++ b/src/ifcopenshell-python/ifcopenshell/api/drawing/unassign_product.py @@ -31,12 +31,12 @@ class Usecase: object later or leave the annotation as a "dumb" annotation. :param relating_product: The IfcProduct the object is related to - :type relating_product: ifcopenshell.entity_instance.entity_instance + :type relating_product: ifcopenshell.entity_instance :param related_object: The object (typically IfcAnnotation) that the product is related to - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The created IfcRelAssignsToProduct relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/geometry/add_axis_representation.py b/src/ifcopenshell-python/ifcopenshell/api/geometry/add_axis_representation.py index 9ed90b6fb7..8a09531a26 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/geometry/add_axis_representation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/geometry/add_axis_representation.py @@ -52,13 +52,13 @@ class Usecase: :param context: The IfcGeometricRepresentationContext that the representation is part of. This must be either a Model/Axis/GRAPH_VIEW (3D) or Plan/Axis/GRAPH_VIEW (2D). - :type context: ifcopenshell.entity_instance.entity_instance + :type context: ifcopenshell.entity_instance :param axis: The axis, as a list of two coordinates, the coordinates being either a list of 2 or 3 float coordinates depending on whether the axis is 2D or 3D. :type axis: list[list[float]] :return: The newly created IfcShapeRepresentation entity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/grid/create_axis_curve.py b/src/ifcopenshell-python/ifcopenshell/api/grid/create_axis_curve.py index a09e7b2bd2..21fead74e5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/grid/create_axis_curve.py +++ b/src/ifcopenshell-python/ifcopenshell/api/grid/create_axis_curve.py @@ -35,7 +35,7 @@ class Usecase: single edge. :type axis_curve: bpy.types.Object :param grid_axis: The IfcGridAxis element to add geometry to. - :type grid_axis: ifcopenshell.entity_instance.entity_instance + :type grid_axis: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/grid/create_grid_axis.py b/src/ifcopenshell-python/ifcopenshell/api/grid/create_grid_axis.py index e794cbdc86..de667bb5bc 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/grid/create_grid_axis.py +++ b/src/ifcopenshell-python/ifcopenshell/api/grid/create_grid_axis.py @@ -54,9 +54,9 @@ class Usecase: Defaults to "UAxes". :type uvw_axes: str, optional :param grid: The IfcGrid you are adding the axis to. - :type grid: ifcopenshell.entity_instance.entity_instance + :type grid: ifcopenshell.entity_instance :return: The newly created IfcGridAxis - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/grid/remove_grid_axis.py b/src/ifcopenshell-python/ifcopenshell/api/grid/remove_grid_axis.py index d14ee8cf0b..b380778a67 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/grid/remove_grid_axis.py +++ b/src/ifcopenshell-python/ifcopenshell/api/grid/remove_grid_axis.py @@ -24,7 +24,7 @@ class Usecase: """Removes a grid axis from a grid :param axis: The IfcGridAxis you want to remove. - :type axis: ifcopenshell.entity_instance.entity_instance + :type axis: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/group/add_group.py b/src/ifcopenshell-python/ifcopenshell/api/group/add_group.py index fa2877eac5..298ec42ba6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/group/add_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/group/add_group.py @@ -37,7 +37,7 @@ class Usecase: :param Description: The description of the purpose of the group. :type Description: str, optional :return: The newly created IfcGroup - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/group/assign_group.py b/src/ifcopenshell-python/ifcopenshell/api/group/assign_group.py index 78d787f741..d312a95bd6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/group/assign_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/group/assign_group.py @@ -31,12 +31,12 @@ class Usecase: twice. :param products: A list of IfcProduct elements to assign to the group - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param group: The IfcGroup to assign the products to - :type group: ifcopenshell.entity_instance.entity_instance + :type group: ifcopenshell.entity_instance :return: The IfcRelAssignsToGroup relationship or `None` if `products` was empty list. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/group/edit_group.py b/src/ifcopenshell-python/ifcopenshell/api/group/edit_group.py index 442b9d84f6..87fa9dcf12 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/group/edit_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/group/edit_group.py @@ -25,7 +25,7 @@ class Usecase: IfcGroup, consult the IFC documentation. :param group: The IfcGroup entity you want to edit - :type group: ifcopenshell.entity_instance.entity_instance + :type group: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/group/remove_group.py b/src/ifcopenshell-python/ifcopenshell/api/group/remove_group.py index 0ade115de1..c87b36e316 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/group/remove_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/group/remove_group.py @@ -29,7 +29,7 @@ class Usecase: the group will be removed. :param group: The IfcGroup entity you want to remove - :type group: ifcopenshell.entity_instance.entity_instance + :type group: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/group/unassign_group.py b/src/ifcopenshell-python/ifcopenshell/api/group/unassign_group.py index 57d8d88556..9229281a69 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/group/unassign_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/group/unassign_group.py @@ -28,9 +28,9 @@ class Usecase: If the product isn't assigned to the group, nothing will happen. :param products: A list of IfcProduct elements to unassign from the group - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param group: The IfcGroup to unassign from - :type group: ifcopenshell.entity_instance.entity_instance + :type group: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/group/update_group_products.py b/src/ifcopenshell-python/ifcopenshell/api/group/update_group_products.py index a752057f84..61b96c2ba6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/group/update_group_products.py +++ b/src/ifcopenshell-python/ifcopenshell/api/group/update_group_products.py @@ -28,11 +28,11 @@ class Usecase: removed. :param products: A list of IfcProduct elements to assign to the group - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param group: The IfcGroup to assign the products to - :type group: ifcopenshell.entity_instance.entity_instance + :type group: ifcopenshell.entity_instance :return: The IfcRelAssignsToGroup relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/layer/add_layer.py b/src/ifcopenshell-python/ifcopenshell/api/layer/add_layer.py index 848dc423ce..8638a76b22 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/layer/add_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/layer/add_layer.py @@ -36,7 +36,7 @@ class Usecase: :param Name: The name of the layer. Defaults to "Unnamed". :type Name: str, optional :return: The newly created IfcPresentationLayerAssignment element - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/layer/assign_layer.py b/src/ifcopenshell-python/ifcopenshell/api/layer/assign_layer.py index 21a4ceb2bf..93a863d66f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/layer/assign_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/layer/assign_layer.py @@ -34,10 +34,10 @@ class Usecase: :param items: The list of IfcRepresentationItems to assign to the layer. This should be the items from the object's IfcShapeRepresentation. - :type items: list[ifcopenshell.entity_instance.entity_instance] + :type items: list[ifcopenshell.entity_instance] :param layer: The IfcPresentationLayerAssignment layer to assign the item to. - :type layer: ifcopenshell.entity_instance.entity_instance + :type layer: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/layer/edit_layer.py b/src/ifcopenshell-python/ifcopenshell/api/layer/edit_layer.py index 4ac74d4014..c2b1cbc99a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/layer/edit_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/layer/edit_layer.py @@ -25,7 +25,7 @@ class Usecase: IfcPresentationLayerAssignment, consult the IFC documentation. :param layer: The IfcPresentationLayerAssignment entity you want to edit - :type layer: ifcopenshell.entity_instance.entity_instance + :type layer: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/layer/remove_layer.py b/src/ifcopenshell-python/ifcopenshell/api/layer/remove_layer.py index 2834d8f8ef..8e83e475ab 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/layer/remove_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/layer/remove_layer.py @@ -25,7 +25,7 @@ class Usecase: relationship to the layer will be removed. :param layer: The IfcPresentationLayerAssignment entity to remove - :type layer: ifcopenshell.entity_instance.entity_instance + :type layer: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/layer/unassign_layer.py b/src/ifcopenshell-python/ifcopenshell/api/layer/unassign_layer.py index 657db6ac9e..f9d6a024a3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/layer/unassign_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/layer/unassign_layer.py @@ -32,9 +32,9 @@ class Usecase: removed to keep IFC valid. :param items: A list IfcRepresentationItem elements to unassign - :type items: list[ifcopenshell.entity_instance.entity_instance] + :type items: list[ifcopenshell.entity_instance] :param layer: The IfcPresentationLayerAssignment to unassign from - :type layer: ifcopenshell.entity_instance.entity_instance + :type layer: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/add_library.py b/src/ifcopenshell-python/ifcopenshell/api/library/add_library.py index db011f5ca0..f20494ac5f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/add_library.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/add_library.py @@ -53,7 +53,7 @@ class Usecase: :param name: The name of the library :type name: str :return: The newly created IfcLibraryInformation - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/add_reference.py b/src/ifcopenshell-python/ifcopenshell/api/library/add_reference.py index 0a109b2118..84f6605cf0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/add_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/add_reference.py @@ -36,9 +36,9 @@ class Usecase: library's references. :param library: The IfcLibraryInformation element to add a reference to - :type library: ifcopenshell.entity_instance.entity_instance + :type library: ifcopenshell.entity_instance :return: The newly created IfcLibraryReference element - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/assign_reference.py b/src/ifcopenshell-python/ifcopenshell/api/library/assign_reference.py index 8ee4a21eb5..8a0880ccf0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/assign_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/assign_reference.py @@ -33,14 +33,14 @@ class Usecase: detail about how references work. :param products: The list of IfcProducts you want to associate with the reference - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param reference: The IfcLibraryReference you want the product to be associated with. - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :return: The IfcRelAssociatesLibrary relationship entity or `None` if `products` was an empty list or all products were already assigned to the `reference`. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/edit_library.py b/src/ifcopenshell-python/ifcopenshell/api/library/edit_library.py index a5846f0c9b..aca508cc38 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/edit_library.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/edit_library.py @@ -25,7 +25,7 @@ class Usecase: IfcLibraryInformation, consult the IFC documentation. :param library: The IfcLibraryInformation entity you want to edit - :type library: ifcopenshell.entity_instance.entity_instance + :type library: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/edit_reference.py b/src/ifcopenshell-python/ifcopenshell/api/library/edit_reference.py index 4fb13253a8..35a1be4709 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/edit_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/edit_reference.py @@ -25,7 +25,7 @@ class Usecase: IfcLibraryReference, consult the IFC documentation. :param reference: The IfcLibraryReference entity you want to edit - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/remove_library.py b/src/ifcopenshell-python/ifcopenshell/api/library/remove_library.py index 931d9153d6..e921016c4d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/remove_library.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/remove_library.py @@ -28,7 +28,7 @@ class Usecase: products which have relationships to this library will not be removed. :param library: The IfcLibraryInformation entity you want to remove - :type library: ifcopenshell.entity_instance.entity_instance + :type library: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/remove_reference.py b/src/ifcopenshell-python/ifcopenshell/api/library/remove_reference.py index 9a5851827a..d34973f6b2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/remove_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/remove_reference.py @@ -28,7 +28,7 @@ class Usecase: removed. :param reference: The IfcLibraryReference entity you want to remove - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/library/unassign_reference.py b/src/ifcopenshell-python/ifcopenshell/api/library/unassign_reference.py index b650ffba75..420b7fa0d4 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/library/unassign_reference.py +++ b/src/ifcopenshell-python/ifcopenshell/api/library/unassign_reference.py @@ -33,9 +33,9 @@ class Usecase: If the product isn't assigned to the reference, nothing will happen. :param reference: The IfcLibraryReference to unassign from - :type reference: ifcopenshell.entity_instance.entity_instance + :type reference: ifcopenshell.entity_instance :param products: A list of IfcProduct elements to unassign from the reference - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/add_constituent.py b/src/ifcopenshell-python/ifcopenshell/api/material/add_constituent.py index c45b5fb14d..278eb50872 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/add_constituent.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/add_constituent.py @@ -38,11 +38,11 @@ class Usecase: constituent is part of. The constituent set represents a group of constituents. See ifcopenshell.api.material.add_material_set for information on how to add a constituent set. - :type constituent_set: ifcopenshell.entity_instance.entity_instance + :type constituent_set: ifcopenshell.entity_instance :param material: The IfcMaterial that the constituent is made out of. - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :return: The newly created IfcMaterialConstituent - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/add_layer.py b/src/ifcopenshell-python/ifcopenshell/api/material/add_layer.py index d0b36b4ec6..aa572f07bd 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/add_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/add_layer.py @@ -36,11 +36,11 @@ class Usecase: layer set represents a group of layers. See ifcopenshell.api.material.add_material_set for more information on how to add a layer set. - :type layer_set: ifcopenshell.entity_instance.entity_instance + :type layer_set: ifcopenshell.entity_instance :param material: The IfcMaterial that the layer is made out of. - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :return: The newly created IfcMaterialLayer - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/add_list_item.py b/src/ifcopenshell-python/ifcopenshell/api/material/add_list_item.py index 92b873b198..9a12ed044b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/add_list_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/add_list_item.py @@ -39,9 +39,9 @@ class Usecase: :param material_list: The IfcMaterialList the material should be added to. - :type material_list: ifcopenshell.entity_instance.entity_instance + :type material_list: ifcopenshell.entity_instance :param material: The IfcMaterial to add to the list - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/add_material.py b/src/ifcopenshell-python/ifcopenshell/api/material/add_material.py index 3959e4becd..bac5a3ac0a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/add_material.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/add_material.py @@ -53,7 +53,7 @@ class Usecase: :param category: The category of the material. :type category: str, optional :return: The newly created IfcMaterial - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/add_material_set.py b/src/ifcopenshell-python/ifcopenshell/api/material/add_material_set.py index 5ec8a36623..277aa258f2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/add_material_set.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/add_material_set.py @@ -64,7 +64,7 @@ class Usecase: IfcMaterialConstituentSet. :type set_type: str, optional :return: The newly created material set element - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/add_profile.py b/src/ifcopenshell-python/ifcopenshell/api/material/add_profile.py index 51b622b3f3..ff2cf3bed5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/add_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/add_profile.py @@ -47,14 +47,14 @@ class Usecase: profile set represents a group of profile items. See ifcopenshell.api.material.add_material_set for more information on how to add a profile set. - :type profile_set: ifcopenshell.entity_instance.entity_instance + :type profile_set: ifcopenshell.entity_instance :param material: The IfcMaterial that the profile item is made out of. - :type material: ifcopenshell.entity_instance.entity_instance, optional + :type material: ifcopenshell.entity_instance, optional :param profile: The IfcProfileDef that represents the 2D cross section of the the profile item. - :type profile: ifcopenshell.entity_instance.entity_instance, optional + :type profile: ifcopenshell.entity_instance, optional :return: The newly created IfcMaterialProfile - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/assign_material.py b/src/ifcopenshell-python/ifcopenshell/api/material/assign_material.py index 0445f2a995..a65a644866 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/assign_material.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/assign_material.py @@ -64,7 +64,7 @@ class Usecase: :param products: The list of IfcProducts to assign the material or material set to. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param type: Choose from "IfcMaterial", "IfcMaterialConstituentSet", "IfcMaterialLayerSet", "IfcMaterialLayerSetUsage", "IfcMaterialProfileSet", "IfcMaterialProfileSetUsage", or @@ -74,15 +74,15 @@ class Usecase: :param material: The IfcMaterial or material set you are assigning here. If type is Usage then no need to provide `material`, it will be deduced from the element type automatically. - :type material: ifcopenshell.entity_instance.entity_instance, optional + :type material: ifcopenshell.entity_instance, optional :return: IfcRelAssociatesMaterial entity or a list of IfcRelAssociatesMaterial entities (possible if `type` is Usage and `products` require different Usages) or `None` if `products` was empty list. :rtype: Union[ - ifcopenshell.entity_instance.entity_instance, - list[ifcopenshell.entity_instance.entity_instance], None] + ifcopenshell.entity_instance, + list[ifcopenshell.entity_instance], None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/assign_profile.py b/src/ifcopenshell-python/ifcopenshell/api/material/assign_profile.py index 4acd6637e7..4d1678a0ae 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/assign_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/assign_profile.py @@ -29,9 +29,9 @@ class Usecase: :param material_profile: The IfcMaterialProfile to change the profile curve of. See ifcopenshell.api.material.add_profile to see how to create profiles. - :type material_profile: ifcopenshell.entity_instance.entity_instance + :type material_profile: ifcopenshell.entity_instance :param profile: The IfcProfileDef to set the profile item's curve to. - :type profile: ifcopenshell.entity_instance.entity_instance + :type profile: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/copy_material.py b/src/ifcopenshell-python/ifcopenshell/api/material/copy_material.py index cd49c73e8f..8dac43b8e0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/copy_material.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/copy_material.py @@ -28,9 +28,9 @@ class Usecase: associated to any elements. :param material: The IfcMaterial to copy - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :return: The new copy of the material - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/edit_assigned_material.py b/src/ifcopenshell-python/ifcopenshell/api/material/edit_assigned_material.py index 3e481d9748..3e3a03dbd8 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/edit_assigned_material.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/edit_assigned_material.py @@ -25,7 +25,7 @@ class Usecase: IfcMaterial, consult the IFC documentation. :param element: The IfcMaterial entity you want to edit - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/edit_constituent.py b/src/ifcopenshell-python/ifcopenshell/api/material/edit_constituent.py index 22660fcb24..ef036527a3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/edit_constituent.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/edit_constituent.py @@ -25,11 +25,11 @@ class Usecase: IfcMaterialConstituent, consult the IFC documentation. :param constituent: The IfcMaterialConstituent entity you want to edit - :type constituent: ifcopenshell.entity_instance.entity_instance + :type constituent: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :param material: The IfcMaterial entity you want to change the constituent to - :type material: ifcopenshell.entity_instance.entity_instance, optional + :type material: ifcopenshell.entity_instance, optional :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer.py b/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer.py index e6981d059b..3e31194452 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer.py @@ -25,12 +25,12 @@ class Usecase: IfcMaterialLayer, consult the IFC documentation. :param layer: The IfcMaterialLayer entity you want to edit - :type layer: ifcopenshell.entity_instance.entity_instance + :type layer: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :param material: The IfcMaterial entity you want the layer to be made from. - :type material: ifcopenshell.entity_instance.entity_instance, optional + :type material: ifcopenshell.entity_instance, optional :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer_usage.py b/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer_usage.py index 3e45c68c78..a30fa39f21 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer_usage.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/edit_layer_usage.py @@ -28,7 +28,7 @@ class Usecase: IfcMaterialLayerSetUsage, consult the IFC documentation. :param usage: The IfcMaterialLayerSetUsage entity you want to edit - :type usage: ifcopenshell.entity_instance.entity_instance + :type usage: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile.py b/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile.py index 04de2044cc..6fc781f9a6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile.py @@ -25,15 +25,15 @@ class Usecase: IfcMaterialProfile, consult the IFC documentation. :param profile: The IfcMaterialProfile entity you want to edit - :type profile: ifcopenshell.entity_instance.entity_instance + :type profile: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :param profile_def: The IfcProfileDef entity the profile curve should be extruded from. - :type profile_def: ifcopenshell.entity_instance.entity_instance, optional + :type profile_def: ifcopenshell.entity_instance, optional :param material: The IfcMaterial entity you want to change the profile to be made from. - :type material: ifcopenshell.entity_instance.entity_instance, optional + :type material: ifcopenshell.entity_instance, optional :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile_usage.py b/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile_usage.py index edd6f27fee..afd9007c7b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile_usage.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/edit_profile_usage.py @@ -33,7 +33,7 @@ class Usecase: IfcMaterialProfileSetUsage, consult the IFC documentation. :param usage: The IfcMaterialProfileSetUsage entity you want to edit - :type usage: ifcopenshell.entity_instance.entity_instance + :type usage: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/remove_constituent.py b/src/ifcopenshell-python/ifcopenshell/api/material/remove_constituent.py index b62d06bee7..2fb919d10d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/remove_constituent.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/remove_constituent.py @@ -25,7 +25,7 @@ class Usecase: at least one constituent to ensure a valid IFC dataset. :param constituent: The IfcMaterialConstituent entity you want to remove - :type constituent: ifcopenshell.entity_instance.entity_instance + :type constituent: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/remove_layer.py b/src/ifcopenshell-python/ifcopenshell/api/material/remove_layer.py index 3d6d8b8df6..f068641533 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/remove_layer.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/remove_layer.py @@ -25,7 +25,7 @@ class Usecase: at least one layer to ensure a valid IFC dataset. :param layer: The IfcMaterialLayer entity you want to remove - :type layer: ifcopenshell.entity_instance.entity_instance + :type layer: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/remove_list_item.py b/src/ifcopenshell-python/ifcopenshell/api/material/remove_list_item.py index 47269b51dc..276d9e64d2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/remove_list_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/remove_list_item.py @@ -28,7 +28,7 @@ class Usecase: :param material_list: The IfcMaterialList entity you want to remove an item from. - :type material_list: ifcopenshell.entity_instance.entity_instance + :type material_list: ifcopenshell.entity_instance :param material_index: The index of the material you want to remove from the list. Starts counting at 0. Defaults to 0. :type material_index: int, optional diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/remove_material.py b/src/ifcopenshell-python/ifcopenshell/api/material/remove_material.py index 5c048734c7..ffdf9693d8 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/remove_material.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/remove_material.py @@ -30,7 +30,7 @@ class Usecase: take care of this situation themselves. :param material: The IfcMaterial entity you want to remove - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/remove_material_set.py b/src/ifcopenshell-python/ifcopenshell/api/material/remove_material_set.py index 9eb7bcab62..79093789aa 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/remove_material_set.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/remove_material_set.py @@ -30,7 +30,7 @@ class Usecase: :param material: The IfcMaterialLayerSet, IfcMaterialConstituentSet, IfcMaterialProfileSet entity you want to remove. - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/remove_profile.py b/src/ifcopenshell-python/ifcopenshell/api/material/remove_profile.py index 4174d067cb..9c930866ed 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/remove_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/remove_profile.py @@ -29,7 +29,7 @@ class Usecase: at least one profile to ensure a valid IFC dataset. :param profile: The IfcMaterialProfile entity you want to remove - :type profile: ifcopenshell.entity_instance.entity_instance + :type profile: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/reorder_set_item.py b/src/ifcopenshell-python/ifcopenshell/api/material/reorder_set_item.py index d6e2d6f9f7..442fec8b5e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/reorder_set_item.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/reorder_set_item.py @@ -26,7 +26,7 @@ class Usecase: :param material_set: The IfcMaterialSet which you want to reorder an item in. - :type material_set: ifcopenshell.entity_instance.entity_instance + :type material_set: ifcopenshell.entity_instance :param old_index: The index of the item you want to move. This starts counting from 0. :type old_index: int diff --git a/src/ifcopenshell-python/ifcopenshell/api/material/unassign_material.py b/src/ifcopenshell-python/ifcopenshell/api/material/unassign_material.py index 60fac1382e..5f88963c36 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/material/unassign_material.py +++ b/src/ifcopenshell-python/ifcopenshell/api/material/unassign_material.py @@ -32,7 +32,7 @@ class Usecase: If the product does not have a material, nothing happens. :param products: The list IfcProducts that may or may not have a material - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/nest/assign_object.py b/src/ifcopenshell-python/ifcopenshell/api/nest/assign_object.py index 5617d39f06..1c9ab8c9b0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/nest/assign_object.py +++ b/src/ifcopenshell-python/ifcopenshell/api/nest/assign_object.py @@ -80,13 +80,13 @@ class Usecase: :param related_objects: The list of children of the nesting relationship, typically IfcElements. - :type related_objects: list[ifcopenshell.entity_instance.entity_instance] + :type related_objects: list[ifcopenshell.entity_instance] :param relating_object: The host parent of the nesting relationship, typically an IfcElement. - :type relating_object: ifcopenshell.entity_instance.entity_instance + :type relating_object: ifcopenshell.entity_instance :return: The IfcRelNests relationship instance or `None` if `related_objects` was empty list. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/nest/unassign_object.py b/src/ifcopenshell-python/ifcopenshell/api/nest/unassign_object.py index 1c986f2cd0..b9f48b4b5b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/nest/unassign_object.py +++ b/src/ifcopenshell-python/ifcopenshell/api/nest/unassign_object.py @@ -32,7 +32,7 @@ class Usecase: :param related_objects: The list of children of the nesting relationship, typically IfcElements. - :type related_objects: list[ifcopenshell.entity_instance.entity_instance] + :type related_objects: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_actor.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_actor.py index 9325638d96..c3ff65c3d1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_actor.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_actor.py @@ -42,11 +42,11 @@ class Usecase: IfcPerson if it is a sole individual, or an IfcPersonAndOrganization if a specific person is liable within an organisation and must be legally nominated. - :type actor: ifcopenshell.entity_instance.entity_instance + :type actor: ifcopenshell.entity_instance :param ifc_class: Either "IfcActor" or "IfcOccupant". :type ifc_class: str, optional :return: The newly created IfcActor or IfcOccupant - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_address.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_address.py index 3a9c3e6c14..b184408fa9 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_address.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_address.py @@ -33,12 +33,12 @@ class Usecase: :param assigned_object: The IfcOrganization or IfcPerson the contact address belongs to. - :type assigned_object: ifcopenshell.entity_instance.entity_instance + :type assigned_object: ifcopenshell.entity_instance :param ifc_class: Either IfcPostalAddress or IfcTelecomAddress. Defaults to IfcPostalAddress. :type ifc_class: str, optional :return: The new IfcPostalAddress or IfcTelecomAddress - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_application.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_application.py index 792096ef9d..92861a3417 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_application.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_application.py @@ -39,7 +39,7 @@ class Usecase: :param application_developer: The IfcOrganization responsible for creating the application. Defaults to generating an IfcOpenShell organisation if none is provided. - :type application_developer: ifcopenshell.entity_instance.entity_instance, optional + :type application_developer: ifcopenshell.entity_instance, optional :param version: The version of the application. Defaults to the ifcopenshell.version data if not specified. :type version: str, optional diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_organisation.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_organisation.py index 0e6f676fbc..2127acd570 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_organisation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_organisation.py @@ -34,7 +34,7 @@ class Usecase: :param name: The legal name of the organisation :type name: str, optional :return: The newly created IfcOrganization - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_person.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_person.py index 268568c80d..a607d8af29 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_person.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_person.py @@ -39,7 +39,7 @@ class Usecase: :param given_name: The given name :type given_name: str, optional :return: The newly created IfcPerson - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_person_and_organisation.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_person_and_organisation.py index 3e0b372690..a5987b4b76 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_person_and_organisation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_person_and_organisation.py @@ -32,11 +32,11 @@ class Usecase: :param person: The IfcPerson being the representative of the organisation. - :type person: ifcopenshell.entity_instance.entity_instance + :type person: ifcopenshell.entity_instance :param organisation: The IfcOrganization itself. - :type organisation: ifcopenshell.entity_instance.entity_instance + :type organisation: ifcopenshell.entity_instance :return: The newly created IfcPersonAndOrganization - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/add_role.py b/src/ifcopenshell-python/ifcopenshell/api/owner/add_role.py index 1a18e3c403..3b1369877c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/add_role.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/add_role.py @@ -31,12 +31,12 @@ class Usecase: :param assigned_object: The IfcPerson or IfcOrganization the role should be assigned to. - :type assigned_object: ifcopenshell.entity_instance.entity_instance + :type assigned_object: ifcopenshell.entity_instance :param role: The type of role, taken from the IFC documentation for IfcActorRole, or a custom name. :type role: str, optional :return: The newly created IfcActorRole - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/assign_actor.py b/src/ifcopenshell-python/ifcopenshell/api/owner/assign_actor.py index 395818e922..1085adeb34 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/assign_actor.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/assign_actor.py @@ -41,11 +41,11 @@ class Usecase: ifcopenshell.api.resource.assign_resource. :param relating_actor: The IfcActor who is responsible for the object. - :type relating_actor: ifcopenshell.entity_instance.entity_instance + :type relating_actor: ifcopenshell.entity_instance :param related_object: The object the actor is responsible for. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The newly created IfcRelAssignsToActor relationship. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/create_owner_history.py b/src/ifcopenshell-python/ifcopenshell/api/owner/create_owner_history.py index 31491feeaa..94183e0c6b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/create_owner_history.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/create_owner_history.py @@ -62,7 +62,7 @@ class Usecase: :return: The newly created IfcOwnerHistory element or `None` if it's not IFC2X3 and user or application is not found in the current project. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_actor.py b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_actor.py index 87638e6e44..eb6491b359 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_actor.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_actor.py @@ -25,7 +25,7 @@ class Usecase: IfcActor, consult the IFC documentation. :param actor: The IfcActor entity you want to edit - :type actor: ifcopenshell.entity_instance.entity_instance + :type actor: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_address.py b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_address.py index 5ecda0ec03..0f48af25d5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_address.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_address.py @@ -25,7 +25,7 @@ class Usecase: IfcAddress, consult the IFC documentation. :param address: The IfcAddress entity you want to edit - :type address: ifcopenshell.entity_instance.entity_instance + :type address: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_organisation.py b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_organisation.py index 03289d6f14..19c8d1e431 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_organisation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_organisation.py @@ -25,7 +25,7 @@ class Usecase: IfcOrganization, consult the IFC documentation. :param organisation: The IfcOrganization entity you want to edit - :type organisation: ifcopenshell.entity_instance.entity_instance + :type organisation: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_person.py b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_person.py index 931cdb0c82..19eedc23db 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_person.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_person.py @@ -25,7 +25,7 @@ class Usecase: IfcPerson, consult the IFC documentation. :param person: The IfcPerson entity you want to edit - :type person: ifcopenshell.entity_instance.entity_instance + :type person: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_role.py b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_role.py index 6e96df744f..160f6f6d91 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/edit_role.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/edit_role.py @@ -25,7 +25,7 @@ class Usecase: IfcActorRole, consult the IFC documentation. :param role: The IfcActorRole entity you want to edit - :type role: ifcopenshell.entity_instance.entity_instance + :type role: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_actor.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_actor.py index 2f48ded614..ac99299a6f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_actor.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_actor.py @@ -25,7 +25,7 @@ class Usecase: """Removes an actor :param actor: The IfcActor to remove. - :type actor: ifcopenshell.entity_instance.entity_instance + :type actor: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_address.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_address.py index 1bb9247c0d..728ffb45f5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_address.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_address.py @@ -25,7 +25,7 @@ class Usecase: relationship removed. :param address: The IfcAddress to remove. - :type address: ifcopenshell.entity_instance.entity_instance + :type address: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_application.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_application.py index 63e8092338..7e21c07943 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_application.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_application.py @@ -25,7 +25,7 @@ class Usecase: Check whether or not the application is used anywhere prior to removal. :param address: The IfcApplication to remove. - :type address: ifcopenshell.entity_instance.entity_instance + :type address: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_organisation.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_organisation.py index e5c7b36d8b..e9e2c77e9e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_organisation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_organisation.py @@ -27,7 +27,7 @@ class Usecase: removed. :param organisation: The IfcOrganization to remove - :type organisation: ifcopenshell.entity_instance.entity_instance + :type organisation: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person.py index af82abf989..8e1ba7a972 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person.py @@ -27,7 +27,7 @@ class Usecase: removed. :param person: The IfcPerson to remove - :type person: ifcopenshell.entity_instance.entity_instance + :type person: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person_and_organisation.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person_and_organisation.py index 6e12917d72..fc85722e68 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person_and_organisation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_person_and_organisation.py @@ -27,7 +27,7 @@ class Usecase: the "person and organisation" group. :param person_and_organisation: The IfcPersonAndOrganization to remove. - :type person_and_organisation: ifcopenshell.entity_instance.entity_instance + :type person_and_organisation: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_role.py b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_role.py index 3e6a6cc721..5de9915c33 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/remove_role.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/remove_role.py @@ -25,7 +25,7 @@ class Usecase: leave some of them without roles. :param role: The IfcActorRole to remove. - :type role: ifcopenshell.entity_instance.entity_instance + :type role: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/settings.py b/src/ifcopenshell-python/ifcopenshell/api/owner/settings.py index 6c0e6a456f..493f4077f4 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/settings.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/settings.py @@ -30,9 +30,9 @@ def get_application(ifc: ifcopenshell.file) -> Union[ifcopenshell.entity_instanc IfcApplication. See ifcopenshell.api.owner.create_owner_history for details. :param ifc: The IFC file object that is being edited. - :type ifc: ifcopenshell.file.file + :type ifc: ifcopenshell.file :return: The IfcApplication with metadata of the authoring software. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ app = ifc.by_type("IfcApplication") if not app and ifc.schema == "IFC2X3": @@ -50,9 +50,9 @@ def get_user(ifc: ifcopenshell.file) -> Union[ifcopenshell.entity_instance, None IfcApplication. See ifcopenshell.api.owner.create_owner_history for details. :param ifc: The IFC file object that is being edited. - :type ifc: ifcopenshell.file.file + :type ifc: ifcopenshell.file :return: The IfcPersonAndOrganization with metadata of the authoring user. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ pao = ifc.by_type("IfcPersonAndOrganization") if not pao and ifc.schema == "IFC2X3": diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/unassign_actor.py b/src/ifcopenshell-python/ifcopenshell/api/owner/unassign_actor.py index aadb6426c9..711732bcdc 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/unassign_actor.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/unassign_actor.py @@ -28,12 +28,12 @@ class Usecase: This means that the actor is no longer responsible for the object. :param relating_actor: The IfcActor who is responsible for the object. - :type relating_actor: ifcopenshell.entity_instance.entity_instance + :type relating_actor: ifcopenshell.entity_instance :param related_object: The object the actor is responsible for. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The updated IfcRelAssignsToActor relationship or none if there is no more valid relationship. - :rtype: None, ifcopenshell.entity_instance.entity_instance + :rtype: None, ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/owner/update_owner_history.py b/src/ifcopenshell-python/ifcopenshell/api/owner/update_owner_history.py index 27230372fb..797d1b8b57 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/owner/update_owner_history.py +++ b/src/ifcopenshell-python/ifcopenshell/api/owner/update_owner_history.py @@ -34,9 +34,9 @@ class Usecase: :param element: The IfcRoot element to update the ownership details on when a change is made. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :return: The updated IfcOwnerHistory element. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile.py b/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile.py index edf1d22408..8cced9d934 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile.py @@ -37,7 +37,7 @@ class Usecase: this may be left as none. :type name: str, optional :return: The newly created IfcArbitraryClosedProfileDef - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile_with_voids.py b/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile_with_voids.py index a33b4d38be..7c1af83294 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile_with_voids.py +++ b/src/ifcopenshell-python/ifcopenshell/api/profile/add_arbitrary_profile_with_voids.py @@ -44,7 +44,7 @@ class Usecase: this may be left as none. :type name: str, optional :return: The newly created IfcArbitraryProfileDefWithVoids - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/profile/add_parameterized_profile.py b/src/ifcopenshell-python/ifcopenshell/api/profile/add_parameterized_profile.py index 6b8c3786c6..0201095feb 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/profile/add_parameterized_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/profile/add_parameterized_profile.py @@ -26,13 +26,13 @@ class Usecase: the IFC documentation as subclasses of IfcParameterizedProfileDef. Currently, this API has no benefit over directly calling - ifcopenshell.file.file.create_entity. + ifcopenshell.file.create_entity. :param ifc_class: The subclass of IfcParameterizedProfileDef that you'd like to create. :type ifc_class: str :return: The newly created element depending on the specified ifc_class. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/profile/edit_profile.py b/src/ifcopenshell-python/ifcopenshell/api/profile/edit_profile.py index 489bf0b5fa..759a5d4c7d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/profile/edit_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/profile/edit_profile.py @@ -25,7 +25,7 @@ class Usecase: IfcProfileDef, consult the IFC documentation. :param profile: The IfcProfileDef entity you want to edit - :type profile: ifcopenshell.entity_instance.entity_instance + :type profile: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/profile/remove_profile.py b/src/ifcopenshell-python/ifcopenshell/api/profile/remove_profile.py index ce037686e1..47d3391e00 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/profile/remove_profile.py +++ b/src/ifcopenshell-python/ifcopenshell/api/profile/remove_profile.py @@ -25,7 +25,7 @@ class Usecase: """Removes a profile :param profile: The IfcProfileDef to remove. - :type profile: ifcopenshell.entity_instance.entity_instance + :type profile: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/project/append_asset.py b/src/ifcopenshell-python/ifcopenshell/api/project/append_asset.py index b3640ca53e..3e88c7c82a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/project/append_asset.py +++ b/src/ifcopenshell-python/ifcopenshell/api/project/append_asset.py @@ -39,18 +39,18 @@ class Usecase: Do not mix units. :param library: The file object containing the asset. - :type library: ifcopenshell.file.file + :type library: ifcopenshell.file :param element: An element in the library file of the asset. It may be an IfcTypeProduct, IfcProduct, IfcMaterial, IfcCostSchedule, or IfcProfileDef. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :param reuse_identities: Optional dictionary of mapped entities' identities to the already created elements. It will be used to avoid creating duplicated inverse elements during multiple `project.append_asset` calls. If you want to add just 1 asset or if added assets won't have any shared elements, then it can be left empty. - :type reuse_identities: dict[int, ifcopenshell.entity_instance.entity_instance] + :type reuse_identities: dict[int, ifcopenshell.entity_instance] :return: The appended element - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/project/assign_declaration.py b/src/ifcopenshell-python/ifcopenshell/api/project/assign_declaration.py index be4d076de0..e6e919b77b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/project/assign_declaration.py +++ b/src/ifcopenshell-python/ifcopenshell/api/project/assign_declaration.py @@ -43,13 +43,13 @@ class Usecase: a declaration lets you say that an object belongs to a library. :param definitions: The list of objects you want to declare. Typically a list of assets. - :type definitions: list[ifcopenshell.entity_instance.entity_instance] + :type definitions: list[ifcopenshell.entity_instance] :param relating_context: The IfcProject, or more commonly the IfcProjectLibrary that you want the object to be part of. - :type relating_context: ifcopenshell.entity_instance.entity_instance + :type relating_context: ifcopenshell.entity_instance :return: The new IfcRelDeclares relationship or None if all definitions were already declared / do not support declaration. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/project/create_file.py b/src/ifcopenshell-python/ifcopenshell/api/project/create_file.py index 45ce3d6c6a..1b3e644cbd 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/project/create_file.py +++ b/src/ifcopenshell-python/ifcopenshell/api/project/create_file.py @@ -37,7 +37,7 @@ class Usecase: schema, you may specify that schema identifier here too. :type version: str, optional :return: The created IFC file object. - :rtype: ifcopenshell.file.file + :rtype: ifcopenshell.file Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/project/unassign_declaration.py b/src/ifcopenshell-python/ifcopenshell/api/project/unassign_declaration.py index 47c5194bdd..8f8e726570 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/project/unassign_declaration.py +++ b/src/ifcopenshell-python/ifcopenshell/api/project/unassign_declaration.py @@ -34,10 +34,10 @@ class Usecase: :param definitions: The list of objects you want to undeclare. Typically a list of assets. - :type definitions: list[ifcopenshell.entity_instance.entity_instance] + :type definitions: list[ifcopenshell.entity_instance] :param relating_context: The IfcProject, or more commonly the IfcProjectLibrary that you want the object to no longer be part of. - :type relating_context: ifcopenshell.entity_instance.entity_instance + :type relating_context: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset/add_pset.py b/src/ifcopenshell-python/ifcopenshell/api/pset/add_pset.py index ac498e413d..1fd1a0c61a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset/add_pset.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset/add_pset.py @@ -53,7 +53,7 @@ class Usecase: data, rather than arbitrary metadata. :param product: The IfcObject that you want to assign a property set to. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param name: The name of the property set. Property sets that are standardised by buildingSMART typically have a prefix of "Pset_", like "Pset_WallCommon". If you create your own, you must not use @@ -61,7 +61,7 @@ class Usecase: your project, company, or local government requirement. :type name: str :return: The newly created IfcPropertySet - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset/add_qto.py b/src/ifcopenshell-python/ifcopenshell/api/pset/add_qto.py index 9e7d9eee78..a3c7b54299 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset/add_qto.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset/add_qto.py @@ -49,7 +49,7 @@ class Usecase: metadata, rather than quantification data. :param product: The IfcObject that you want to assign a quantity set to. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param name: The name of the quantity set. Quantity sets that are standardised by buildingSMART typically have a prefix of "Qto_", like "Qto_WallBaseQuantities". If you create your own, you must not @@ -57,7 +57,7 @@ class Usecase: to your project, company, or local government requirement. :type name: str :return: The newly created IfcElementQuantity - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset/edit_pset.py b/src/ifcopenshell-python/ifcopenshell/api/pset/edit_pset.py index 81b57db874..0eb711b803 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset/edit_pset.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset/edit_pset.py @@ -52,7 +52,7 @@ class Usecase: to ensure that data types are always consistent and correct. :param pset: The IfcPropertySet to edit. - :type pset: ifcopenshell.entity_instance.entity_instance + :type pset: ifcopenshell.entity_instance :param name: A new name for the property set. If no name is specified, the property set name is not changed. :type name: str, optional @@ -69,7 +69,7 @@ class Usecase: :param pset_template: If a property set template is provided, this will be used to determine data types. If no user-defined template is provided, the built-in buildingSMART templates will be loaded. - :type pset_template: ifcopenshell.entity_instance.entity_instance + :type pset_template: ifcopenshell.entity_instance :param should_purge: If left as False, properties set to None will be left as None but not removed. If set to true, properties set to None will actually be removed. diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset/edit_qto.py b/src/ifcopenshell-python/ifcopenshell/api/pset/edit_qto.py index 820f8d858f..cd5a3bca05 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset/edit_qto.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset/edit_qto.py @@ -34,7 +34,7 @@ class Usecase: It is not allowed to have None quantities in IFC. :param qto: The IfcElementQuantity to edit. - :type qto: ifcopenshell.entity_instance.entity_instance + :type qto: ifcopenshell.entity_instance :param name: A new name for the quantity set. If no name is specified, the quantity set name is not changed. :type name: str, optional @@ -51,7 +51,7 @@ class Usecase: :param pset_template: If a quantity set template is provided, this will be used to determine data types. If no user-defined template is provided, the built-in buildingSMART templates will be loaded. - :type pset_template: ifcopenshell.entity_instance.entity_instance + :type pset_template: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset/remove_pset.py b/src/ifcopenshell-python/ifcopenshell/api/pset/remove_pset.py index b71be041f8..da77accbb6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset/remove_pset.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset/remove_pset.py @@ -27,9 +27,9 @@ class Usecase: All properties that are part of this property set are also removed. :param product: The IfcObject to remove the property set from. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param pset: The IfcPropertySet or IfcElementQuantity to remove. - :type pset: ifcopenshell.entity_instance.entity_instance + :type pset: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_prop_template.py b/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_prop_template.py index 569b2bcdd5..5a9dc42355 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_prop_template.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_prop_template.py @@ -57,7 +57,7 @@ class Usecase: :param pset_template: The property set template to add the property template to. - :type pset_template: ifcopenshell.entity_instance.entity_instance + :type pset_template: ifcopenshell.entity_instance :param name: The name of the property :type name: str,optional :param description: A few words describing what the property stores. @@ -66,7 +66,7 @@ class Usecase: IFC documentation for the full list of data types. :param primary_measure_type: str,optional :return: The newly created IfcSimplePropertyTemplate. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_pset_template.py b/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_pset_template.py index 4611dfb48e..242f7b7510 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_pset_template.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset_template/add_pset_template.py @@ -84,7 +84,7 @@ class Usecase: property set may be assigned to any type. :type applicable_entity: str,optional :return: The newly created IfcPropertySetTemplate - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_prop_template.py b/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_prop_template.py index 1ddc18f7dc..6b2633992f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_prop_template.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_prop_template.py @@ -25,7 +25,7 @@ class Usecase: IfcSimplePropertyTemplate, consult the IFC documentation. :param prop_template: The IfcSimplePropertyTemplate entity you want to edit - :type prop_template: ifcopenshell.entity_instance.entity_instance + :type prop_template: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_pset_template.py b/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_pset_template.py index 29d99753a4..303618f509 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_pset_template.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset_template/edit_pset_template.py @@ -25,7 +25,7 @@ class Usecase: IfcPropertySetTemplate, consult the IFC documentation. :param pset_template: The IfcPropertySetTemplate entity you want to edit - :type pset_template: ifcopenshell.entity_instance.entity_instance + :type pset_template: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_prop_template.py b/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_prop_template.py index 1bb5650dfc..6479e6ffc2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_prop_template.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_prop_template.py @@ -28,7 +28,7 @@ class Usecase: templates. :param prop_template: The IfcSimplePropertyTemplate to remove. - :type prop_template: ifcopenshell.entity_instance.entity_instance + :type prop_template: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_pset_template.py b/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_pset_template.py index 93bb120dbe..4cb2c2695a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_pset_template.py +++ b/src/ifcopenshell-python/ifcopenshell/api/pset_template/remove_pset_template.py @@ -27,7 +27,7 @@ class Usecase: along with it. :param pset_template: The IfcPropertySetTemplate to remove. - :type pset_template: ifcopenshell.entity_instance.entity_instance + :type pset_template: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource.py b/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource.py index f2c3bf99ee..03a67ab648 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource.py @@ -50,7 +50,7 @@ class Usecase: :param parent_resource: If this is a child resource (typically to a crew resource), then nominate the parent IfcConstructionResource here. - :type parent_resource: ifcopenshell.entity_instance.entity_instance + :type parent_resource: ifcopenshell.entity_instance :param ifc_class: The class of resource chosen from IfcConstructionEquipmentResource, IfcConstructionMaterialResource, IfcConstructionProductResource, IfcCrewResource, IfcLaborResource, @@ -63,7 +63,7 @@ class Usecase: :type predefined_type: str,optional :return: The newly created resource depending on the nominated IFC class. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_quantity.py index 55fb80902d..4e5ef0c0a0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_quantity.py @@ -34,7 +34,7 @@ class Usecase: This base quantity is then used in other calculations. :param resource: The IfcConstructionResource to add a quantity to. - :type resource: ifcopenshell.entity_instance.entity_instance + :type resource: ifcopenshell.entity_instance :param ifc_class: The type of quantity to add, chosen from IfcQuantityArea (for material), IfcQuantityCount (for products), IfcQuantityLength (for material), IfcQuantityTime (for equipment or @@ -42,7 +42,7 @@ class Usecase: (for material). :type ifc_class: str,optional :return: The newly created quantity depending on the IFC class - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_time.py b/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_time.py index 8407555e35..8627e319a7 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/add_resource_time.py @@ -29,9 +29,9 @@ class Usecase: be used to calculate other parameters like resource utilisation. :param resource: The IfcConstructionResource to record time for. - :type resource: ifcopenshell.entity_instance.entity_instance + :type resource: ifcopenshell.entity_instance :return: The newly created IfcResourceTime - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/assign_resource.py b/src/ifcopenshell-python/ifcopenshell/api/resource/assign_resource.py index 121a565177..f71ec00260 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/assign_resource.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/assign_resource.py @@ -38,12 +38,12 @@ class Usecase: (e.g. if the resource is a labour resource). :param relating_resource: The IfcResource to assign the object to. - :type relating_resource: ifcopenshell.entity_instance.entity_instance + :type relating_resource: ifcopenshell.entity_instance :param related_object: The IfcProduct or IfcActor to assign to the object. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The newly created IfcRelAssignsToResource - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/calculate_resource_work.py b/src/ifcopenshell-python/ifcopenshell/api/resource/calculate_resource_work.py index a23cddd09e..746f0d88c0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/calculate_resource_work.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/calculate_resource_work.py @@ -52,7 +52,7 @@ class Usecase: :param resource: The IfcConstructionResource that you want to calculate the work performed. - :type resource: ifcopenshell.entity_instance.entity_instance + :type resource: ifcopenshell.entity_instance :return None: :rtype: None: """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource.py b/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource.py index 34be65fea5..c28f4c0661 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource.py @@ -25,7 +25,7 @@ class Usecase: IfcResource, consult the IFC documentation. :param resource: The IfcResource entity you want to edit - :type resource: ifcopenshell.entity_instance.entity_instance + :type resource: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_quantity.py b/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_quantity.py index f88ed466fd..0785caa02e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_quantity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_quantity.py @@ -25,7 +25,7 @@ class Usecase: IfC quantity, consult the IFC documentation. :param physical_quantity: The IfC quantity entity you want to edit - :type physical_quantity: ifcopenshell.entity_instance.entity_instance + :type physical_quantity: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_time.py b/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_time.py index 6a4b2029d4..c9db827a89 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/edit_resource_time.py @@ -28,7 +28,7 @@ class Usecase: IfcResourceTime, consult the IFC documentation. :param resource_time: The IfcResourceTime entity you want to edit - :type resource_time: ifcopenshell.entity_instance.entity_instance + :type resource_time: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/resource/unassign_resource.py b/src/ifcopenshell-python/ifcopenshell/api/resource/unassign_resource.py index 50c8661ecd..ceed0dbf2a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/resource/unassign_resource.py +++ b/src/ifcopenshell-python/ifcopenshell/api/resource/unassign_resource.py @@ -26,12 +26,12 @@ class Usecase: """Removes the relationship between a resource and object :param relating_resource: The IfcResource to assign the object to. - :type relating_resource: ifcopenshell.entity_instance.entity_instance + :type relating_resource: ifcopenshell.entity_instance :param related_object: The IfcProduct or IfcActor to assign to the object. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The newly created IfcRelAssignsToResource - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/root/copy_class.py b/src/ifcopenshell-python/ifcopenshell/api/root/copy_class.py index 7ffbdc38fa..389930d409 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/root/copy_class.py +++ b/src/ifcopenshell-python/ifcopenshell/api/root/copy_class.py @@ -50,9 +50,9 @@ class Usecase: connections are still valid. :param product: The IfcProduct to copy. - :type param: ifcopenshell.entity_instance.entity_instance + :type param: ifcopenshell.entity_instance :return: The copied product - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/root/create_entity.py b/src/ifcopenshell-python/ifcopenshell/api/root/create_entity.py index 8599c00472..7619eec067 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/root/create_entity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/root/create_entity.py @@ -52,7 +52,7 @@ class Usecase: :param name: The name of the new element. :type name: str,optional :return: The newly created element based on the specified IFC class. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/root/reassign_class.py b/src/ifcopenshell-python/ifcopenshell/api/root/reassign_class.py index c87df1e8e4..1035a6b17c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/root/reassign_class.py +++ b/src/ifcopenshell-python/ifcopenshell/api/root/reassign_class.py @@ -48,14 +48,14 @@ class Usecase: this. :param product: The IfcProduct that you want to change the class of. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param ifc_class: The new IFC class you want to change it to. :type ifc_class: str,optional :param predefined_type: In case you want to change the predefined type too. User defined types are also allowed, just type what you want. :type predefined_type: str,optional :return: The newly modified product. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/root/remove_product.py b/src/ifcopenshell-python/ifcopenshell/api/root/remove_product.py index 179e7ca572..cecb5544f3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/root/remove_product.py +++ b/src/ifcopenshell-python/ifcopenshell/api/root/remove_product.py @@ -42,7 +42,7 @@ class Usecase: naturally, the materials, types, containers, etc themselves remain). :param product: The element to remove. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task.py index bf42853d2c..60ab48c6df 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task.py @@ -67,11 +67,11 @@ class Usecase: :param work_schedule: The work schedule to group the task in, if the task is to be a top-level or root task. This is mutually exclusive with the parent_task parameter. - :type work_schedule: ifcopenshell.entity_instance.entity_instance + :type work_schedule: ifcopenshell.entity_instance :param parent_task: The parent task, if the task is to be a subtask or child task. This is mutually exclusive with the work_schedule parameter. - :type parent_task: ifcopenshell.entity_instance.entity_instance + :type parent_task: ifcopenshell.entity_instance :param name: The name of the task. :type name: str,optional :param description: The description of the task. @@ -83,7 +83,7 @@ class Usecase: IFC documentation for IfcTaskTypeEnum for more information. :type predefined_type: str :return: The newly created IfcTask - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task_time.py index a1638d2b04..7c4381c361 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_task_time.py @@ -27,11 +27,11 @@ class Usecase: (especially for maintenance tasks). :param task: The task to add time data to. - :type task: ifcopenshell.entity_instance.entity_instance + :type task: ifcopenshell.entity_instance :param is_recurring: Whether or not the time should recur. :type is_recurring: bool :return: The newly created IfcTaskTime. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_time_period.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_time_period.py index a69e22fa0f..35a022a9ea 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_time_period.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_time_period.py @@ -39,7 +39,7 @@ class Usecase: :param recurrence_pattern: The IfcRecurrencePattern to add the time period to. See ifcopenshell.api.sequence.assign_recurrence_pattern. - :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance + :type recurrence_pattern: ifcopenshell.entity_instance :param start_time: The start time of the time period, in a format compatible with IfcTime, such as an ISO format time string or a datetime.time object. @@ -49,7 +49,7 @@ class Usecase: datetime.time object. :type end_time: str,datetime.time :return: The newly created IfcTimePeriod - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_calendar.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_calendar.py index 9df45247c5..373d628be6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_calendar.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_calendar.py @@ -41,7 +41,7 @@ class Usecase: specifically define shifts, such as FIRSTSHIFT, SECONDSHIFT, or THIRDSHIFT. Leave as NOTDEFINED for basic calendar usage. :return: The newly created IfcWorkCalendar - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_plan.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_plan.py index 4e907a0ad5..f6fba71315 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_plan.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_plan.py @@ -42,7 +42,7 @@ class Usecase: within the work plan are relevant. :type start_time: str,datetime.time :return: The newly created IfcWorkPlan - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_schedule.py index f50745471f..47e96a8fa3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_schedule.py @@ -50,9 +50,9 @@ class Usecase: provided, the schedule will not be grouped in a work plan and would exist as a top level schedule in the project. This is not recommended. - :type work_plan: ifcopenshell.entity_instance.entity_instance,optional + :type work_plan: ifcopenshell.entity_instance,optional :return: The newly created IfcWorkSchedule - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_time.py index 6afafad753..0d75914949 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/add_work_time.py @@ -31,12 +31,12 @@ class Usecase: :param work_calendar: The IfcWorkCalendar to add the work or holiday time definition to. - :type work_calendar: ifcopenshell.entity_instance.entity_instance + :type work_calendar: ifcopenshell.entity_instance :param time_type: Either WorkingTimes or ExceptionTimes, depending on what you want to define. :type time_type: str :return: The newly created IfcWorkTime - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_lag_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_lag_time.py index cc1abf7409..87f2882055 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_lag_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_lag_time.py @@ -33,7 +33,7 @@ class Usecase: are allowed. :param rel_sequence: The IfcRelSequence to assign the lag time to. - :type rel_sequence: ifcopenshell.entity_instance.entity_instance + :type rel_sequence: ifcopenshell.entity_instance :param lag_value: An ISO standardised duration string. :type lag_value: str :param duration_type: Choose from WORKTIME for the associated @@ -43,7 +43,7 @@ class Usecase: is unclear. :type duration_type: str :return: The newly created IfcLagTime - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_process.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_process.py index ea758b9182..5aa2210d42 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_process.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_process.py @@ -61,12 +61,12 @@ class Usecase: :param relating_process: The IfcProcess (typically IfcTask) that the input, control, or resource is related to. - :type relating_process: ifcopenshell.entity_instance.entity_instance + :type relating_process: ifcopenshell.entity_instance :param related_object: The IfcProduct (for input), IfcCostItem (for control) or IfcConstructionResource (for resource). - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The newly created IfcRelAssignsToProcess relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_product.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_product.py index d8003227d1..3431a71f19 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_product.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_product.py @@ -37,12 +37,12 @@ class Usecase: :param relating_product: The IfcProduct that was constructed as a result of the task. - :type relating_product: ifcopenshell.entity_instance.entity_instance + :type relating_product: ifcopenshell.entity_instance :param related_object: The IfcProcess (typically IfcTask) of the construction task. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: The newly created IfcRelAssignsToProduct relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_recurrence_pattern.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_recurrence_pattern.py index a940e4f224..a3243f1057 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_recurrence_pattern.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_recurrence_pattern.py @@ -60,11 +60,11 @@ class Usecase: :param parent: Either an IfcTaskTimeRecurring if you are defining a recurring schedule for a task, or IfcWorkTime if you are defining a recurring pattern for a workdays or holidays in a calendar. - :type parent: ifcopenshell.entity_instance.entity_instance + :type parent: ifcopenshell.entity_instance :param recurrence_type: One of the types of recurrences. :type recurrence_type: str :return: The newly created IfcRecurrencePattern - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_sequence.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_sequence.py index 078f5b7f5c..e1c1100760 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_sequence.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_sequence.py @@ -51,13 +51,13 @@ class Usecase: predecessor and successor tasks in the planning profession. :param relating_process: The previous / predecessor task. - :type relating_process: ifcopenshell.entity_instance.entity_instance + :type relating_process: ifcopenshell.entity_instance :param related_process: The next / successor task. - :type related_process: ifcopenshell.entity_instance.entity_instance + :type related_process: ifcopenshell.entity_instance :param sequence_type: Choose from FINISH_START, FINISH_FINISH, START_START, or START_FINISH. :return: The newly created IfcRelSequence - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_workplan.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_workplan.py index b3573db5d5..a1eaed71be 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_workplan.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/assign_workplan.py @@ -29,11 +29,11 @@ class Usecase: :param work_schedule: The IfcWorkSchedule that will be assigned to the work plan. - :type work_schedule: ifcopenshell.entity_instance.entity_instance + :type work_schedule: ifcopenshell.entity_instance :param work_plan: The IfcWorkPlan for the schedule to be assigned to. - :type work_plan: ifcopenshell.entity_instance.entity_instance + :type work_plan: ifcopenshell.entity_instance :return: The IfcRelAggregates relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/calculate_task_duration.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/calculate_task_duration.py index 671113f9f1..6698ab85a2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/calculate_task_duration.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/calculate_task_duration.py @@ -36,7 +36,7 @@ class Usecase: then nothing happens. :param task: The IfcTask to calculate the duration for. - :type task: ifcopenshell.entity_instance.entity_instance + :type task: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/cascade_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/cascade_schedule.py index a069bb4901..2a720b9fa1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/cascade_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/cascade_schedule.py @@ -42,7 +42,7 @@ class Usecase: be equivalent to be Tuesday 8am, for instance. :param task: The start task to begin cascading from. - :type task: ifcopenshell.entity_instance.entity_instance + :type task: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/create_baseline.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/create_baseline.py index 8f6e82c750..c0ebe4f72f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/create_baseline.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/create_baseline.py @@ -37,9 +37,9 @@ class Usecase: * Same Resource Relationships :param work_schedule: The planned work_schedule to baseline - :type work_schedule: ifcopenshell.entity_instance.entity_instance + :type work_schedule: ifcopenshell.entity_instance :return: The baseline work_schedule - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: .. code:: python diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/duplicate_task.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/duplicate_task.py index 195c5c71cd..91d5ed1b99 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/duplicate_task.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/duplicate_task.py @@ -33,9 +33,9 @@ class Usecase: * The copy will have duplicated nested tasks :param task: The task to be duplicated - :type task: ifcopenshell.entity_instance.entity_instance + :type task: ifcopenshell.entity_instance :return: The duplicated task or the list of duplicated tasks if the latter has children - :rtype: ifcopenshell.entity_instance.entity_instance or list of ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance or list of ifcopenshell.entity_instance Example: .. code:: python diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_lag_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_lag_time.py index 5f9a2dfcb4..f5779b058c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_lag_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_lag_time.py @@ -28,7 +28,7 @@ class Usecase: IfcLagTime, consult the IFC documentation. :param lag_time: The IfcLagTime entity you want to edit - :type lag_time: ifcopenshell.entity_instance.entity_instance + :type lag_time: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_recurrence_pattern.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_recurrence_pattern.py index f5eb567f6d..21292233ad 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_recurrence_pattern.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_recurrence_pattern.py @@ -28,7 +28,7 @@ class Usecase: IfcRecurrencePattern, consult the IFC documentation. :param recurrence_pattern: The IfcRecurrencePattern entity you want to edit - :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance + :type recurrence_pattern: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_sequence.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_sequence.py index 56c38d52ea..c563cb6990 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_sequence.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_sequence.py @@ -28,7 +28,7 @@ class Usecase: IfcRelSequence, consult the IFC documentation. :param rel_sequence: The IfcRelSequence entity you want to edit - :type rel_sequence: ifcopenshell.entity_instance.entity_instance + :type rel_sequence: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task.py index d6ffdd5d17..cbdaa18de0 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task.py @@ -25,7 +25,7 @@ class Usecase: IfcTask, consult the IFC documentation. :param task: The IfcTask entity you want to edit - :type task: ifcopenshell.entity_instance.entity_instance + :type task: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task_time.py index 68b5d59bbb..10bec7909c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_task_time.py @@ -36,7 +36,7 @@ class Usecase: IfcTaskTime, consult the IFC documentation. :param task_time: The IfcTaskTime entity you want to edit - :type task_time: ifcopenshell.entity_instance.entity_instance + :type task_time: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_calendar.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_calendar.py index cdfec38271..12ce1e15d1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_calendar.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_calendar.py @@ -25,7 +25,7 @@ class Usecase: IfcWorkCalendar, consult the IFC documentation. :param work_calendar: The IfcWorkCalendar entity you want to edit - :type work_calendar: ifcopenshell.entity_instance.entity_instance + :type work_calendar: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_plan.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_plan.py index 39c426e2b8..669ef0193c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_plan.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_plan.py @@ -27,7 +27,7 @@ class Usecase: IfcWorkPlan, consult the IFC documentation. :param work_plan: The IfcWorkPlan entity you want to edit - :type work_plan: ifcopenshell.entity_instance.entity_instance + :type work_plan: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_schedule.py index e520b49419..cd7ca163b2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_schedule.py @@ -27,7 +27,7 @@ class Usecase: IfcWorkSchedule, consult the IFC documentation. :param work_schedule: The IfcWorkSchedule entity you want to edit - :type work_schedule: ifcopenshell.entity_instance.entity_instance + :type work_schedule: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_time.py index 4512789fdb..d62c3a5357 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/edit_work_time.py @@ -33,7 +33,7 @@ class Usecase: IfcWorkTime, consult the IFC documentation. :param work_time: The IfcWorkTime entity you want to edit - :type work_time: ifcopenshell.entity_instance.entity_instance + :type work_time: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/get_related_products.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/get_related_products.py index 26ad4af7fa..eb8af300d1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/get_related_products.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/get_related_products.py @@ -27,12 +27,12 @@ class Usecase: utility module. :param relating_product: One of the products already output by the task. - :type relating_product: ifcopenshell.entity_instance.entity_instance + :type relating_product: ifcopenshell.entity_instance :param related_object: The IfcTask that you want to get all the related products for. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: A set of IfcProducts output by the IfcTask. - :rtype: set[ifcopenshell.entity_instance.entity_instance] + :rtype: set[ifcopenshell.entity_instance] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/recalculate_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/recalculate_schedule.py index 4039c53c57..da07337f7b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/recalculate_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/recalculate_schedule.py @@ -36,7 +36,7 @@ class Usecase: error. :param work_schedule: The IfcWorkSchedule to perform the calculation on. - :type work_schedule: ifcopenshell.entity_instance.entity_instance + :type work_schedule: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_task.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_task.py index 870efa1876..6b7fac4f75 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_task.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_task.py @@ -29,7 +29,7 @@ class Usecase: sequences or controls are also removed. :param task: The IfcTask to remove. - :type task: ifcopenshell.entity_instance.entity_instance + :type task: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_time_period.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_time_period.py index 925c6289ff..32effdf4ac 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_time_period.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_time_period.py @@ -24,7 +24,7 @@ class Usecase: """Removes a time period :param time_period: The IfcTimePeriod to remove. - :type time_period: ifcopenshell.entity_instance.entity_instance + :type time_period: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_calendar.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_calendar.py index 242165c201..e233bef26d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_calendar.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_calendar.py @@ -28,7 +28,7 @@ class Usecase: calendar. :param work_calendar: The IfcWorkCalendar to remove - :type work_calendar: ifcopenshell.entity_instance.entity_instance + :type work_calendar: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_plan.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_plan.py index 905a7b9b8a..bbd631829d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_plan.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_plan.py @@ -28,7 +28,7 @@ class Usecase: removed. :param work_plan: The IfcWorkPlan to remove. - :type work_plan: ifcopenshell.entity_instance.entity_instance + :type work_plan: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_schedule.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_schedule.py index b8bbcd4616..66b69c8804 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_schedule.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_schedule.py @@ -28,7 +28,7 @@ class Usecase: All tasks in the work schedule are also removed recursively. :param work_schedule: The IfcWorkSchedule to remove. - :type work_schedule: ifcopenshell.entity_instance.entity_instance + :type work_schedule: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_time.py index 6f8e1d13eb..3898e3655a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/remove_work_time.py @@ -22,7 +22,7 @@ class Usecase: """Removes a work time :param work_time: The IfcWorkTime to remove. - :type work_time: ifcopenshell.entity_instance.entity_instance + :type work_time: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_lag_time.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_lag_time.py index 94a5fe16fb..cca278da44 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_lag_time.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_lag_time.py @@ -26,7 +26,7 @@ class Usecase: The schedule is cascaded afterwards. :param rel_sequence: The sequence to remove the lag time from. - :type rel_sequence: ifcopenshell.entity_instance.entity_instance + :type rel_sequence: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_process.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_process.py index 2d7a5fb10f..dfc12068d3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_process.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_process.py @@ -28,9 +28,9 @@ class Usecase: See ifcopenshell.api.sequence.assign_process for details. :param relating_process: The IfcTask in the relationship. - :type relating_process: ifcopenshell.entity_instance.entity_instance + :type relating_process: ifcopenshell.entity_instance :param related_object: The related object. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_product.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_product.py index a4dcfd6968..31d9edb0e1 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_product.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_product.py @@ -28,9 +28,9 @@ class Usecase: See ifcopenshell.api.sequence.assign_product for details. :param relating_product: The IfcProduct in the relationship. - :type relating_product: ifcopenshell.entity_instance.entity_instance + :type relating_product: ifcopenshell.entity_instance :param related_object: The IfcTask in the relationship. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_recurrence_pattern.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_recurrence_pattern.py index 7a13495289..fc74c69a95 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_recurrence_pattern.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_recurrence_pattern.py @@ -25,7 +25,7 @@ class Usecase: you remove it, be sure to clean up after yourself. :param recurrence_pattern: The IfcRecurrencePattern to remove. - :type recurrence_pattern: ifcopenshell.entity_instance.entity_instance + :type recurrence_pattern: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_sequence.py b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_sequence.py index 85afb4cd23..c7286909bd 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_sequence.py +++ b/src/ifcopenshell-python/ifcopenshell/api/sequence/unassign_sequence.py @@ -26,9 +26,9 @@ class Usecase: """Removes a sequence relationship between tasks :param relating_process: The previous / predecessor task. - :type relating_process: ifcopenshell.entity_instance.entity_instance + :type relating_process: ifcopenshell.entity_instance :param related_process: The next / successor task. - :type related_process: ifcopenshell.entity_instance.entity_instance + :type related_process: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/spatial/assign_container.py b/src/ifcopenshell-python/ifcopenshell/api/spatial/assign_container.py index 70dacdce00..9edf7ccba8 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/spatial/assign_container.py +++ b/src/ifcopenshell-python/ifcopenshell/api/spatial/assign_container.py @@ -68,13 +68,13 @@ class Usecase: previous aggregation, containment, or nesting relationships it may have. :param products: A list of physical IfcElements existing in the space. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param relating_structure: The IfcSpatialStructureElement element, such as IfcBuilding, IfcBuildingStorey, or IfcSpace that the element exists in. :return: The IfcRelContainedInSpatialStructure relationship instance or `None` if `products` was empty list. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/spatial/dereference_structure.py b/src/ifcopenshell-python/ifcopenshell/api/spatial/dereference_structure.py index 00cb94d8b3..6902018b46 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/spatial/dereference_structure.py +++ b/src/ifcopenshell-python/ifcopenshell/api/spatial/dereference_structure.py @@ -31,7 +31,7 @@ class Usecase: """Dereferences a list of products and space :param products: The list of physical IfcElements that exists in the space. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param relating_structure: The IfcSpatialStructureElement element, such as IfcBuilding, IfcBuildingStorey, or IfcSpace that the element exists in. diff --git a/src/ifcopenshell-python/ifcopenshell/api/spatial/reference_structure.py b/src/ifcopenshell-python/ifcopenshell/api/spatial/reference_structure.py index 6d8915828a..32ef580b96 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/spatial/reference_structure.py +++ b/src/ifcopenshell-python/ifcopenshell/api/spatial/reference_structure.py @@ -47,11 +47,11 @@ class Usecase: spaces simultaneously. :param products: The list of physical IfcElements that exists in the space. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param relating_structure: The IfcSpatialStructureElement element, such as IfcBuilding, IfcBuildingStorey, or IfcSpace that the element exists in. - :type relating_structure: ifcopenshell.entity_instance.entity_instance + :type relating_structure: ifcopenshell.entity_instance :return: The IfcRelReferencedInSpatialStructure relationship instance or `None` if `products` was an empty list. :rtype: Union[ifcopenshell.entity_instance, None] diff --git a/src/ifcopenshell-python/ifcopenshell/api/spatial/unassign_container.py b/src/ifcopenshell-python/ifcopenshell/api/spatial/unassign_container.py index f7c831b9fd..d1418d3be5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/spatial/unassign_container.py +++ b/src/ifcopenshell-python/ifcopenshell/api/spatial/unassign_container.py @@ -26,7 +26,7 @@ class Usecase: """Unassigns a container from products. :param product: A list of IfcProducts to remove the containment from. - :type product: list[ifcopenshell.entity_instance.entity_instance] + :type product: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_activity.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_activity.py index 9bf5888622..faf1daf366 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_activity.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_activity.py @@ -51,12 +51,12 @@ class Usecase: :type global_or_local: str :param applied_load: The IfcStructuralLoad that is applied in this activity. - :type applied_load: ifcopenshell.entity_instance.entity_instance + :type applied_load: ifcopenshell.entity_instance :param structural_member: The IfcStructuralMember that the load is applied to. - :type structural_member: ifcopenshell.entity_instance.entity_instance + :type structural_member: ifcopenshell.entity_instance :return: The newly created entity based on the ifc_class - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_analysis_model.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_analysis_model.py index 97e85464b8..39181f9a4c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_analysis_model.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_analysis_model.py @@ -31,7 +31,7 @@ class Usecase: A 3D analytical model is assumed. :return: The newly created IfcStructuralAnalysisModel - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_boundary_condition.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_boundary_condition.py index 701274f992..1cd9dfef9f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_boundary_condition.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_boundary_condition.py @@ -31,13 +31,13 @@ class Usecase: condition to. This will determine the type of condition that is created. If no connection is supplied, an orphan boundary condition will be created using the ifc_class that you specify. - :type connection: ifcopenshell.entity_instance.entity_instance,optional + :type connection: ifcopenshell.entity_instance,optional :param ifc_class: The class of IfcBoundaryCondition to create, only relevant if you do not specify a connection and want to create an orphaned boundary condition. :type ifc_class: str,optional :return: The newly created IfcBoundaryCondition - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load.py index c7d73bef6f..6d51d7dc22 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load.py @@ -34,7 +34,7 @@ class Usecase: :type ifc_class: str :return: The newly created load entity, depending on the ifc_class specified. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_case.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_case.py index 6cab9bcb45..afc4e676db 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_case.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_case.py @@ -35,7 +35,7 @@ class Usecase: IfcActionSourceTypeEnum in the IFC documentation. :type action_source: str :return: The new IfcStructuralLoadCase - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_group.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_group.py index 2758b1d589..497977fe6e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_load_group.py @@ -35,7 +35,7 @@ class Usecase: IfcActionSourceTypeEnum in the IFC documentation. :type action_source: str :return: The new IfcStructuralLoadCase - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_member_connection.py b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_member_connection.py index 2cb2b7a722..eda5fc96c2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_member_connection.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/add_structural_member_connection.py @@ -26,12 +26,12 @@ class Usecase: :param relating_structural_member: The IfcStructuralMember to have a connection added to it. - :type relating_structural_member: ifcopenshell.entity_instance.entity_instance + :type relating_structural_member: ifcopenshell.entity_instance :param related_structural_connection: The IfcStructuralConnection to add to the IfcStructuralMember. - :type related_structural_connection: ifcopenshell.entity_instance.entity_instance + :type related_structural_connection: ifcopenshell.entity_instance :return: The IfcRelConnectsStructuralMember relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/assign_structural_analysis_model.py b/src/ifcopenshell-python/ifcopenshell/api/structural/assign_structural_analysis_model.py index b0db0356be..61f771c982 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/assign_structural_analysis_model.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/assign_structural_analysis_model.py @@ -25,12 +25,12 @@ class Usecase: """Assigns a load or structural member to an analysis model :param product: The structural element that is part of the analysis. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param structural_analysis_model: The IfcStructuralAnalysisModel that the structural element is related to. - :type structural_analysis_model: ifcopenshell.entity_instance.entity_instance + :type structural_analysis_model: ifcopenshell.entity_instance :return: The IfcRelAssignsToGroup relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_analysis_model.py b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_analysis_model.py index 354196946d..39c46f6fe7 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_analysis_model.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_analysis_model.py @@ -25,7 +25,7 @@ class Usecase: IfcStructuralAnalysisModel, consult the IFC documentation. :param structural_analysis_model: The IfcStructuralAnalysisModel entity you want to edit - :type structural_analysis_model: ifcopenshell.entity_instance.entity_instance + :type structural_analysis_model: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_boundary_condition.py b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_boundary_condition.py index d7822f80cf..e6814c5242 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_boundary_condition.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_boundary_condition.py @@ -25,7 +25,7 @@ class Usecase: IfcBoundaryCondition, consult the IFC documentation. :param condition: The IfcBoundaryCondition entity you want to edit - :type condition: ifcopenshell.entity_instance.entity_instance + :type condition: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_connection_cs.py b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_connection_cs.py index 39ab992b05..a66bbb989e 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_connection_cs.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_connection_cs.py @@ -22,7 +22,7 @@ class Usecase: """Edits the coordinate system of a structural connection :param structural_item: The IfcStructuralItem you want to modify. - :type structural_item: ifcopenshell.entity_instance.entity_instance + :type structural_item: ifcopenshell.entity_instance :param axis: The unit Z axis vector defined as a list of 3 floats. Defaults to [0., 0., 1.]. :type axis: list[float] diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_item_axis.py b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_item_axis.py index e255ca6e2b..ec4b163aca 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_item_axis.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_item_axis.py @@ -22,7 +22,7 @@ class Usecase: """Edits the coordinate system of a structural connection :param structural_item: The IfcStructuralItem you want to modify. - :type structural_item: ifcopenshell.entity_instance.entity_instance + :type structural_item: ifcopenshell.entity_instance :param axis: The unit Z axis vector defined as a list of 3 floats. Defaults to [0., 0., 1.]. :type axis: list[float] diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load.py b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load.py index 2b13795b17..3adba0ade9 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load.py @@ -25,7 +25,7 @@ class Usecase: IfcStructuralLoad, consult the IFC documentation. :param structural_load: The IfcStructuralLoad entity you want to edit - :type structural_load: ifcopenshell.entity_instance.entity_instance + :type structural_load: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load_case.py b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load_case.py index 0d0985accc..cffce454bf 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load_case.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/edit_structural_load_case.py @@ -25,7 +25,7 @@ class Usecase: IfcStructuralLoadCase, consult the IFC documentation. :param load_case: The IfcStructuralLoadCase entity you want to edit - :type load_case: ifcopenshell.entity_instance.entity_instance + :type load_case: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_analysis_model.py b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_analysis_model.py index b4148687aa..4ebff6cc3d 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_analysis_model.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_analysis_model.py @@ -28,7 +28,7 @@ class Usecase: :param structural_analysis_model: The IfcStructuralAnalysisModel to remove. - :type structural_analysis_model: ifcopenshell.entity_instance.entity_instance + :type structural_analysis_model: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_boundary_condition.py b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_boundary_condition.py index f0e7b0b33f..02cfb79e3c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_boundary_condition.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_boundary_condition.py @@ -23,9 +23,9 @@ class Usecase: :param connection: The IfcStructuralConnection to remove the condition from. If omitted, it is assumed to be an orphaned condition. - :type connection: ifcopenshell.entity_instance.entity_instance,optional + :type connection: ifcopenshell.entity_instance,optional :param boundary_condition: The IfcBoundaryCondition to remove. - :type boundary_condition: ifcopenshell.entity_instance.entity_instance + :type boundary_condition: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_connection_condition.py b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_connection_condition.py index a09618575f..28ce9fc4c9 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_connection_condition.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_connection_condition.py @@ -28,7 +28,7 @@ class Usecase: The condition and the member itself is preserved. :param relation: The IfcRelConnectsStructuralMember to remove. - :type relation: ifcopenshell.entity_instance.entity_instance + :type relation: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load.py b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load.py index 1bdecdae4e..55b83a7f1b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load.py @@ -22,7 +22,7 @@ class Usecase: """Removes a structural load :param structural_load: The IfcStructuralLoad to remove. - :type structural_load: ifcopenshell.entity_instance.entity_instance + :type structural_load: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_case.py b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_case.py index c9aa1b2c5d..e331309239 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_case.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_case.py @@ -26,7 +26,7 @@ class Usecase: """Removes a structural load case :param load_case: The IfcStructuralLoadCase to remove. - :type load_case: ifcopenshell.entity_instance.entity_instance + :type load_case: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_group.py b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_group.py index 937af21bca..93500aba1b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_group.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/remove_structural_load_group.py @@ -26,7 +26,7 @@ class Usecase: """Removes a structural load group :param load_group: The IfcStructuralLoadGroup to remove. - :type load_group: ifcopenshell.entity_instance.entity_instance + :type load_group: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/structural/unassign_structural_analysis_model.py b/src/ifcopenshell-python/ifcopenshell/api/structural/unassign_structural_analysis_model.py index 0dd7bf8ca4..5a86a6a9f3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/structural/unassign_structural_analysis_model.py +++ b/src/ifcopenshell-python/ifcopenshell/api/structural/unassign_structural_analysis_model.py @@ -26,10 +26,10 @@ class Usecase: """Removes a relationship between a structural element and the analysis model :param product: The structural element that is part of the analysis. - :type product: ifcopenshell.entity_instance.entity_instance + :type product: ifcopenshell.entity_instance :param structural_analysis_model: The IfcStructuralAnalysisModel that the structural element is related to. - :type structural_analysis_model: ifcopenshell.entity_instance.entity_instance + :type structural_analysis_model: ifcopenshell.entity_instance :return: None :rtype: None """ diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/add_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/add_style.py index 575548287b..650043039f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/add_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/add_style.py @@ -46,7 +46,7 @@ class Usecase: :type ifc_class: str :return: The newly created style element, based on the provided ifc_class. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_style.py index f3d97946f8..32064811f9 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_style.py @@ -68,7 +68,7 @@ class Usecase: :param style: The IfcSurfaceStyle you want to add to presentation item to. See ifcopenshell.api.style.add_style. - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :param ifc_class: Choose from IfcSurfaceStyleShading, IfcSurfaceStyleRendering, IfcSurfaceStyleWithTextures, IfcSurfaceStyleLighting, IfcSurfaceStyleReflectance, or @@ -78,7 +78,7 @@ class Usecase: :type attributes: dict, optional :return: The newly created presentation item based on the provided ifc_class. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_textures.py b/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_textures.py index 70a0da1e45..88aabfe801 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_textures.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/add_surface_textures.py @@ -31,7 +31,7 @@ class Usecase: :param uv_maps: A list of IfcIndexedTextureMap for any IfcTessellatedFaceSets that the representation has, obtained from the HasTextures attribute. - :type uv_maps: list[ifcopenshell.entity_instance.entity_instance] + :type uv_maps: list[ifcopenshell.entity_instance] :param textures: A list of dictionaries containing: 1. Attributes to create IfcImageTexture. @@ -47,7 +47,7 @@ class Usecase: based on camera position) :type textures: list[dict] :return: A list of IfcImageTexture - :rtype: list[ifcopenshell.entity_instance.entity_instance] + :rtype: list[ifcopenshell.entity_instance] """ # TODO: This usecase currently depends on Blender's data model self.file = file diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/assign_material_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/assign_material_style.py index 11a82097a6..06d3a6339a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/assign_material_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/assign_material_style.py @@ -32,14 +32,14 @@ class Usecase: to materials. This API function provides that capability. :param material: The IfcMaterial which you want to assign the style to. - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :param style: The IfcPresentationStyle (typically IfcSurfaceStyle) that you want to assign to the material. This will then be applied to all objects that have that material. - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :param context: The IfcGeometricRepresentationSubContext at which this style should be used. Typically this is the Model BODY context. - :type context: ifcopenshell.entity_instance.entity_instance + :type context: ifcopenshell.entity_instance :param should_use_presentation_style_assignment: This is a technical detail to accomodate a bug in Revit. This should always be left as the default of False, unless you are finding that colours aren't diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/assign_representation_styles.py b/src/ifcopenshell-python/ifcopenshell/api/style/assign_representation_styles.py index 860abc83db..c6236c8a4a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/assign_representation_styles.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/assign_representation_styles.py @@ -42,12 +42,12 @@ class Usecase: :param shape_representation: The IfcShapeRepresentation of the object that you want to assign styles to. This implicitly defines the context at which the styles should be used. - :type shape_representation: ifcopenshell.entity_instance.entity_instance + :type shape_representation: ifcopenshell.entity_instance :param styles: A list of presentation styles, typically IfcSurfaceStyle. The number of items in the list should correlate with the number of items in the shape_representation's Items attribute. If you have more items than styles, the last style is used. - :type styles: list[ifcopenshell.entity_instance.entity_instance] + :type styles: list[ifcopenshell.entity_instance] :param replace_previous_same_type_style: Remove previously assigned styles of the same type as currently assign style`. Defaults to `True`. :type replace_previous_same_type_style: bool @@ -58,7 +58,7 @@ class Usecase: that this is no longer a valid IFC. Blame Autodesk. :type should_use_presentation_style_assignment: bool :return: List of created IfcStyledItems - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/edit_presentation_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/edit_presentation_style.py index 7c928e294f..877d0f89c2 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/edit_presentation_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/edit_presentation_style.py @@ -25,7 +25,7 @@ class Usecase: IfcPresentationStyle, consult the IFC documentation. :param style: The IfcPresentationStyle entity you want to edit - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/edit_surface_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/edit_surface_style.py index 9031db5dd5..20c1002fdf 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/edit_surface_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/edit_surface_style.py @@ -33,7 +33,7 @@ class Usecase: example below. :param style: The IfcPresentationStyle entity you want to edit - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/remove_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/remove_style.py index c9c9c76a95..40692982bb 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/remove_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/remove_style.py @@ -26,7 +26,7 @@ class Usecase: All of the presentation items of the style will also be removed. :param style: The IfcPresentationStyle to remove. - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/remove_styled_representation.py b/src/ifcopenshell-python/ifcopenshell/api/style/remove_styled_representation.py index 4381f91a4b..ab061e182c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/remove_styled_representation.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/remove_styled_representation.py @@ -25,7 +25,7 @@ class Usecase: removes the representation but not the underlying styles. :param representation: The IfcStyledRepresentation to remove. - :type representation: ifcopenshell.entity_instance.entity_instance + :type representation: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/remove_surface_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/remove_surface_style.py index 5e17b2b06d..ce214dbf21 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/remove_surface_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/remove_surface_style.py @@ -25,7 +25,7 @@ class Usecase: """Removes a presentation item from a presentation style :param style: The IfcPresentationItem to remove. - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/unassign_material_style.py b/src/ifcopenshell-python/ifcopenshell/api/style/unassign_material_style.py index 674e5eb7f0..f1e2e7e85b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/unassign_material_style.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/unassign_material_style.py @@ -27,14 +27,14 @@ class Usecase: This does the inverse of assign_material_style. :param material: The IfcMaterial which you want to unassign the style from. - :type material: ifcopenshell.entity_instance.entity_instance + :type material: ifcopenshell.entity_instance :param style: The IfcPresentationStyle (typically IfcSurfaceStyle) that you want to unassign from material. This will then be applied to all objects that have that material. - :type style: ifcopenshell.entity_instance.entity_instance + :type style: ifcopenshell.entity_instance :param context: The IfcGeometricRepresentationSubContext at which this style should be unassigned. Typically this is the Model BODY context. - :type context: ifcopenshell.entity_instance.entity_instance + :type context: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/style/unassign_representation_styles.py b/src/ifcopenshell-python/ifcopenshell/api/style/unassign_representation_styles.py index 6211a9f4dd..83f60fe3d4 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/style/unassign_representation_styles.py +++ b/src/ifcopenshell-python/ifcopenshell/api/style/unassign_representation_styles.py @@ -25,12 +25,12 @@ class Usecase: :param shape_representation: The IfcShapeRepresentation of the object that you want to unassign styles from. - :type shape_representation: ifcopenshell.entity_instance.entity_instance + :type shape_representation: ifcopenshell.entity_instance :param styles: A list of presentation styles, typically IfcSurfaceStyle. The number of items in the list should correlate with the number of items in the shape_representation's Items attribute. If you have more items than styles, the last style is used. - :type styles: list[ifcopenshell.entity_instance.entity_instance] + :type styles: list[ifcopenshell.entity_instance] :param should_use_presentation_style_assignment: This is a technical detail to accomodate a bug in Revit. This should always be left as the default of False, unless you are finding that colours aren't diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/add_port.py b/src/ifcopenshell-python/ifcopenshell/api/system/add_port.py index d0512c3cd3..f792ecc2fa 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/add_port.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/add_port.py @@ -35,9 +35,9 @@ class Usecase: :param element: The IfcDistributionElement you want to add a distribution port to. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :return: The newly created IfcDistributionPort - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/add_system.py b/src/ifcopenshell-python/ifcopenshell/api/system/add_system.py index 0fdf9992d7..26c8cfe8fc 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/add_system.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/add_system.py @@ -36,7 +36,7 @@ class Usecase: IfcSystem. :type ifc_class: str :return: The newly created IfcSystem. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/assign_flow_control.py b/src/ifcopenshell-python/ifcopenshell/api/system/assign_flow_control.py index 4517a42421..aae80ab6eb 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/assign_flow_control.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/assign_flow_control.py @@ -29,12 +29,12 @@ class Usecase: :param related_flow_control: IfcDistributionControlElement which may be used to impart control on the flow element - :type related_flow_control: ifcopenshell.entity_instance.entity_instance + :type related_flow_control: ifcopenshell.entity_instance :param relating_flow_element: The IfcDistributionFlowElement that is being controlled / sensed - :type relating_flow_element: ifcopenshell.entity_instance.entity_instance + :type relating_flow_element: ifcopenshell.entity_instance :return: Matching or newly created IfcRelFlowControlElements. If control is already assigned to some other element method will return None. - :rtype: ifcopenshell.entity_instance.entity_instance, None + :rtype: ifcopenshell.entity_instance, None Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/assign_port.py b/src/ifcopenshell-python/ifcopenshell/api/system/assign_port.py index 91a1ce91be..728a935395 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/assign_port.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/assign_port.py @@ -30,12 +30,12 @@ class Usecase: it may be useful when patching up models. :param element: The IfcDistributionElement to assign the port to. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :param port: The IfcDistributionPort you want to assign. - :type port: ifcopenshell.entity_instance.entity_instance + :type port: ifcopenshell.entity_instance :return: The IfcRelNests relationship, or the IfcRelConnectsPortToElement for IFC2X3. - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/assign_system.py b/src/ifcopenshell-python/ifcopenshell/api/system/assign_system.py index 3df49d776d..20f5a8519f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/assign_system.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/assign_system.py @@ -33,12 +33,12 @@ class Usecase: Note that it is not necessary to assign distribution ports to a system. :param products: The list of IfcDistributionElements to assign to the system. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param system: The IfcSystem you want to assign the element to. - :type system: ifcopenshell.entity_instance.entity_instance + :type system: ifcopenshell.entity_instance :return: The IfcRelAssignsToGroup relationship or `None` if `products` was empty list. - :rtype: [ifcopenshell.entity_instance.entity_instance, None] + :rtype: [ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/connect_port.py b/src/ifcopenshell-python/ifcopenshell/api/system/connect_port.py index 4d0b75e8a6..7d23dde1a7 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/connect_port.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/connect_port.py @@ -45,9 +45,9 @@ class Usecase: and implicit connectivity is preferred for early phase design. :param port1: The port of the first distribution element to connect. - :type port1: ifcopenshell.entity_instance.entity_instance + :type port1: ifcopenshell.entity_instance :param port2: The port of the second distribution element to connect. - :type port2: ifcopenshell.entity_instance.entity_instance + :type port2: ifcopenshell.entity_instance :param direction: The directionality of distribution flow through the port connection. NOTDEFINED means that the direction has not yet been determined. This is useful during preliminary system design. @@ -61,7 +61,7 @@ class Usecase: connectivity is made, such as a segment or fitting. This is only to be used for implicit port connectivity where the segments and fittings are less important. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/disconnect_port.py b/src/ifcopenshell-python/ifcopenshell/api/system/disconnect_port.py index 12d48af4b2..071074e9e7 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/disconnect_port.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/disconnect_port.py @@ -29,7 +29,7 @@ class Usecase: needed to be specified. :param port: The IfcDistributionPort to disconnect. - :type port: ifcopenshell.entity_instance.entity_instance + :type port: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/edit_system.py b/src/ifcopenshell-python/ifcopenshell/api/system/edit_system.py index fefdfa0f58..315c04ccd5 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/edit_system.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/edit_system.py @@ -25,7 +25,7 @@ class Usecase: IfcSystem, consult the IFC documentation. :param system: The IfcSystem entity you want to edit - :type system: ifcopenshell.entity_instance.entity_instance + :type system: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/remove_system.py b/src/ifcopenshell-python/ifcopenshell/api/system/remove_system.py index f4cfe0e2d3..f331a5f3e3 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/remove_system.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/remove_system.py @@ -28,7 +28,7 @@ class Usecase: All the distribution elements within the system are retained. :param system: The IfcSystem to remove. - :type system: ifcopenshell.entity_instance.entity_instance + :type system: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/unassign_flow_control.py b/src/ifcopenshell-python/ifcopenshell/api/system/unassign_flow_control.py index 3ed1fe4cd5..04eda27f83 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/unassign_flow_control.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/unassign_flow_control.py @@ -27,12 +27,12 @@ class Usecase: :param related_flow_control: IfcDistributionControlElement controling the flow element - :type related_flow_control: ifcopenshell.entity_instance.entity_instance + :type related_flow_control: ifcopenshell.entity_instance :param relating_flow_element: The IfcDistributionFlowElement that is being controlled - :type relating_flow_element: ifcopenshell.entity_instance.entity_instance + :type relating_flow_element: ifcopenshell.entity_instance :return: If the control still is related to other objects, the IfcRelFlowControlElements is returned, otherwise None. - :rtype: ifcopenshell.entity_instance.entity_instance, None + :rtype: ifcopenshell.entity_instance, None Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/unassign_port.py b/src/ifcopenshell-python/ifcopenshell/api/system/unassign_port.py index 81c8751945..e9d82722aa 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/unassign_port.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/unassign_port.py @@ -29,9 +29,9 @@ class Usecase: port for cleaning or patchin purposes. :param element: The IfcDistributionElement to unassign the port from. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :param port: The IfcDistributionPort you want to unassign. - :type port: ifcopenshell.entity_instance.entity_instance + :type port: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/system/unassign_system.py b/src/ifcopenshell-python/ifcopenshell/api/system/unassign_system.py index b402407038..fbc3dd854b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/system/unassign_system.py +++ b/src/ifcopenshell-python/ifcopenshell/api/system/unassign_system.py @@ -31,9 +31,9 @@ class Usecase: """Unassigns list of products from a system :param products: The list of IfcDistributionElements to unassign from the system. - :type products: list[ifcopenshell.entity_instance.entity_instance] + :type products: list[ifcopenshell.entity_instance] :param system: The IfcSystem you want to unassign the element from. - :type system: ifcopenshell.entity_instance.entity_instance + :type system: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/type/assign_type.py b/src/ifcopenshell-python/ifcopenshell/api/type/assign_type.py index 68da4c0da5..b8d7cf357a 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/type/assign_type.py +++ b/src/ifcopenshell-python/ifcopenshell/api/type/assign_type.py @@ -91,9 +91,9 @@ class Usecase: ambiguous, unknown or are so bespoke as to have no logical type. :param related_objects: The IfcElement occurrences. - :type related_objects: list[ifcopenshell.entity_instance.entity_instance] + :type related_objects: list[ifcopenshell.entity_instance] :param relating_type: The IfcElementType type. - :type relating_type: ifcopenshell.entity_instance.entity_instance + :type relating_type: ifcopenshell.entity_instance :param should_map_representations: If a type has a representation map, IFC requires all occurrences to map those representations. Some IFC vendors might disobey this, or you might want to handle it @@ -102,7 +102,7 @@ class Usecase: :type should_map_representations: bool :return: The IfcRelDefinesByType relationship or `None` if `related_objects` was empty list. - :rtype: Union[ifcopenshell.entity_instance.entity_instance, None] + :rtype: Union[ifcopenshell.entity_instance, None] Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/type/get_related_objects.py b/src/ifcopenshell-python/ifcopenshell/api/type/get_related_objects.py index 2e8d562fbf..0a05de4118 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/type/get_related_objects.py +++ b/src/ifcopenshell-python/ifcopenshell/api/type/get_related_objects.py @@ -28,11 +28,11 @@ class Usecase: ifcopenshell.util.element.get_types instead. :param related_object: The IfcElement occurrence. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :param relating_type: The IfcElementType type. - :type relating_type: ifcopenshell.entity_instance.entity_instance + :type relating_type: ifcopenshell.entity_instance :return: A list of occurrences of the type. - :rtype: list[ifcopenshell.entity_instance.entity_instance] + :rtype: list[ifcopenshell.entity_instance] """ self.file = file self.settings = { diff --git a/src/ifcopenshell-python/ifcopenshell/api/type/map_type_representations.py b/src/ifcopenshell-python/ifcopenshell/api/type/map_type_representations.py index 180e163477..064fb148bb 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/type/map_type_representations.py +++ b/src/ifcopenshell-python/ifcopenshell/api/type/map_type_representations.py @@ -35,9 +35,9 @@ class Usecase: be used to ensure consistency of the occurrence's representations. :param related_object: The IfcElement occurrence. - :type related_object: ifcopenshell.entity_instance.entity_instance + :type related_object: ifcopenshell.entity_instance :param relating_type: The IfcElementType type. - :type relating_type: ifcopenshell.entity_instance.entity_instance + :type relating_type: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/type/unassign_type.py b/src/ifcopenshell-python/ifcopenshell/api/type/unassign_type.py index c376a58971..a629100477 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/type/unassign_type.py +++ b/src/ifcopenshell-python/ifcopenshell/api/type/unassign_type.py @@ -29,7 +29,7 @@ class Usecase: and material usages associated with the previously assigned type. :param related_objects: List of IfcElement occurrences. - :type related_objects: list[ifcopenshell.entity_instance.entity_instance] + :type related_objects: list[ifcopenshell.entity_instance] :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/add_context_dependent_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/add_context_dependent_unit.py index 631daaa99d..a0d705a94b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/add_context_dependent_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/add_context_dependent_unit.py @@ -43,7 +43,7 @@ class Usecase: recommended to leave this as the default of (0, 0, 0, 0, 0, 0, 0). :type dimensions: list[int] :return: The new IfcContextDependentUnit - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/add_conversion_based_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/add_conversion_based_unit.py index 3102a482fa..20b96d3298 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/add_conversion_based_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/add_conversion_based_unit.py @@ -45,7 +45,7 @@ class Usecase: :type conversion_offset: float, optional :return: The new IfcConversionBasedUnit or IfcConversionBasedUnitWithOffset - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/add_monetary_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/add_monetary_unit.py index fb15af4cd5..f15b18ab91 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/add_monetary_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/add_monetary_unit.py @@ -28,7 +28,7 @@ class Usecase: :param currency: The currency code :type currency: str :return: The newly created IfcMonetaryUnit - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/add_si_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/add_si_unit.py index bd0cd26e39..7eb8019632 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/add_si_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/add_si_unit.py @@ -44,7 +44,7 @@ class Usecase: prefix. :type prefix: str,optional :return: The newly created IfcSIUnit - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/assign_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/assign_unit.py index bca68744d7..67305295bd 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/assign_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/assign_unit.py @@ -44,9 +44,9 @@ class Usecase: :param units: A list of units to assign as project defaults. See ifcopenshell.api.unit.add_si_unit, unit.add_conversion_based_unit, and unit.add_monetary_unit for information on how to create units. - :type units: list[ifcopenshell.entity_instance.entity_instance],optional + :type units: list[ifcopenshell.entity_instance],optional :return: The IfcUnitAssignment element - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/edit_derived_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/edit_derived_unit.py index d3a3c47fe5..636430159c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/edit_derived_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/edit_derived_unit.py @@ -25,7 +25,7 @@ class Usecase: IfcDerivedUnit, consult the IFC documentation. :param unit: The IfcDerivedUnit entity you want to edit - :type unit: ifcopenshell.entity_instance.entity_instance + :type unit: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/edit_monetary_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/edit_monetary_unit.py index 9f27e20d96..aee4b89305 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/edit_monetary_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/edit_monetary_unit.py @@ -25,7 +25,7 @@ class Usecase: IfcMonetaryUnit, consult the IFC documentation. :param unit: The IfcMonetaryUnit entity you want to edit - :type unit: ifcopenshell.entity_instance.entity_instance + :type unit: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/edit_named_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/edit_named_unit.py index c4652ba55a..da4ff5290f 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/edit_named_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/edit_named_unit.py @@ -28,7 +28,7 @@ class Usecase: IfcNamedUnit, consult the IFC documentation. :param unit: The IfcNamedUnit entity you want to edit - :type unit: ifcopenshell.entity_instance.entity_instance + :type unit: ifcopenshell.entity_instance :param attributes: a dictionary of attribute names and values. :type attributes: dict, optional :return: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/remove_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/remove_unit.py index 361cfbd0c3..ba9aff862b 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/remove_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/remove_unit.py @@ -28,7 +28,7 @@ class Usecase: defined quantities in the model completely lose their meaning. :param unit: The unit element to remove - :type unit: ifcopenshell.entity_instance.entity_instance + :type unit: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/unit/unassign_unit.py b/src/ifcopenshell-python/ifcopenshell/api/unit/unassign_unit.py index fb1dcafb02..2da27bd08c 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/unit/unassign_unit.py +++ b/src/ifcopenshell-python/ifcopenshell/api/unit/unassign_unit.py @@ -24,7 +24,7 @@ class Usecase: """Unassigns units as default units for the project :param units: A list of units to assign as project defaults. - :type units: list[ifcopenshell.entity_instance.entity_instance],optional + :type units: list[ifcopenshell.entity_instance],optional :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/void/add_filling.py b/src/ifcopenshell-python/ifcopenshell/api/void/add_filling.py index b457ab5d3a..a2867450f6 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/void/add_filling.py +++ b/src/ifcopenshell-python/ifcopenshell/api/void/add_filling.py @@ -31,11 +31,11 @@ class Usecase: filled. :param opening: The IfcOpeningElement to fill with the element. - :type opening: ifcopenshell.entity_instance.entity_instance + :type opening: ifcopenshell.entity_instance :param element: The IfcElement to be inserted into the opening. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :return: The new IfcRelFillsElement relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/void/add_opening.py b/src/ifcopenshell-python/ifcopenshell/api/void/add_opening.py index 3a260a08f7..142eaedd87 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/void/add_opening.py +++ b/src/ifcopenshell-python/ifcopenshell/api/void/add_opening.py @@ -51,11 +51,11 @@ class Usecase: booleaned or be part of the shape of the object). :param opening: The IfcOpeningElement to cut out the element. - :type opening: ifcopenshell.entity_instance.entity_instance + :type opening: ifcopenshell.entity_instance :param element: The IfcElement to insert the opening into. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :return: The new IfcRelVoidsElement relationship - :rtype: ifcopenshell.entity_instance.entity_instance + :rtype: ifcopenshell.entity_instance Example: diff --git a/src/ifcopenshell-python/ifcopenshell/api/void/remove_filling.py b/src/ifcopenshell-python/ifcopenshell/api/void/remove_filling.py index d277960a5f..6d5ab79752 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/void/remove_filling.py +++ b/src/ifcopenshell-python/ifcopenshell/api/void/remove_filling.py @@ -29,7 +29,7 @@ class Usecase: fills the opening. :param element: The element filling an opening. - :type element: ifcopenshell.entity_instance.entity_instance + :type element: ifcopenshell.entity_instance :return: None :rtype: None diff --git a/src/ifcopenshell-python/ifcopenshell/api/void/remove_opening.py b/src/ifcopenshell-python/ifcopenshell/api/void/remove_opening.py index 3735d2e735..5ffba93e25 100644 --- a/src/ifcopenshell-python/ifcopenshell/api/void/remove_opening.py +++ b/src/ifcopenshell-python/ifcopenshell/api/void/remove_opening.py @@ -29,7 +29,7 @@ class Usecase: removed, the opening is also removed. :param opening: The IfcOpeningElement to remove. - :type opening: ifcopenshell.entity_instance.entity_instance + :type opening: ifcopenshell.entity_instance :return: None :rtype: None