:py:mod:`ontouml_py.model.namedelement`
=======================================

.. py:module:: ontouml_py.model.namedelement

.. autoapi-nested-parse::

   Module for the abstract NamedElement class within an OntoUML model.

   This module defines the NamedElement class, an abstract class representing elements with names in an OntoUML model. It
   extends the OntoumlElement class and includes additional attributes and validation for managing named elements' details
   such as their preferred name, alternative names, descriptions, editorial notes, as well as lists of creators and
   contributors.



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   ontouml_py.model.namedelement.NamedElement




.. py:class:: NamedElement(**data)


   Bases: :py:obj:`ontouml_py.model.ontoumlelement.OntoumlElement`

   Abstract base class representing a generic element within an OntoUML model.

   This class provides foundational attributes and methods for all OntoUML elements, including unique identification
   and timestamps for creation and modification. It enforces constraints on certain attributes and includes validation
   logic to maintain their integrity.

   :ivar id: A unique identifier for the element, automatically generated upon instantiation.
   :vartype id: str
   :ivar created: Timestamp when the element was created, defaults to the current time.
   :vartype created: datetime
   :ivar modified: Timestamp when the element was last modified, can be None if not modified.
   :vartype modified: Optional[datetime]
   :cvar model_config: Configuration settings for the Pydantic model.
   :vartype model_config: Dict[str, Any]

   .. py:attribute:: names
      :type: set[langstring.LangString]

      

   .. py:attribute:: alt_names
      :type: set[langstring.LangString]

      

   .. py:attribute:: description
      :type: Optional[langstring.LangString]

      

   .. py:attribute:: editorial_notes
      :type: set[langstring.LangString]

      

   .. py:attribute:: creators
      :type: set[str]

      

   .. py:attribute:: contributors
      :type: set[str]

      

   .. py:attribute:: model_config