Struct DocumentInformation 

pub struct DocumentInformation<'m> { /* private fields */ }

Borrowed projection of an IFCDOCUMENTINFORMATION entity.

Projections handed out by a crate::ClassificationView read against the release the model declares (IFC2X3, IFC4 or IFC4X3); one built with try_new has no model and reads against IFC4, as in 0.2.0.

Implementations

impl<'m> DocumentInformation<'m>

pub fn try_new(id: EntityId, entity: &'m Entity) -> ClassificationResult<Self>

Project entity as IFCDOCUMENTINFORMATION, checking its runtime type; fails with WrongEntityType if it is not.

Without a model there is no header to bind, so the projection reads against IFC4. Use the view’s lookups to read another release.

pub const fn id(self) -> EntityId

Entity id of the underlying instance.

pub const fn entity(self) -> &'m Entity

Borrowed underlying entity record.

impl<'m> DocumentInformation<'m>

pub fn identification(self) -> ClassificationResult<&'m str>

The required Identification code of the document.

pub fn name(self) -> ClassificationResult<&'m str>

The required Name of the document.

pub fn description(self) -> ClassificationResult<Option<&'m str>>

The Description of the document, when authored.

pub fn location(self) -> ClassificationResult<Option<&'m str>>

The Location (e.g. a URI) of the document, when authored.

pub fn purpose(self) -> ClassificationResult<Option<&'m str>>

The Purpose the document serves, when authored.

pub fn intended_use(self) -> ClassificationResult<Option<&'m str>>

The IntendedUse of the document, when authored.

pub fn scope(self) -> ClassificationResult<Option<&'m str>>

The Scope of the document, when authored.

pub fn revision(self) -> ClassificationResult<Option<&'m str>>

The Revision label of the document, when authored.

pub fn document_owner_id(self) -> ClassificationResult<Option<EntityId>>

Id of the DocumentOwner (an IfcActorSelect), when authored.

pub fn editors(self) -> ClassificationResult<Option<Vec<EntityId>>>

Ids of the Editors (IfcActorSelect members) who worked on the document, when authored.

pub fn creation_time(self) -> ClassificationResult<Option<&'m str>>

The CreationTime of the document, when authored.

pub fn last_revision_time(self) -> ClassificationResult<Option<&'m str>>

The LastRevisionTime of the document, when authored.

pub fn electronic_format(self) -> ClassificationResult<Option<&'m str>>

The ElectronicFormat (e.g. a MIME type) of the document, when authored.

pub fn valid_from(self) -> ClassificationResult<Option<&'m str>>

The ValidFrom date of the document, when authored.

pub fn valid_until(self) -> ClassificationResult<Option<&'m str>>

The ValidUntil date of the document, when authored.

pub fn confidentiality(self) -> ClassificationResult<Option<&'m str>>

The Confidentiality enumerator of the document, when authored: one of the bound release’s IfcDocumentConfidentialityEnum values (PUBLIC, RESTRICTED, CONFIDENTIAL, PERSONAL, USERDEFINED, NOTDEFINED in IFC2X3, IFC4 and IFC4X3).

pub fn status(self) -> ClassificationResult<Option<&'m str>>

The Status enumerator of the document, when authored: one of the bound release’s IfcDocumentStatusEnum values (DRAFT, FINALDRAFT, FINAL, REVISION, NOTDEFINED in IFC2X3, IFC4 and IFC4X3).

Trait Implementations

impl<'m> Clone for DocumentInformation<'m>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'m> Copy for DocumentInformation<'m>

impl<'m> Debug for DocumentInformation<'m>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.