ifc-structural 0.2.1

//! `IfcStructuralLoadGroup` projection.

use ifc_model::EntityId;
use ifc_schema::SchemaVersion;

use crate::error::StructuralResult;
use crate::view::Record;

/// Borrowed projection of an `IfcStructuralLoadGroup`.
#[derive(Debug, Clone, Copy)]
pub struct LoadGroup<'m, 's> {
    record: Record<'m, 's>,
}

impl<'m, 's> LoadGroup<'m, 's> {
    pub(crate) fn from_record(record: Record<'m, 's>) -> Self {
        Self { record }
    }

    #[must_use]
    /// The `IfcStructuralLoadGroup` entity id.
    pub fn id(&self) -> EntityId {
        self.record.id
    }

    /// `Name`, inherited from `IfcRoot`. Legally absent.
    pub fn name(&self) -> StructuralResult<Option<&'m str>> {
        self.validate_semantics()?;
        self.record.optional_text("Name")
    }

    /// `PredefinedType`, always mandatory.
    pub fn predefined_type(&self) -> StructuralResult<&'m str> {
        self.validate_semantics()?;
        self.record.required_enum("PredefinedType")
    }

    /// `ActionType`, always mandatory.
    pub fn action_type(&self) -> StructuralResult<&'m str> {
        self.validate_semantics()?;
        self.record.required_enum("ActionType")
    }

    /// `ActionSource`, always mandatory.
    pub fn action_source(&self) -> StructuralResult<&'m str> {
        self.validate_semantics()?;
        self.record.required_enum("ActionSource")
    }

    /// `Coefficient`, a combination factor applied to this group's loads. Legally absent.
    pub fn coefficient(&self) -> StructuralResult<Option<f64>> {
        self.validate_semantics()?;
        self.record.optional_number("Coefficient")
    }

    /// `Purpose`, a free-text description of the load group's role. Legally absent.
    pub fn purpose(&self) -> StructuralResult<Option<&'m str>> {
        self.validate_semantics()?;
        self.record.optional_text("Purpose")
    }

    /// Validates the `USERDEFINED`-requires-`ObjectType` rule for IFC4/IFC4X3.
    ///
    /// Fails with [`crate::StructuralError::SemanticViolation`] if
    /// `PredefinedType`, `ActionType`, or `ActionSource` is `USERDEFINED`
    /// but `ObjectType` is unset. IFC2X3 declares no such constraint here.
    fn validate_semantics(&self) -> StructuralResult<()> {
        if self.record.schema.version() == Some(SchemaVersion::Ifc2x3) {
            return Ok(());
        }
        let user_defined = ["PredefinedType", "ActionType", "ActionSource"]
            .into_iter()
            .try_fold(false, |found, attribute| {
                self.record
                    .required_enum(attribute)
                    .map(|value| found || value.eq_ignore_ascii_case("USERDEFINED"))
            })?;
        self.record.require_object_type_if(
            user_defined,
            "USERDEFINED load group metadata requires ObjectType",
        )
    }
}