Class Ifc2x3::IfcDocumentInformation

Nested Relationships

This class is a nested type of Struct Ifc2x3.

Inheritance Relationships

Base Type

Class Documentation

class Ifc2x3::IfcDocumentInformation : public IfcUtil::IfcBaseEntity

IfcDocumentInformation captures “metadata” of an external document. The actual content of the document is not defined in IFC; instead, it can be found following the reference given to IfcDocumentReference.

HISTORY: New entity in IFC 2x.

Public Types

typedef IfcTemplatedEntityList<IfcDocumentInformation> list

Public Functions

std::string DocumentId() const

Identifier that uniquely identifies a document.

void setDocumentId(std::string v)
std::string Name() const

File name or document name assigned by owner.

void setName(std::string v)
bool hasDescription() const

Whether the optional attribute Description is defined for this IfcDocumentInformation.

std::string Description() const

Description of document and its content.

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

Whether the optional attribute DocumentReferences is defined for this IfcDocumentInformation.

IfcTemplatedEntityList<::Ifc2x3::IfcDocumentReference>::ptr DocumentReferences() const
void setDocumentReferences(IfcTemplatedEntityList<::Ifc2x3::IfcDocumentReference>::ptr v)
bool hasPurpose() const

Whether the optional attribute Purpose is defined for this IfcDocumentInformation.

std::string Purpose() const

Purpose for this document.

void setPurpose(std::string v)
bool hasIntendedUse() const

Whether the optional attribute IntendedUse is defined for this IfcDocumentInformation.

std::string IntendedUse() const

Intended use for this document.

void setIntendedUse(std::string v)
bool hasScope() const

Whether the optional attribute Scope is defined for this IfcDocumentInformation.

std::string Scope() const

Scope for this document.

void setScope(std::string v)
bool hasRevision() const

Whether the optional attribute Revision is defined for this IfcDocumentInformation.

std::string Revision() const

Document revision designation.

void setRevision(std::string v)
bool hasDocumentOwner() const

Whether the optional attribute DocumentOwner is defined for this IfcDocumentInformation.

::Ifc2x3::IfcActorSelect *DocumentOwner() const

Information about the person and/or organization acknowledged as the ‘owner’ of this document. In some contexts, the document owner determines who has access to or editing right to the document.

void setDocumentOwner(::Ifc2x3::IfcActorSelect *v)
bool hasEditors() const

Whether the optional attribute Editors is defined for this IfcDocumentInformation.

IfcEntityList::ptr Editors() const

The persons and/or organizations who have created this document or contributed to it.

void setEditors(IfcEntityList::ptr v)
bool hasCreationTime() const

Whether the optional attribute CreationTime is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDateAndTime *CreationTime() const

Date and time stamp when the document was originally created.

IFC2x4 CHANGE The data type has been changed to IfcDateTime, the date time string according to ISO8601.

void setCreationTime(::Ifc2x3::IfcDateAndTime *v)
bool hasLastRevisionTime() const

Whether the optional attribute LastRevisionTime is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDateAndTime *LastRevisionTime() const

Date and time stamp when this document version was created.

IFC2x4 CHANGE The data type has been changed to IfcDateTime, the date time string according to ISO8601.

void setLastRevisionTime(::Ifc2x3::IfcDateAndTime *v)
bool hasElectronicFormat() const

Whether the optional attribute ElectronicFormat is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDocumentElectronicFormat *ElectronicFormat() const

Describes the electronic format of the document being referenced, providing the file extension and the manner in which the content is provided.

void setElectronicFormat(::Ifc2x3::IfcDocumentElectronicFormat *v)
bool hasValidFrom() const

Whether the optional attribute ValidFrom is defined for this IfcDocumentInformation.

::Ifc2x3::IfcCalendarDate *ValidFrom() const

Date when the document becomes valid.

IFC2x4 CHANGE The data type has been changed to IfcDate, the date string according to ISO8601.

void setValidFrom(::Ifc2x3::IfcCalendarDate *v)
bool hasValidUntil() const

Whether the optional attribute ValidUntil is defined for this IfcDocumentInformation.

::Ifc2x3::IfcCalendarDate *ValidUntil() const

Date until which the document remains valid.

IFC2x4 CHANGE The data type has been changed to IfcDate, the date string according to ISO8601.

void setValidUntil(::Ifc2x3::IfcCalendarDate *v)
bool hasConfidentiality() const

Whether the optional attribute Confidentiality is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDocumentConfidentialityEnum::Value Confidentiality() const

The level of confidentiality of the document.

void setConfidentiality(::Ifc2x3::IfcDocumentConfidentialityEnum::Value v)
bool hasStatus() const

Whether the optional attribute Status is defined for this IfcDocumentInformation.

::Ifc2x3::IfcDocumentStatusEnum::Value Status() const

The current status of the document. Examples of status values that might be used for a document information status include:

  • DRAFT

  • FINAL DRAFT

  • FINAL

  • REVISION

void setStatus(::Ifc2x3::IfcDocumentStatusEnum::Value v)
IfcTemplatedEntityList<IfcDocumentInformationRelationship>::ptr IsPointedTo() const
IfcTemplatedEntityList<IfcDocumentInformationRelationship>::ptr IsPointer() const
const IfcParse::entity &declaration() const
IfcDocumentInformation(IfcEntityInstanceData *e)
IfcDocumentInformation(std::string v1_DocumentId, std::string v2_Name, boost::optional<std::string> v3_Description, boost::optional<IfcTemplatedEntityList<::Ifc2x3::IfcDocumentReference>::ptr> v4_DocumentReferences, boost::optional<std::string> v5_Purpose, boost::optional<std::string> v6_IntendedUse, boost::optional<std::string> v7_Scope, boost::optional<std::string> v8_Revision, ::Ifc2x3::IfcActorSelect *v9_DocumentOwner, boost::optional<IfcEntityList::ptr> v10_Editors, ::Ifc2x3::IfcDateAndTime *v11_CreationTime, ::Ifc2x3::IfcDateAndTime *v12_LastRevisionTime, ::Ifc2x3::IfcDocumentElectronicFormat *v13_ElectronicFormat, ::Ifc2x3::IfcCalendarDate *v14_ValidFrom, ::Ifc2x3::IfcCalendarDate *v15_ValidUntil, boost::optional<::Ifc2x3::IfcDocumentConfidentialityEnum::Value> v16_Confidentiality, boost::optional<::Ifc2x3::IfcDocumentStatusEnum::Value> v17_Status)

Public Static Functions

const IfcParse::entity &Class()