Class: Entity¶

Common base class for everything in the project graph. Has identity, lifecycle, and status.

NOTE: this is an abstract class and should not be instantiated directly

classDiagram
direction TB
class Entity
click Entity href "./Entity.html" _blank
Entity <|-- Agent
click Agent href "./Agent.html" _blank
Entity <|-- Decision
click Decision href "./Decision.html" _blank
Entity <|-- Task
click Task href "./Task.html" _blank
Entity <|-- Process
click Process href "./Process.html" _blank
Entity <|-- Message
click Message href "./Message.html" _blank
Entity <|-- Artifact
click Artifact href "./Artifact.html" _blank
Entity <|-- Contract
click Contract href "./Contract.html" _blank
Entity <|-- Project
click Project href "./Project.html" _blank
Entity <|-- Program
click Program href "./Program.html" _blank
Entity <|-- Product
click Product href "./Product.html" _blank
Entity <|-- Deliverable
click Deliverable href "./Deliverable.html" _blank
Entity <|-- Requirement
click Requirement href "./Requirement.html" _blank
Entity <|-- PhysicalElement
click PhysicalElement href "./PhysicalElement.html" _blank
Entity <|-- VirtualEntity
click VirtualEntity href "./VirtualEntity.html" _blank
click Entity href "./Entity.html" _blank
click Classification href "./Classification.html" _blank
click GeometryRepresentation href "./GeometryRepresentation.html" _blank
click LocalizedText href "./LocalizedText.html" _blank
click LocalizedText href "./LocalizedText.html" _blank
click MetadataEntry href "./MetadataEntry.html" _blank
click PerformanceProperty href "./PerformanceProperty.html" _blank
click QuantityValue href "./QuantityValue.html" _blank
click StatusType href "./StatusType.html" _blank

Hold "Alt" / "Option" to enable pan & zoom

Inheritance¶

Entity
- Agent
- Decision
- Task
- Process
- Message
- Artifact
- Contract
- Project
- Program
- Product
- Deliverable
- Requirement
- PhysicalElement
- VirtualEntity

Class Properties¶

Property	Value
Class URI	pbs:Entity

Slots¶

Name	Cardinality and Range	Description	Inheritance
id	1 String	Unique local identifier.	direct
content_kind	1 String	Entity type discriminator for adapter projection and querying. Must be a ContentKind value.	direct
name	1 String	Default display name.	direct
localized_names	* LocalizedText	Localized variants of name.	direct
description	0..1 String	Default description text.	direct
meaning_uri	0..1 Uriorcurie	Optional semantic URI for linking the entity instance to an external ontology concept.	direct
localized_descriptions	* LocalizedText	Localized variants of description.	direct
ifc_global_id	0..1 String	IFC GlobalId of the mapped entity.	direct
classifications	* Classification	Classification entries from IFC and other schemes.	direct
geometry_representations	* GeometryRepresentation	Geometry references associated with the entity. A single element may link to multiple geometry representations to serve different intents (authoring, coordination, analysis, visualization) without duplicating the element itself.	direct
quantity_values	* QuantityValue	Quantities associated with the entity.	direct
metadata	* MetadataEntry	Generic metadata container for IFC attributes/properties and project-specific extensions.	direct
performance_properties	* PerformanceProperty	Normalized, strongly typed domain properties (fire/acoustic/thermal/structural/ security/material) extracted from raw IFC PropertySet values.	direct
applies_to_entities	* Entity	Model entities this record applies to (requirements, cost items, schedule items, etc.).	direct
created_at	0..1 Datetime	Creation timestamp for this entity record.	direct
modified_at	0..1 Datetime	Last modification timestamp for this entity record.	direct
revision	0..1 Integer	Integer revision counter for change tracking.	direct
status	0..1 StatusType	Lifecycle or QA status.	direct

Usages¶

used by	used in	type	used
Entity	applies_to_entities	range	Entity
Agent	applies_to_entities	range	Entity
Person	applies_to_entities	range	Entity
Company	applies_to_entities	range	Entity
SoftwareAgent	applies_to_entities	range	Entity
Decision	applies_to_entities	range	Entity
Task	applies_to_entities	range	Entity
Process	applies_to_entities	range	Entity
Message	applies_to_entities	range	Entity
Artifact	applies_to_entities	range	Entity
Contract	applies_to_entities	range	Entity
Project	applies_to_entities	range	Entity
Program	applies_to_entities	range	Entity
Product	applies_to_entities	range	Entity
Deliverable	applies_to_entities	range	Entity
Requirement	applies_to_entities	range	Entity
PerformanceRequirement	applies_to_entities	range	Entity
SpatialRequirement	related_entity	range	Entity
SpatialRequirement	applies_to_entities	range	Entity
RegulatoryRequirement	applies_to_entities	range	Entity
BriefRequirement	applies_to_entities	range	Entity
DeliverableRequirement	applies_to_entities	range	Entity
ScheduleRequirement	related_time_record	range	Entity
ScheduleRequirement	applies_to_entities	range	Entity
CostRequirement	applies_to_entities	range	Entity
MaterialRequirement	related_material	range	Entity
MaterialRequirement	applies_to_entities	range	Entity
PhysicalElement	applies_to_entities	range	Entity
Separator	applies_to_entities	range	Entity
SeparatorWall	applies_to_entities	range	Entity
SeparatorSlab	applies_to_entities	range	Entity
ConnectionPhysical	applies_to_entities	range	Entity
Boundary	applies_to_entities	range	Entity
Equipment	applies_to_entities	range	Entity
VirtualEntity	applies_to_entities	range	Entity
SpatialContext	group_members	range	Entity
SpatialContext	applies_to_entities	range	Entity
PerimeterContext	group_members	range	Entity
PerimeterContext	applies_to_entities	range	Entity
LegalSiteContext	group_members	range	Entity
LegalSiteContext	applies_to_entities	range	Entity
BuiltAssetContext	group_members	range	Entity
BuiltAssetContext	applies_to_entities	range	Entity
BuildingContext	group_members	range	Entity
BuildingContext	applies_to_entities	range	Entity
CivilStructureContext	group_members	range	Entity
CivilStructureContext	applies_to_entities	range	Entity
LevelContext	group_members	range	Entity
LevelContext	applies_to_entities	range	Entity
ZoneContext	group_members	range	Entity
ZoneContext	applies_to_entities	range	Entity
Space	contained_entities	range	Entity
Space	applies_to_entities	range	Entity
System	contained_entities	range	Entity
System	applies_to_entities	range	Entity
ConnectionVirtual	applies_to_entities	range	Entity
TimeRecord	applies_to_entities	range	Entity
CostRecord	applies_to_entities	range	Entity
Material	applies_to_entities	range	Entity
Change	affected_subject	range	Entity
PropertyChange	affected_subject	range	Entity
GeometryChange	affected_subject	range	Entity
RequirementChange	affected_subject	range	Entity
MatchChange	affected_subject	range	Entity
AdditionChange	affected_subject	range	Entity
DeletionChange	affected_subject	range	Entity

