ifctester.ids

Module Contents

class ifctester.ids.Attribute(name='Name', value=None, cardinality: Cardinality = 'required', instructions=None)

Bases: Facet

filter(ifc_file: ifcopenshell.file, elements: list[ifcopenshell.entity_instance] | None) list[ifcopenshell.entity_instance]
applicability_templates = ['Data where the {name} is {value}', 'Data where the {name} is provided']
parameters = ['name', 'value', '@cardinality', '@instructions']
prohibited_templates = ['The {name} shall not be {value}', 'The {name} shall not be provided']
requirement_templates = ['The {name} shall be {value}', 'The {name} shall be provided']
class ifctester.ids.Classification(value=None, system=None, uri=None, cardinality: Cardinality = 'required', instructions=None)

Bases: Facet

filter(ifc_file: ifcopenshell.file, elements: list[ifcopenshell.entity_instance] | None) list[ifcopenshell.entity_instance]
applicability_templates = ['Data having a {system} reference of {value}', 'Data classified using {system}', 'Data...
parameters = ['value', 'system', '@uri', '@cardinality', '@instructions']
prohibited_templates = ['Shall not have a {system} reference of {value}', 'Shall not be classified using {system}',...
requirement_templates = ['Shall have a {system} reference of {value}', 'Shall be classified using {system}', 'Shall be...
class ifctester.ids.Entity(name='IFCWALL', predefinedType=None, instructions=None)

Bases: Facet

filter(ifc_file: ifcopenshell.file, elements: list[ifcopenshell.entity_instance] | None = None) list[ifcopenshell.entity_instance]
applicability_templates = ['All {name} data of type {predefinedType}', 'All {name} data']
parameters = ['name', 'predefinedType', '@instructions']
prohibited_templates = ['Shall not be {name} data of type {predefinedType}', 'Shall not be {name} data']
requirement_templates = ['Shall be {name} data of type {predefinedType}', 'Shall be {name} data']
class ifctester.ids.Material(value=None, uri=None, cardinality: Cardinality = 'required', instructions=None)

Bases: Facet

filter(ifc_file: ifcopenshell.file, elements: list[ifcopenshell.entity_instance] | None) list[ifcopenshell.entity_instance]
applicability_templates = ['All data with a {value} material', 'All data with a material']
parameters = ['value', '@uri', '@cardinality', '@instructions']
prohibited_templates = ['Shall not have a material of {value}', 'Shall not have a material']
requirement_templates = ['Shall have a material of {value}', 'Shall have a material']
class ifctester.ids.PartOf(name='IFCWALL', predefinedType=None, relation=None, cardinality: Cardinality = 'required', instructions=None)

Bases: Facet

asdict(clause_type: str) dict[str, Any]
filter(ifc_file: ifcopenshell.file, elements: list[ifcopenshell.entity_instance] | None) list[ifcopenshell.entity_instance]
get_parent(element)
parse(xml)
applicability_templates = ['An element with an {relation} relationship with an {name}', 'An element with an {relation}...
parameters = ['name', 'predefinedType', '@relation', '@cardinality', '@instructions']
prohibited_templates = ['An element must not have an {relation} relationship with an {name}', 'An element must not have...
requirement_templates = ['An element must have an {relation} relationship with an {name} of predefined type...
class ifctester.ids.Property(propertySet='Property_Set', baseName='PropertyName', value=None, dataType=None, uri=None, cardinality: Cardinality = 'required', instructions=None)

Bases: Facet

filter(ifc_file: ifcopenshell.file, elements: list[ifcopenshell.entity_instance] | None) list[ifcopenshell.entity_instance]
get_properties(pset)
applicability_templates = ['Elements with {baseName} data of {value} in the dataset {propertySet}', 'Elements with...
parameters = ['propertySet', 'baseName', 'value', '@dataType', '@uri', '@cardinality', '@instructions']
prohibited_templates = ['{baseName} data shall not be {value} and in the dataset {propertySet}', '{baseName} data shall...
requirement_templates = ['{baseName} data shall be {value} and in the dataset {propertySet}', '{baseName} data shall be...
class ifctester.ids.Restriction(options=None, base='string')
asdict() dict[str, Any]
parse(ids_dict)
base = 'string'
options