Struct DocumentReference 

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

Borrowed projection of an IFCDOCUMENTREFERENCE 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> DocumentReference<'m>

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

Project entity as IFCDOCUMENTREFERENCE, 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> DocumentReference<'m>

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

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

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

The Identification code of the referenced document, when authored.

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

The Name of the referenced document; mutually exclusive with referenced_document_id.

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

The Description of the referenced document, when authored.

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

Id of the ReferencedDocument (an IfcDocumentInformation); mutually exclusive with name.

pub fn validate(self) -> ClassificationResult<()>

Checks IfcExternalReference.WR1 (at least one of Location, Identification, Name stated) and the local WR1 rule that exactly one of Name and ReferencedDocument is stated.

Trait Implementations

impl<'m> Clone for DocumentReference<'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 DocumentReference<'m>

impl<'m> Debug for DocumentReference<'m>

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

Formats the value using the given formatter.