Class Ifc4::IfcDocumentReference

Nested Relationships

This class is a nested type of Struct Ifc4.

Inheritance Relationships

Base Type

Class Documentation

class Ifc4::IfcDocumentReference : public Ifc4::IfcExternalReference

An IfcDocumentReference is a reference to the location of a document. The reference is given by a system interpretable Location attribute (a URL string) where the document can be found, and an optional inherited internal reference Identification, 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.

Public Types

typedef IfcTemplatedEntityList<IfcDocumentReference> list

Public Functions

bool hasDescription() const

Whether the optional attribute Description is defined for this IfcDocumentReference.

std::string Description() const

Description of the document reference for informational purposes.

IFC2x4 CHANGE New attribute added at the end of the attribute list.

void setDescription(std::string v)
bool hasReferencedDocument() const

Whether the optional attribute ReferencedDocument is defined for this IfcDocumentReference.

::Ifc4::IfcDocumentInformation *ReferencedDocument() const

The document that is referenced.

void setReferencedDocument(::Ifc4::IfcDocumentInformation *v)
IfcTemplatedEntityList<IfcRelAssociatesDocument>::ptr DocumentRefForObjects() const
const IfcParse::entity &declaration() const
IfcDocumentReference(IfcEntityInstanceData *e)
IfcDocumentReference(boost::optional<std::string> v1_Location, boost::optional<std::string> v2_Identification, boost::optional<std::string> v3_Name, boost::optional<std::string> v4_Description, ::Ifc4::IfcDocumentInformation *v5_ReferencedDocument)

Public Static Functions

const IfcParse::entity &Class()