Identifier and Mapping Information¶

Schema Source¶

from schema: https://schema.pragmaticbim.ch

Mappings¶

Mapping Type	Mapped Value
self	pbs:Entity
native	pbs:Entity

LinkML Source¶

Direct¶

name: Entity
description: Common base class for everything in the project graph. Has identity,
  lifecycle, and status.
from_schema: https://schema.pragmaticbim.ch
abstract: true
slots:
- id
- content_kind
- name
- localized_names
- description
- meaning_uri
- localized_descriptions
- ifc_global_id
- classifications
- geometry_representations
- quantity_values
- metadata
- performance_properties
- applies_to_entities
- created_at
- modified_at
- revision
- status
slot_usage:
  id:
    name: id
    identifier: true
    required: true
  content_kind:
    name: content_kind
    required: true
class_uri: pbs:Entity

Induced¶

name: Entity
description: Common base class for everything in the project graph. Has identity,
  lifecycle, and status.
from_schema: https://schema.pragmaticbim.ch
abstract: true
slot_usage:
  id:
    name: id
    identifier: true
    required: true
  content_kind:
    name: content_kind
    required: true
attributes:
  id:
    name: id
    description: Unique local identifier.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    identifier: true
    owner: Entity
    domain_of:
    - Entity
    - Change
    range: string
    required: true
  content_kind:
    name: content_kind
    description: Entity type discriminator for adapter projection and querying. Must
      be a ContentKind value.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: string
    required: true
  name:
    name: name
    description: Default display name.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: string
    required: true
  localized_names:
    name: localized_names
    description: Localized variants of name.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: LocalizedText
    multivalued: true
    inlined: true
  description:
    name: description
    description: Default description text.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: string
  meaning_uri:
    name: meaning_uri
    description: Optional semantic URI for linking the entity instance to an external
      ontology concept.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: uriorcurie
  localized_descriptions:
    name: localized_descriptions
    description: Localized variants of description.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: LocalizedText
    multivalued: true
    inlined: true
  ifc_global_id:
    name: ifc_global_id
    description: IFC GlobalId of the mapped entity.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    - Change
    range: string
    pattern: ^[0-3][0-9A-Za-z_$]{21}$
  classifications:
    name: classifications
    description: Classification entries from IFC and other schemes.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    - Artifact
    range: Classification
    multivalued: true
    inlined: true
  geometry_representations:
    name: geometry_representations
    description: 'Geometry references associated with the entity. A single element
      may link to multiple geometry representations to serve different intents (authoring,
      coordination, analysis, visualization) without duplicating the element itself.

      '
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: GeometryRepresentation
    multivalued: true
    inlined: true
  quantity_values:
    name: quantity_values
    description: Quantities associated with the entity.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: QuantityValue
    multivalued: true
    inlined: true
  metadata:
    name: metadata
    description: Generic metadata container for IFC attributes/properties and project-specific
      extensions.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: MetadataEntry
    multivalued: true
    inlined: true
  performance_properties:
    name: performance_properties
    description: 'Normalized, strongly typed domain properties (fire/acoustic/thermal/structural/
      security/material) extracted from raw IFC PropertySet values.

      '
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: PerformanceProperty
    multivalued: true
    inlined: true
  applies_to_entities:
    name: applies_to_entities
    description: Model entities this record applies to (requirements, cost items,
      schedule items, etc.).
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    - TimeRecord
    - CostRecord
    range: Entity
    multivalued: true
    inlined: false
  created_at:
    name: created_at
    description: Creation timestamp for this entity record.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: datetime
  modified_at:
    name: modified_at
    description: Last modification timestamp for this entity record.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: datetime
  revision:
    name: revision
    description: Integer revision counter for change tracking.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: integer
    minimum_value: 0
  status:
    name: status
    description: Lifecycle or QA status.
    from_schema: https://schema.pragmaticbim.ch
    rank: 1000
    owner: Entity
    domain_of:
    - Entity
    range: StatusType
class_uri: pbs:Entity