Struct CostValue 

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

A borrowed view of an IfcCostValue entity.

Implementations

impl<'m> CostValue<'m>

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

Wrap an entity known to be an IfcCostValue.

pub fn id(&self) -> EntityId

The entity id in the file.

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

The value’s name, e.g. Estimate.

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

The value’s description.

pub fn amount(&self) -> Option<f64>

The directly stated amount.

None for a composed value that states only Components. Use CostValue::component_refs and CostValue::operator for those, or CostValue::is_composed to tell the two shapes apart.

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

The measure type wrapping the applied value, e.g. IFCMONETARYMEASURE.

A cost value is not required to be monetary: IfcAppliedValueSelect also admits ratios and plain measures. Reporting the wrapper lets a caller refuse to add a ratio to a currency.

pub fn is_monetary(&self) -> bool

Whether the applied value is a monetary measure.

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

The rate category, e.g. Labour or Material.

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

The condition under which the value applies.

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

The date from which the value applies, as authored.

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

The date after which the value no longer holds, as authored.

pub fn operator(&self) -> Option<ArithmeticOperator>

How this value’s components combine, if stated.

pub fn component_refs(&self) -> Vec<EntityId>

Ids of the nested IfcAppliedValue components, in file order.

Order is preserved because it is the only ordering information the file carries, and an order-sensitive operator needs it.

pub fn is_composed(&self) -> bool

Whether this value is composed from components rather than stated.

pub fn unit_basis(&self, model: &Model) -> Option<UnitBasis>

The rate basis, if this value is a rate rather than a lump sum.

Resolves the IfcMeasureWithUnit: slot 0 is ValueComponent, slot 1 is UnitComponent.

Trait Implementations

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

impl<'m> Debug for CostValue<'m>

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

Formats the value using the given formatter.