openehr-lang 0.0.76

// @generated by openehr-codegen from BMM (`P_BMM_CLASS`) — DO NOT EDIT.
// SPDX-FileCopyrightText: Vernum Projecten B.V.
// SPDX-FileCopyrightText: openEHR Foundation
// SPDX-License-Identifier: Apache-2.0

//! The openEHR `P_BMM_CLASS` spec class, generated from the vendored BMM
//! meta-model.

use crate::v1_0::bmm::core::entity::bmm_class::BmmClass;
use crate::v1_0::bmm_persistence::p_bmm_enumeration::PBmmEnumeration;
use crate::v1_0::bmm_persistence::p_bmm_generic_parameter::PBmmGenericParameter;
use crate::v1_0::bmm_persistence::p_bmm_generic_type::PBmmGenericType;
use crate::v1_0::bmm_persistence::p_bmm_property::PBmmProperty;

/// Definition of persistent form of `BMM_CLASS` for serialisation to ODIN, JSON, XML etc.
#[doc(alias = "P_BMM_CLASS")]
#[derive(Debug, Clone, PartialEq)]
pub struct PBmmClassData {
    // inherited: P_BMM_MODEL_ELEMENT
    /// Optional documentation of this element.
    pub documentation: Option<String>,
    /// Name of the class. Persisted attribute.
    pub name: String,
    /// List of immediate inheritance parents. If there are generic ancestors, use `_ancestor_defs_` instead. Persisted attribute.
    pub ancestors: Option<Vec<String>>,
    /// List of attributes defined in this class. Persistent attribute.
    pub properties: Option<std::collections::BTreeMap<String, PBmmProperty>>,
    /// True if this is an abstract type. Persisted attribute.
    pub is_abstract: Option<bool>,
    /// True if this class definition overrides one found in an included schema.
    pub is_override: Option<bool>,
    /// List of generic parameter definitions. Persisted attribute.
    pub generic_parameter_defs: Option<std::collections::BTreeMap<String, PBmmGenericParameter>>,
    /// Reference to original source schema defining this class.
    ///
    /// Set during `BMM_SCHEMA` materialise. Useful for GUI tools to enable user to edit the schema file containing a given class (i.e. taking into account that a class may be in any of the schemas in a schema inclusion hierarchy).
    pub source_schema_id: String,
    /// `BMM_CLASS` object built by `_create_bmm_class_definition_` and `_populate_bmm_class_definition_`.
    pub bmm_class: Option<BmmClass>,
    /// Unique id generated for later comparison during merging, in order to detect if two classes are the same. Assigned in post-load processing.
    pub uid: i32,
    /// List of structured inheritance ancestors, used only in the case of generic inheritance. Persisted attribute.
    pub ancestor_defs: Option<Vec<PBmmGenericType>>,
}

/// Polymorphic slot of `P_BMM_CLASS`, dispatched on each payload's `_type`.
///
/// Definition of persistent form of `BMM_CLASS` for serialisation to ODIN, JSON, XML etc.
#[doc(alias = "P_BMM_CLASS")]
#[derive(Debug, Clone, PartialEq)]
pub enum PBmmClass {
    /// The `P_BMM_ENUMERATION` subtype of `P_BMM_CLASS`.
    PBmmEnumeration(PBmmEnumeration),
    /// An instance of `P_BMM_CLASS` itself (its own, least-rich form).
    PBmmClass(PBmmClassData),
}