mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-09-18 22:33:33 +00:00
More documentation
This commit is contained in:
committed by
Thomas Krijnen
parent
d62bbd995f
commit
295b2fb56b
@@ -153,6 +153,24 @@ class entity_instance(object):
|
|||||||
return repr(self.wrapped_data)
|
return repr(self.wrapped_data)
|
||||||
|
|
||||||
def is_a(self, *args):
|
def is_a(self, *args):
|
||||||
|
"""Return the IFC class name of an instance, or checks if an instance belongs to a class.
|
||||||
|
|
||||||
|
The check will also return true if a parent class name is provided.
|
||||||
|
|
||||||
|
:param args: If specified, is a case insensitive IFC class name to check
|
||||||
|
:type args: string
|
||||||
|
:returns: Either the name of the class, or a boolean if it passes the check
|
||||||
|
:rtype: string|bool
|
||||||
|
|
||||||
|
Example::
|
||||||
|
|
||||||
|
f = ifcopenshell.file()
|
||||||
|
f.create_entity('IfcPerson')
|
||||||
|
f.is_a()
|
||||||
|
>>> 'IfcPerson'
|
||||||
|
f.is_a('IfcPerson')
|
||||||
|
>>> True
|
||||||
|
"""
|
||||||
return self.wrapped_data.is_a(*args)
|
return self.wrapped_data.is_a(*args)
|
||||||
|
|
||||||
def id(self):
|
def id(self):
|
||||||
|
|||||||
@@ -128,6 +128,8 @@ class file(object):
|
|||||||
def by_type(self, type):
|
def by_type(self, type):
|
||||||
"""Return IFC objects filtered by IFC Type and wrapped with the entity_instance class.
|
"""Return IFC objects filtered by IFC Type and wrapped with the entity_instance class.
|
||||||
|
|
||||||
|
If an IFC type class has subclasses, all entities of those subclasses are also returned.
|
||||||
|
|
||||||
:param type: The case insensitive type of IFC class to return.
|
:param type: The case insensitive type of IFC class to return.
|
||||||
:type type: string
|
:type type: string
|
||||||
:returns: A list of ifcopenshell.entity_instance.entity_instance objects
|
:returns: A list of ifcopenshell.entity_instance.entity_instance objects
|
||||||
|
|||||||
Reference in New Issue
Block a user