Struct UnallocatedRegion 

pub struct UnallocatedRegion { /* private fields */ }

One connected region of storey floor that belongs to no space.

Each region is measured on its own, so a rule can judge a large hole apart from small shafts on the same storey: a storey total would hide which one misses the allowance.

Implementations

impl UnallocatedRegion

pub fn try_new( storey: ObjectId, area_square_metres: f64, elements: Vec<ObjectId>, ) -> Result<Self, SpaceError>

A region of area_square_metres on storey, surrounded by elements (the bodies whose footprint meets its boundary).

pub fn with_floor_area(self, square_metres: f64) -> Result<Self, SpaceError>

States the storey’s gross floor area the region is part of, so a rule can judge the region’s share of it. A gross area smaller than the region, negative or non-finite is refused.

pub fn storey(&self) -> &ObjectId

pub fn area_square_metres(&self) -> f64

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

The storey’s gross floor area, when the service states it.

pub fn elements(&self) -> &[ObjectId]

The elements surrounding the region, in canonical order.

Trait Implementations

impl Clone for UnallocatedRegion

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnallocatedRegion

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

Formats the value using the given formatter.

impl PartialEq for UnallocatedRegion

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for UnallocatedRegion