src.pydasa.elements.specs.conceptual
====================================

.. py:module:: src.pydasa.elements.specs.conceptual

.. autoapi-nested-parse::

   Module conceptual.py
   ===========================================

   Conceptual perspective for variable representation.

   This module defines the ConceptualSpecs class representing the abstract
   identity and classification of a variable.

   Classes:
       **ConceptualSpecs**: Conceptual variable specifications

   *IMPORTANT:* Based on the theory from:

       # H.Gorter, *Dimensionalanalyse: Eine Theoririe der physikalischen Dimensionen mit Anwendungen*



Classes
-------

.. autoapisummary::

   src.pydasa.elements.specs.conceptual.ConceptualSpecs


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

.. py:class:: ConceptualSpecs

   Bases: :py:obj:`pydasa.core.basic.Foundation`


   Conceptual perspective: variable identity and classification.

   Answers the fundamental question: "What IS this variable?". This perspective focuses on:
       - What category does it belong to? (INPUT, OUTPUT, CONTROL)
       - Which framework is it part of? (PHYSICAL, COMPUTATION, SOFTWARE, CUSTOM)
       - Is it relevant for the current analysis?
       - What dimensional framework does it use?

   .. attribute:: # From Foundation

      _name (str): User-friendly name of the variable.
      description (str): Brief summary of the variable.
      _idx (int): Index/precedence in the dimensional matrix.
      _sym (str): Symbol representation (LaTeX or alphanumeric).
      _alias (str): Python-compatible alias for use in code.
      _fwk (str): Frameworks context (PHYSICAL, COMPUTATION, SOFTWARE, CUSTOM).

   .. attribute:: # From ConceptualSpecs

      _schema (Optional[Schema]): Reference to the dimensional framework schema.
      _cat (str): Category of the variable (INPUT, OUTPUT, CONTROL).
      relevant (bool): Flag indicating if variable is relevant for analysis.


   .. py:attribute:: relevant
      :type:  bool
      :value: False


      Flag indicating if variable is relevant for analysis.


   .. py:method:: __post_init__()

      *__post_init__()* Initializes the conceptual properties.

      Sets up the schema reference based on framework if not explicitly provided.

      :raises ValueError: If framework configuration is invalid.



   .. py:property:: cat
      :type: str


      *cat* Get the category of the variable.

      :returns: Category (INPUT, OUT, CTRL).
      :rtype: str


   .. py:property:: schema
      :type: Optional[pydasa.dimensional.vaschy.Schema]


      *schema* Get the dimensional schema reference.

      :returns: The dimensional framework schema.
      :rtype: Optional[Schema]


   .. py:method:: clear()

      *clear()* Reset conceptual attributes to default values.

      Resets category, schema, and relevance flag.