Navigation

IfcDocumentReference

Definition from IAI: 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. In IFC Release 2x: Restructuring in reference and additional information
ISSUES: See issue and change log for changes made in IFC Release 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.

EXAMPLE: IAI mission in a document "Introduction to IAI" can be referenced by IfcDocumentReference.Location = 'http://iaiweb.lbl.gov/intro.html', and IfcDocumentReference.Name = 'Mission statement'. Additionally: IfcDocumentReference.ReferenceToDocument[1].Name = 'Introduction to IAI', and IfcDocumentReference.ReferenceToDocument[1].Description = 'Basic document to introduce the aims of IAI'.

The content in the example could be exchanged as follows:

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;

Formal Propositions:

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

References (3):

Name Type Referred through Express-G
IfcDocumentInformation Entity
Attribute 'DocumentReferences'
Diagram 3
IfcDocumentSelect Select
Select relation
Diagram 3
IfcExternalReference Entity
Subtype
Diagram 1

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;