mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-11 10:06:47 +00:00
Write documentation for resource API module
This commit is contained in:
@@ -53,8 +53,7 @@ class Usecase:
|
||||
# Setup an organisation with a single role
|
||||
organisation = ifcopenshell.api.run("owner.add_organisation", model,
|
||||
identification="AWB", name="Architects Without Ballpens")
|
||||
role = ifcopenshell.api.run("owner.add_role", model, assigned_object=organisation)
|
||||
ifcopenshell.api.run("owner.edit_role", model, role=role, attributes={"Role": "ARCHITECT"})
|
||||
role = ifcopenshell.api.run("owner.add_role", model, assigned_object=organisation, role="ARCHITECT")
|
||||
|
||||
# Assign that organisation to a newly created actor
|
||||
actor = ifcopenshell.api.run("owner.add_actor", model, actor=organisation)
|
||||
|
||||
@@ -31,11 +31,14 @@ class Usecase:
|
||||
|
||||
Here are a list of objects you may assign an actor to:
|
||||
|
||||
- IfcControl: Indicates project directives issued by the actor.
|
||||
- IfcGroup: Indicates groups for which the actor is responsible.
|
||||
- IfcProduct: Indicates products for which the actor is responsible.
|
||||
- IfcProcess: Indicates processes for which the actor is responsible.
|
||||
- IfcResource: Indicates resources for which the actor is responsible.
|
||||
* IfcControl: Indicates project directives issued by the actor.
|
||||
* IfcGroup: Indicates groups for which the actor is responsible.
|
||||
* IfcProduct: Indicates products for which the actor is responsible.
|
||||
* IfcProcess: Indicates processes for which the actor is responsible.
|
||||
* IfcResource: Indicates resources for which the actor is responsible to
|
||||
allocate, manage, or delegate. This is not the actor actually using
|
||||
the resource or performing the work. For that type of actor, see
|
||||
ifcopenshell.api.resource.assign_resource.
|
||||
|
||||
:param relating_actor: The IfcActor who is responsible for the object.
|
||||
:type relating_actor: ifcopenshell.entity_instance.entity_instance
|
||||
|
||||
Reference in New Issue
Block a user