mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 17:31:45 +00:00
Fix docstrings to reference datatype as it would be used for users
This commit is contained in:
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user