Fix docstrings to reference datatype as it would be used for users

This commit is contained in:
Dion Moult
2024-05-06 08:39:41 +10:00
parent d694d8fcc2
commit a213ab6760
266 changed files with 439 additions and 439 deletions
@@ -63,13 +63,13 @@ class Usecase:
:param products: The list of parts of the aggregate, typically of IfcElement or :param products: The list of parts of the aggregate, typically of IfcElement or
IfcSpatialStructureElement subclass 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 :param relating_object: The whole of the aggregate, typically an
IfcElement or IfcSpatialStructureElement subclass IfcElement or IfcSpatialStructureElement subclass
:type relating_object: ifcopenshell.entity_instance.entity_instance :type relating_object: ifcopenshell.entity_instance
:return: The IfcRelAggregate relationship instance :return: The IfcRelAggregate relationship instance
or `None` if `products` was empty list. or `None` if `products` was empty list.
:rtype: Union[ifcopenshell.entity_instance.entity_instance, None] :rtype: Union[ifcopenshell.entity_instance, None]
Example: Example:
@@ -39,7 +39,7 @@ class Usecase:
:param products: The list of parts of the aggregate, typically of IfcElements or :param products: The list of parts of the aggregate, typically of IfcElements or
IfcSpatialStructureElement subclass IfcSpatialStructureElement subclass
:type product: list[ifcopenshell.entity_instance.entity_instance] :type product: list[ifcopenshell.entity_instance]
:return: None :return: None
:rtype: None :rtype: None
@@ -30,7 +30,7 @@ class Usecase:
:param product: The product you want to edit. This may be any rooted IFC :param product: The product you want to edit. This may be any rooted IFC
entity. entity.
:type product: ifcopenshell.entity_instance.entity_instance :type product: ifcopenshell.entity_instance
:param attributes: a dictionary of attribute names and values. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -31,7 +31,7 @@ class Usecase:
:param rel_space_boundary: The space boundary relationship to assign the :param rel_space_boundary: The space boundary relationship to assign the
connection geometry to. 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 :param outer_boundary: A list of 2D points representing an open
polyline. The last point will connect to the first point. Each polyline. The last point will connect to the first point. Each
point is represented by an interable of 2 floats. The coordinates of point is represented by an interable of 2 floats. The coordinates of
@@ -24,7 +24,7 @@ class Usecase:
"""Copies a space boundary """Copies a space boundary
:param boundary: The IfcRelSpaceBoundary you want to copy. :param boundary: The IfcRelSpaceBoundary you want to copy.
:type boundary: ifcopenshell.entity_instance.entity_instance :type boundary: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -25,22 +25,22 @@ class Usecase:
manual assignment of the space boundary attributes. manual assignment of the space boundary attributes.
:param entity: The IfcRelSpaceBoundary to modify :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 :param relating_space: The IfcSpace or IfcExternalSpatialElement that
the space boundary is related to. 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 :param related_building_element: The IfcElement that defines the
boundary, typically an IfcWall. 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 :param parent_boundary: A parent IfcRelSpaceBoundary, only provided if
this is an inner boundary. This can apply to 1st and 2nd level this is an inner boundary. This can apply to 1st and 2nd level
boundaries. boundaries.
:type parent_boundary: ifcopenshell.entity_instance.entity_instance, :type parent_boundary: ifcopenshell.entity_instance,
optional optional
:param corresponding_boundary: The other IfcRelSpaceBoundary on the :param corresponding_boundary: The other IfcRelSpaceBoundary on the
other side of the related element. The pair together represents a other side of the related element. The pair together represents a
thermal boundary. This only applies to 2nd level boundaries. thermal boundary. This only applies to 2nd level boundaries.
:type corresponding_boundary: ifcopenshell.entity_instance.entity_instance, :type corresponding_boundary: ifcopenshell.entity_instance,
optional optional
:return: None :return: None
:rtype: None :rtype: None
@@ -28,7 +28,7 @@ class Usecase:
boundary and its connection geometry is removed. boundary and its connection geometry is removed.
:param boundary: The IfcRelSpaceBoundary you want to remove. :param boundary: The IfcRelSpaceBoundary you want to remove.
:type boundary: ifcopenshell.entity_instance.entity_instance :type boundary: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -59,9 +59,9 @@ class Usecase:
classification library. The latter approach is preferred if you are classification library. The latter approach is preferred if you are
using a commonly known system such as Uniclass, as this will ensure using a commonly known system such as Uniclass, as this will ensure
all metadata is added correctly. all metadata is added correctly.
:type classification: str,ifcopenshell.entity_instance.entity_instance :type classification: str,ifcopenshell.entity_instance
:return: The added IfcClassification element :return: The added IfcClassification element
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -66,11 +66,11 @@ class Usecase:
:param product: The list of IFC objects, properties, or resources you want to :param product: The list of IFC objects, properties, or resources you want to
associate the classification reference 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 :param reference: The classification reference entity taken from an
IFC classification library. If you supply this parameter, you will IFC classification library. If you supply this parameter, you will
use option 2. 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 :param identification: If you choose option 1 and do not specify a
reference, you may manually specify an identification code. The code reference, you may manually specify an identification code. The code
is typically a short identifier and may have punctuation to separate 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 :param classification: The IfcClassification entity in your IFC model
(not the library, if you are doing option 2) that the reference is (not the library, if you are doing option 2) that the reference is
part of. 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 :param is_lightweight: If you are doing option 2, choose whether or not
to only add that particular reference (lighweight) or also add all to only add that particular reference (lighweight) or also add all
of its parent references in the classification hierarchy (not of its parent references in the classification hierarchy (not
@@ -98,7 +98,7 @@ class Usecase:
:return: The newly added IfcClassificationReference :return: The newly added IfcClassificationReference
or `None` if `products` was empty list. or `None` if `products` was empty list.
:rtype: Union[ifcopenshell.entity_instance.entity_instance, None] :rtype: Union[ifcopenshell.entity_instance, None]
Example: Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcClassification, consult the IFC documentation. IfcClassification, consult the IFC documentation.
:param classification: The IfcClassification entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcClassificationReference, consult the IFC documentation. IfcClassificationReference, consult the IFC documentation.
:param reference: The IfcClassificationReference entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -29,7 +29,7 @@ class Usecase:
removed from a project. removed from a project.
:param classification: The IfcClassification entity you want to remove :param classification: The IfcClassification entity you want to remove
:type classification: ifcopenshell.entity_instance.entity_instance :type classification: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -35,10 +35,10 @@ class Usecase:
:param reference: The IfcClassificationReference entity of the :param reference: The IfcClassificationReference entity of the
relationship you want to remove. 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 :param product: The list fo object entities of the relationship you want to
remove. 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. :raises TypeError: If file is IFC2X3 and `products` has non-IfcRoot elements.
@@ -29,9 +29,9 @@ class Usecase:
to meet the objective of the constraint. to meet the objective of the constraint.
:param objective: The IfcObjective that this metric is a benchmark of. :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 :return: The newly created IfcMetric entity
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -30,7 +30,7 @@ class Usecase:
quantities. See ifcopenshell.api.constraint.add_metric for more information. quantities. See ifcopenshell.api.constraint.add_metric for more information.
:return: The newly created IfcObjective entity :return: The newly created IfcObjective entity
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -40,12 +40,12 @@ class Usecase:
:param products: The list of products the constraint applies to. This is anything :param products: The list of products the constraint applies to. This is anything
which can have properties or quantities. 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 :param constraint: The IfcObjective constraint
:type constraint: ifcopenshell.entity_instance.entity_instance :type constraint: ifcopenshell.entity_instance
:return: The new or updated IfcRelAssociatesConstraint relationship :return: The new or updated IfcRelAssociatesConstraint relationship
or `None` if `products` was an empty list. or `None` if `products` was an empty list.
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
""" """
self.file = file self.file = file
self.settings = { self.settings = {
@@ -25,7 +25,7 @@ class Usecase:
IfcMetric, consult the IFC documentation. IfcMetric, consult the IFC documentation.
:param metric: The IfcMetric you want to edit. :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcObjective, consult the IFC documentation. IfcObjective, consult the IFC documentation.
:param objective: The IfcObjective you want to edit. :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -30,7 +30,7 @@ class Usecase:
unclear. unclear.
:param constraint: The IfcObjective you want to remove. :param constraint: The IfcObjective you want to remove.
:type constraint: ifcopenshell.entity_instance.entity_instance :type constraint: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -25,7 +25,7 @@ class Usecase:
and objectives. and objectives.
:param metric: The IfcMetric you want to remove. :param metric: The IfcMetric you want to remove.
:type metric: ifcopenshell.entity_instance.entity_instance :type metric: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -34,9 +34,9 @@ class Usecase:
other products. other products.
:param products: The list of products the constraint applies to. :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 :param constraint: The IfcObjective constraint
:type constraint: ifcopenshell.entity_instance.entity_instance :type constraint: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
""" """
@@ -102,10 +102,10 @@ class Usecase:
:param parent: the parent context. Must be left as None (the default) :param parent: the parent context. Must be left as None (the default)
for contexts, and only set for subcontexts. Note that there are only for contexts, and only set for subcontexts. Note that there are only
contexts and subcontexts, a subcontext cannot have any children. 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 :return: the newly created IfcGeometricRepresentationContext or
IfcGeometricRepresentationSubContext entity IfcGeometricRepresentationSubContext entity
:rtype: ifcopenshell.entity_instance.entity_instance, optional :rtype: ifcopenshell.entity_instance, optional
Example: Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcGeometricRepresentationContext, consult the IFC documentation. IfcGeometricRepresentationContext, consult the IFC documentation.
:param context: The IfcGeometricRepresentationContext entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -27,7 +27,7 @@ class Usecase:
removed. If a context is removed, then any subcontexts are also removed. removed. If a context is removed, then any subcontexts are also removed.
:param context: The IfcGeometricRepresentationContext entity to remove :param context: The IfcGeometricRepresentationContext entity to remove
:type context: ifcopenshell.entity_instance.entity_instance :type context: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -37,12 +37,12 @@ class Usecase:
:param relating_control: The IfcControl entity that is creating the :param relating_control: The IfcControl entity that is creating the
control or constraint 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 :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 :return: The newly created IfcRelAssignsToControl. If relationship already
existed before and wasn't changed then returns None. existed before and wasn't changed then returns None.
:rtype: ifcopenshell.entity_instance.entity_instance, None :rtype: ifcopenshell.entity_instance, None
Example: Example:
@@ -27,12 +27,12 @@ class Usecase:
:param relating_control: The IfcControl entity that is creating the :param relating_control: The IfcControl entity that is creating the
control or constraint 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 :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 :return: If the control still is related to other objects, the
IfcRelAssignsToControl is returned, otherwise None. IfcRelAssignsToControl is returned, otherwise None.
:rtype: ifcopenshell.entity_instance.entity_instance, None :rtype: ifcopenshell.entity_instance, None
Example: Example:
@@ -29,13 +29,13 @@ class Usecase:
:param cost_schedule: If the cost item is to be added as a root or top :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 level cost item to a cost schedule, the IfcCostSchedule may be
specified. This is mutually exlclusive to the cost_item parameter. 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 :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 existing cost item, the parent IfcCostItem may be specified. This is
mutually exclusive to the cost_schedule parameter. 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 :return: The newly created IfcCostItem
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -50,12 +50,12 @@ class Usecase:
using another API call. using another API call.
:param cost_item: The IfcCostItem to add the quantity to :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 :param ifc_class: The type of quantity to add
:type ifc_class: str, optional :type ifc_class: str, optional
:return: The newly created quantity entity, chosen from the ifc_class :return: The newly created quantity entity, chosen from the ifc_class
parameter parameter
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -43,7 +43,7 @@ class Usecase:
IfcCostScheduleTypeEnum IfcCostScheduleTypeEnum
:type predefined_type: str, optional :type predefined_type: str, optional
:return: The newly created IfcCostSchedule entity :return: The newly created IfcCostSchedule entity
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -46,9 +46,9 @@ class Usecase:
:param parent: A parent IfcCostItem, if specifying a price directly to a :param parent: A parent IfcCostItem, if specifying a price directly to a
cost item, or a top-level price component. Alternatively, this can cost item, or a top-level price component. Alternatively, this can
be set to a IfcCostValue, if specifying price subcomponents. 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 :return: The newly created IfcCostValue
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -40,9 +40,9 @@ class Usecase:
ifcopenshell.api.control.assign_control. ifcopenshell.api.control.assign_control.
:param cost_item: The IfcCostItem to assign parametric quantities to :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 :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, :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 then it is assumed that there is no calculated quantity, and the
number of objects are counted instead. number of objects are counted instead.
@@ -35,9 +35,9 @@ class Usecase:
rates as a "template" to quickly populate your rates from. rates as a "template" to quickly populate your rates from.
:param cost_item: The IfcCostItem that you want to copy the values to :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 :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 :return: None
:rtype: None :rtype: None
@@ -32,9 +32,9 @@ class Usecase:
* The copy will have duplicated nested cost items * The copy will have duplicated nested cost items
:param cost_item: The cost item to be duplicated :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 :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: Example:
.. code:: python .. code:: python
@@ -29,9 +29,9 @@ class Usecase:
parametrically linked, so if one value changes, the other will not. parametrically linked, so if one value changes, the other will not.
:param source: The IfcCostItem to copy cost values from :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 :param destination: The IfcCostItem to copy cost values from
:type destination: ifcopenshell.entity_instance.entity_instance :type destination: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -25,7 +25,7 @@ class Usecase:
IfcCostItem, consult the IFC documentation. IfcCostItem, consult the IFC documentation.
:param cost_item: The IfcCostItem entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcPhysicalQuantity, consult the IFC documentation. IfcPhysicalQuantity, consult the IFC documentation.
:param physical_quantity: The IfcPhysicalQuantity entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcCostSchedule, consult the IFC documentation. IfcCostSchedule, consult the IFC documentation.
:param cost_schedule: The IfcCostSchedule entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -29,7 +29,7 @@ class Usecase:
IfcCostValue, consult the IFC documentation. IfcCostValue, consult the IFC documentation.
:param cost_value: The IfcCostValue entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -33,7 +33,7 @@ class Usecase:
For more information, see ifcopenshell.util.cost For more information, see ifcopenshell.util.cost
:param cost_value: The IfcCostValue to set the values of :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 :param formula: The formula following the language of ifcopenshell.util.cost
:type formula: str :type formula: str
:return: None :return: None
@@ -30,7 +30,7 @@ class Usecase:
retained. retained.
:param cost_item: The IfcCostItem entity you want to remove :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 :return: None
:rtype: None :rtype: None
@@ -26,9 +26,9 @@ class Usecase:
removed. removed.
:param cost_item: The IfcCostItem that the quantity is assigned to :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 :param physical_quantity: The IfcPhysicalQuantity to remove
:type physical_quantity: ifcopenshell.entity_instance.entity_instance :type physical_quantity: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -29,7 +29,7 @@ class Usecase:
including all cost items. including all cost items.
:param cost_schedule: The IfcCostSchedule entity you want to remove :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 :return: None
:rtype: None :rtype: None
@@ -26,9 +26,9 @@ class Usecase:
:param parent: The IfcCostItem, IfcConstructionResource, or IfcCostValue :param parent: The IfcCostItem, IfcConstructionResource, or IfcCostValue
that the IfcCostValue is assigned to. 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 :param cost_value: The IfcCostValue that you want to remove
:type parent: ifcopenshell.entity_instance.entity_instance :type parent: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -29,10 +29,10 @@ class Usecase:
have any impact on the cost item. have any impact on the cost item.
:param cost_item: The IfcCostItem to remove quantities from :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 :param products: A list of IfcProducts that may have parametrically
connected quantities to the cost item connected quantities to the cost item
:type products: list[ifcopenshell.entity_instance.entity_instance] :type products: list[ifcopenshell.entity_instance]
:return: None :return: None
:rtype: None :rtype: None
@@ -33,9 +33,9 @@ class Usecase:
is considered the latest version and the children are older revisions. is considered the latest version and the children are older revisions.
:param parent: The parent document, if necessary. :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 :return: The newly created IfcDocumentInformation entity
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -39,9 +39,9 @@ class Usecase:
:param information: The IfcDocumentInformation that the reference will :param information: The IfcDocumentInformation that the reference will
be created for be created for
:type information: ifcopenshell.entity_instance.entity_instance :type information: ifcopenshell.entity_instance
:return: The newly created IfcDocumentReference entity :return: The newly created IfcDocumentReference entity
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -42,15 +42,15 @@ class Usecase:
:param product: The list of objects to associate the document to. This could be :param product: The list of objects to associate the document to. This could be
almost any sensible object in IFC. 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 :param document: The IfcDocumentReference to associate to, or
alternatively an IfcDocumentInformation, though this is not alternatively an IfcDocumentInformation, though this is not
recommended. recommended.
:type document: ifcopenshell.entity_instance.entity_instance :type document: ifcopenshell.entity_instance
:return: The IfcRelAssociatesDocument relationship :return: The IfcRelAssociatesDocument relationship
or `None` if `products` was an empty list or all products were or `None` if `products` was an empty list or all products were
already assigned to the `document`. already assigned to the `document`.
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -32,7 +32,7 @@ class Usecase:
IfcDocumentInformation, consult the IFC documentation. IfcDocumentInformation, consult the IFC documentation.
:param reference: The IfcDocumentInformation entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -32,7 +32,7 @@ class Usecase:
IfcDocumentReference, consult the IFC documentation. IfcDocumentReference, consult the IFC documentation.
:param reference: The IfcDocumentReference entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -29,7 +29,7 @@ class Usecase:
All references and associations are also removed. All references and associations are also removed.
:param information: The IfcDocumentInformation to remove :param information: The IfcDocumentInformation to remove
:type information: ifcopenshell.entity_instance.entity_instance :type information: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -27,7 +27,7 @@ class Usecase:
All associations with objects are removed. All associations with objects are removed.
:param reference: The IfcDocumentReference to remove :param reference: The IfcDocumentReference to remove
:type reference: ifcopenshell.entity_instance.entity_instance :type reference: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -32,10 +32,10 @@ class Usecase:
:param product: The list of objects that the document reference or information is :param product: The list of objects that the document reference or information is
related to. 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 :param document: The IfcDocumentReference (typically) or in rare cases
the IfcDocumentInformation that is associated with the product the IfcDocumentInformation that is associated with the product
:type document: ifcopenshell.entity_instance.entity_instance :type document: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -42,12 +42,12 @@ class Usecase:
in 3D. in 3D.
:param relating_product: The IfcProduct the object is related to :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 :param related_object: The object (typically IfcAnnotation) that the
product is related to product is related to
:type related_object: ifcopenshell.entity_instance.entity_instance :type related_object: ifcopenshell.entity_instance
:return: The created IfcRelAssignsToProduct relationship :return: The created IfcRelAssignsToProduct relationship
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcTextLiteral, consult the IFC documentation. IfcTextLiteral, consult the IFC documentation.
:param reference: The IfcTextLiteral entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -31,12 +31,12 @@ class Usecase:
object later or leave the annotation as a "dumb" annotation. object later or leave the annotation as a "dumb" annotation.
:param relating_product: The IfcProduct the object is related to :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 :param related_object: The object (typically IfcAnnotation) that the
product is related to product is related to
:type related_object: ifcopenshell.entity_instance.entity_instance :type related_object: ifcopenshell.entity_instance
:return: The created IfcRelAssignsToProduct relationship :return: The created IfcRelAssignsToProduct relationship
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -52,13 +52,13 @@ class Usecase:
:param context: The IfcGeometricRepresentationContext that the :param context: The IfcGeometricRepresentationContext that the
representation is part of. This must be either a representation is part of. This must be either a
Model/Axis/GRAPH_VIEW (3D) or Plan/Axis/GRAPH_VIEW (2D). 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 :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 being either a list of 2 or 3 float coordinates depending on whether
the axis is 2D or 3D. the axis is 2D or 3D.
:type axis: list[list[float]] :type axis: list[list[float]]
:return: The newly created IfcShapeRepresentation entity :return: The newly created IfcShapeRepresentation entity
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -35,7 +35,7 @@ class Usecase:
single edge. single edge.
:type axis_curve: bpy.types.Object :type axis_curve: bpy.types.Object
:param grid_axis: The IfcGridAxis element to add geometry to. :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 :return: None
:rtype: None :rtype: None
@@ -54,9 +54,9 @@ class Usecase:
Defaults to "UAxes". Defaults to "UAxes".
:type uvw_axes: str, optional :type uvw_axes: str, optional
:param grid: The IfcGrid you are adding the axis to. :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 :return: The newly created IfcGridAxis
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -24,7 +24,7 @@ class Usecase:
"""Removes a grid axis from a grid """Removes a grid axis from a grid
:param axis: The IfcGridAxis you want to remove. :param axis: The IfcGridAxis you want to remove.
:type axis: ifcopenshell.entity_instance.entity_instance :type axis: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -37,7 +37,7 @@ class Usecase:
:param Description: The description of the purpose of the group. :param Description: The description of the purpose of the group.
:type Description: str, optional :type Description: str, optional
:return: The newly created IfcGroup :return: The newly created IfcGroup
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -31,12 +31,12 @@ class Usecase:
twice. twice.
:param products: A list of IfcProduct elements to assign to the group :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 :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 :return: The IfcRelAssignsToGroup relationship
or `None` if `products` was empty list. or `None` if `products` was empty list.
:rtype: Union[ifcopenshell.entity_instance.entity_instance, None] :rtype: Union[ifcopenshell.entity_instance, None]
Example: Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcGroup, consult the IFC documentation. IfcGroup, consult the IFC documentation.
:param group: The IfcGroup entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -29,7 +29,7 @@ class Usecase:
the group will be removed. the group will be removed.
:param group: The IfcGroup entity you want to remove :param group: The IfcGroup entity you want to remove
:type group: ifcopenshell.entity_instance.entity_instance :type group: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -28,9 +28,9 @@ class Usecase:
If the product isn't assigned to the group, nothing will happen. If the product isn't assigned to the group, nothing will happen.
:param products: A list of IfcProduct elements to unassign from the group :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 :param group: The IfcGroup to unassign from
:type group: ifcopenshell.entity_instance.entity_instance :type group: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -28,11 +28,11 @@ class Usecase:
removed. removed.
:param products: A list of IfcProduct elements to assign to the group :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 :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 :return: The IfcRelAssignsToGroup relationship
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -36,7 +36,7 @@ class Usecase:
:param Name: The name of the layer. Defaults to "Unnamed". :param Name: The name of the layer. Defaults to "Unnamed".
:type Name: str, optional :type Name: str, optional
:return: The newly created IfcPresentationLayerAssignment element :return: The newly created IfcPresentationLayerAssignment element
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -34,10 +34,10 @@ class Usecase:
:param items: The list of IfcRepresentationItems to assign to the layer. This :param items: The list of IfcRepresentationItems to assign to the layer. This
should be the items from the object's IfcShapeRepresentation. 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 :param layer: The IfcPresentationLayerAssignment layer to assign the
item to. item to.
:type layer: ifcopenshell.entity_instance.entity_instance :type layer: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -25,7 +25,7 @@ class Usecase:
IfcPresentationLayerAssignment, consult the IFC documentation. IfcPresentationLayerAssignment, consult the IFC documentation.
:param layer: The IfcPresentationLayerAssignment entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
relationship to the layer will be removed. relationship to the layer will be removed.
:param layer: The IfcPresentationLayerAssignment entity to remove :param layer: The IfcPresentationLayerAssignment entity to remove
:type layer: ifcopenshell.entity_instance.entity_instance :type layer: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -32,9 +32,9 @@ class Usecase:
removed to keep IFC valid. removed to keep IFC valid.
:param items: A list IfcRepresentationItem elements to unassign :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 :param layer: The IfcPresentationLayerAssignment to unassign from
:type layer: ifcopenshell.entity_instance.entity_instance :type layer: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -53,7 +53,7 @@ class Usecase:
:param name: The name of the library :param name: The name of the library
:type name: str :type name: str
:return: The newly created IfcLibraryInformation :return: The newly created IfcLibraryInformation
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -36,9 +36,9 @@ class Usecase:
library's references. library's references.
:param library: The IfcLibraryInformation element to add a reference to :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 :return: The newly created IfcLibraryReference element
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -33,14 +33,14 @@ class Usecase:
detail about how references work. detail about how references work.
:param products: The list of IfcProducts you want to associate with the reference :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 :param reference: The IfcLibraryReference you want the product to be
associated with. associated with.
:type reference: ifcopenshell.entity_instance.entity_instance :type reference: ifcopenshell.entity_instance
:return: The IfcRelAssociatesLibrary relationship entity :return: The IfcRelAssociatesLibrary relationship entity
or `None` if `products` was an empty list or all products were or `None` if `products` was an empty list or all products were
already assigned to the `reference`. already assigned to the `reference`.
:rtype: Union[ifcopenshell.entity_instance.entity_instance, None] :rtype: Union[ifcopenshell.entity_instance, None]
Example: Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcLibraryInformation, consult the IFC documentation. IfcLibraryInformation, consult the IFC documentation.
:param library: The IfcLibraryInformation entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
IfcLibraryReference, consult the IFC documentation. IfcLibraryReference, consult the IFC documentation.
:param reference: The IfcLibraryReference entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -28,7 +28,7 @@ class Usecase:
products which have relationships to this library will not be removed. products which have relationships to this library will not be removed.
:param library: The IfcLibraryInformation entity you want to remove :param library: The IfcLibraryInformation entity you want to remove
:type library: ifcopenshell.entity_instance.entity_instance :type library: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -28,7 +28,7 @@ class Usecase:
removed. removed.
:param reference: The IfcLibraryReference entity you want to remove :param reference: The IfcLibraryReference entity you want to remove
:type reference: ifcopenshell.entity_instance.entity_instance :type reference: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -33,9 +33,9 @@ class Usecase:
If the product isn't assigned to the reference, nothing will happen. If the product isn't assigned to the reference, nothing will happen.
:param reference: The IfcLibraryReference to unassign from :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 :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 :return: None
:rtype: None :rtype: None
@@ -38,11 +38,11 @@ class Usecase:
constituent is part of. The constituent set represents a group of constituent is part of. The constituent set represents a group of
constituents. See ifcopenshell.api.material.add_material_set for constituents. See ifcopenshell.api.material.add_material_set for
information on how to add a constituent set. 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. :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 :return: The newly created IfcMaterialConstituent
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -36,11 +36,11 @@ class Usecase:
layer set represents a group of layers. See layer set represents a group of layers. See
ifcopenshell.api.material.add_material_set for more information on ifcopenshell.api.material.add_material_set for more information on
how to add a layer set. 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. :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 :return: The newly created IfcMaterialLayer
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -39,9 +39,9 @@ class Usecase:
:param material_list: The IfcMaterialList the material should be added :param material_list: The IfcMaterialList the material should be added
to. to.
:type material_list: ifcopenshell.entity_instance.entity_instance :type material_list: ifcopenshell.entity_instance
:param material: The IfcMaterial to add to the list :param material: The IfcMaterial to add to the list
:type material: ifcopenshell.entity_instance.entity_instance :type material: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -53,7 +53,7 @@ class Usecase:
:param category: The category of the material. :param category: The category of the material.
:type category: str, optional :type category: str, optional
:return: The newly created IfcMaterial :return: The newly created IfcMaterial
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -64,7 +64,7 @@ class Usecase:
IfcMaterialConstituentSet. IfcMaterialConstituentSet.
:type set_type: str, optional :type set_type: str, optional
:return: The newly created material set element :return: The newly created material set element
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -47,14 +47,14 @@ class Usecase:
profile set represents a group of profile items. See profile set represents a group of profile items. See
ifcopenshell.api.material.add_material_set for more information on ifcopenshell.api.material.add_material_set for more information on
how to add a profile set. 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. :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 :param profile: The IfcProfileDef that represents the 2D cross section
of the the profile item. of the the profile item.
:type profile: ifcopenshell.entity_instance.entity_instance, optional :type profile: ifcopenshell.entity_instance, optional
:return: The newly created IfcMaterialProfile :return: The newly created IfcMaterialProfile
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -64,7 +64,7 @@ class Usecase:
:param products: The list of IfcProducts to assign the material or material set :param products: The list of IfcProducts to assign the material or material set
to. to.
:type products: list[ifcopenshell.entity_instance.entity_instance] :type products: list[ifcopenshell.entity_instance]
:param type: Choose from "IfcMaterial", "IfcMaterialConstituentSet", :param type: Choose from "IfcMaterial", "IfcMaterialConstituentSet",
"IfcMaterialLayerSet", "IfcMaterialLayerSetUsage", "IfcMaterialLayerSet", "IfcMaterialLayerSetUsage",
"IfcMaterialProfileSet", "IfcMaterialProfileSetUsage", or "IfcMaterialProfileSet", "IfcMaterialProfileSetUsage", or
@@ -74,15 +74,15 @@ class Usecase:
:param material: The IfcMaterial or material set you are assigning here. :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 If type is Usage then no need to provide `material`, it will be deduced
from the element type automatically. from the element type automatically.
:type material: ifcopenshell.entity_instance.entity_instance, optional :type material: ifcopenshell.entity_instance, optional
:return: IfcRelAssociatesMaterial entity :return: IfcRelAssociatesMaterial entity
or a list of IfcRelAssociatesMaterial entities or a list of IfcRelAssociatesMaterial entities
(possible if `type` is Usage (possible if `type` is Usage
and `products` require different Usages) and `products` require different Usages)
or `None` if `products` was empty list. or `None` if `products` was empty list.
:rtype: Union[ :rtype: Union[
ifcopenshell.entity_instance.entity_instance, ifcopenshell.entity_instance,
list[ifcopenshell.entity_instance.entity_instance], None] list[ifcopenshell.entity_instance], None]
Example: Example:
@@ -29,9 +29,9 @@ class Usecase:
:param material_profile: The IfcMaterialProfile to change the profile :param material_profile: The IfcMaterialProfile to change the profile
curve of. See ifcopenshell.api.material.add_profile to see how to curve of. See ifcopenshell.api.material.add_profile to see how to
create profiles. 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. :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 :return: None
:rtype: None :rtype: None
@@ -28,9 +28,9 @@ class Usecase:
associated to any elements. associated to any elements.
:param material: The IfcMaterial to copy :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 :return: The new copy of the material
:rtype: ifcopenshell.entity_instance.entity_instance :rtype: ifcopenshell.entity_instance
Example: Example:
@@ -25,7 +25,7 @@ class Usecase:
IfcMaterial, consult the IFC documentation. IfcMaterial, consult the IFC documentation.
:param element: The IfcMaterial entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,11 +25,11 @@ class Usecase:
IfcMaterialConstituent, consult the IFC documentation. IfcMaterialConstituent, consult the IFC documentation.
:param constituent: The IfcMaterialConstituent entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:param material: The IfcMaterial entity you want to change the constituent to :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 :return: None
:rtype: None :rtype: None
@@ -25,12 +25,12 @@ class Usecase:
IfcMaterialLayer, consult the IFC documentation. IfcMaterialLayer, consult the IFC documentation.
:param layer: The IfcMaterialLayer entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:param material: The IfcMaterial entity you want the layer to be made :param material: The IfcMaterial entity you want the layer to be made
from. from.
:type material: ifcopenshell.entity_instance.entity_instance, optional :type material: ifcopenshell.entity_instance, optional
:return: None :return: None
:rtype: None :rtype: None
@@ -28,7 +28,7 @@ class Usecase:
IfcMaterialLayerSetUsage, consult the IFC documentation. IfcMaterialLayerSetUsage, consult the IFC documentation.
:param usage: The IfcMaterialLayerSetUsage entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,15 +25,15 @@ class Usecase:
IfcMaterialProfile, consult the IFC documentation. IfcMaterialProfile, consult the IFC documentation.
:param profile: The IfcMaterialProfile entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:param profile_def: The IfcProfileDef entity the profile curve should be :param profile_def: The IfcProfileDef entity the profile curve should be
extruded from. 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 :param material: The IfcMaterial entity you want to change the profile
to be made from. to be made from.
:type material: ifcopenshell.entity_instance.entity_instance, optional :type material: ifcopenshell.entity_instance, optional
:return: None :return: None
:rtype: None :rtype: None
@@ -33,7 +33,7 @@ class Usecase:
IfcMaterialProfileSetUsage, consult the IFC documentation. IfcMaterialProfileSetUsage, consult the IFC documentation.
:param usage: The IfcMaterialProfileSetUsage entity you want to edit :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. :param attributes: a dictionary of attribute names and values.
:type attributes: dict, optional :type attributes: dict, optional
:return: None :return: None
@@ -25,7 +25,7 @@ class Usecase:
at least one constituent to ensure a valid IFC dataset. at least one constituent to ensure a valid IFC dataset.
:param constituent: The IfcMaterialConstituent entity you want to remove :param constituent: The IfcMaterialConstituent entity you want to remove
:type constituent: ifcopenshell.entity_instance.entity_instance :type constituent: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -25,7 +25,7 @@ class Usecase:
at least one layer to ensure a valid IFC dataset. at least one layer to ensure a valid IFC dataset.
:param layer: The IfcMaterialLayer entity you want to remove :param layer: The IfcMaterialLayer entity you want to remove
:type layer: ifcopenshell.entity_instance.entity_instance :type layer: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -28,7 +28,7 @@ class Usecase:
:param material_list: The IfcMaterialList entity you want to remove an :param material_list: The IfcMaterialList entity you want to remove an
item from. 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 :param material_index: The index of the material you want to remove from
the list. Starts counting at 0. Defaults to 0. the list. Starts counting at 0. Defaults to 0.
:type material_index: int, optional :type material_index: int, optional
@@ -30,7 +30,7 @@ class Usecase:
take care of this situation themselves. take care of this situation themselves.
:param material: The IfcMaterial entity you want to remove :param material: The IfcMaterial entity you want to remove
:type material: ifcopenshell.entity_instance.entity_instance :type material: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -30,7 +30,7 @@ class Usecase:
:param material: The IfcMaterialLayerSet, IfcMaterialConstituentSet, :param material: The IfcMaterialLayerSet, IfcMaterialConstituentSet,
IfcMaterialProfileSet entity you want to remove. IfcMaterialProfileSet entity you want to remove.
:type material: ifcopenshell.entity_instance.entity_instance :type material: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -29,7 +29,7 @@ class Usecase:
at least one profile to ensure a valid IFC dataset. at least one profile to ensure a valid IFC dataset.
:param profile: The IfcMaterialProfile entity you want to remove :param profile: The IfcMaterialProfile entity you want to remove
:type profile: ifcopenshell.entity_instance.entity_instance :type profile: ifcopenshell.entity_instance
:return: None :return: None
:rtype: None :rtype: None
@@ -26,7 +26,7 @@ class Usecase:
:param material_set: The IfcMaterialSet which you want to reorder an :param material_set: The IfcMaterialSet which you want to reorder an
item in. 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 :param old_index: The index of the item you want to move. This starts
counting from 0. counting from 0.
:type old_index: int :type old_index: int

Some files were not shown because too many files have changed in this diff Show More