Navigation
Navigate Navigate Navigate Navigate Navigate Navigate Navigate Navigate

IfcDocumentReference

Definition from buildingSMART: An IfcDocumentReference is a reference to the location of a document. The reference is given by a system interpretable Location attribute (e.g., an URL string) or by a human readable location, where the document can be found, and an optional inherited internal reference ItemReference, which refers to a system interpretable position within the document. The optional inherited Name attribute is meant to have meaning for human readers. Optional document metadata can also be captured through reference to IfcDocumentInformation.

HISTORY: New Entity in IFC Release 2.0. Modified in IFC 2x.

Use Definitions

Provides a lightweight capability that enables a document to be identified solely by reference to a name by which it is commonly known. The reference can also be used to point to document information for more detail as required.

For example, the buildingSMART mission statement in a document "Introduction to buildingSMART" can be referenced by IfcDocumentReference.Location = 'http://buildingsmart.org/about', and IfcDocumentReference = 'Mission statement'. Additionally: IfcDocumentReference.ReferenceToDocument[1].Name = 'Introduction to buildingSMART', and IfcDocumentReference.ReferenceToDocument[1].Description = 'Basic document to introduce the aims of buildingSMART'.

EXPRESS specification:

ENTITY IfcDocumentReference
SUBTYPE OF ( IfcExternalReference);
INVERSE
ReferenceToDocument  :  SET [0:1] OF IfcDocumentInformation FOR DocumentReferences;
WHERE
WR1  :  EXISTS(Name) XOR EXISTS(ReferenceToDocument[1]);
END_ENTITY;

Attribute definitions:

ReferenceToDocument  :  The document information that is being referenced.

Formal Propositions:

WR1  :  A name should only be given, if no document information (including the document name) is attached

Inheritance graph

ENTITY IfcDocumentReference;
ENTITY IfcExternalReference;
Location  :  OPTIONAL IfcLabel;
ItemReference  :  OPTIONAL IfcIdentifier;
Name  :  OPTIONAL IfcLabel;
ENTITY IfcDocumentReference;
INVERSE
ReferenceToDocument  :  SET [0:1] OF IfcDocumentInformation FOR DocumentReferences;
END_ENTITY;