src.pydasa.dimensional.fundamental
==================================

.. py:module:: src.pydasa.dimensional.fundamental

.. autoapi-nested-parse::

   Module fundamental.py
   ===========================================

   Module for representing the **FDU** or **Fundamental Dimensional Unit** for Dimensional Analysis in *PyDASA*.

   Classes:
       **Dimension**: Represents a Fundamental Dimensional Unit (FDU) with validation and conversion capabilities.

   *IMPORTANT:* Based on the theory from:

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



Classes
-------

.. autoapisummary::

   src.pydasa.dimensional.fundamental.Dimension


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

.. py:class:: Dimension

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


   **Dimension** class for processing the data of a Fundamental Dimensional Unit (FDU) in *PyDASA*.

   FDUs are fundamental building blocks of dimensional analysis and are used to define the dimensions of physical and digital quantities.

   :param Foundation: Foundation class for validation of symbols and frameworks.

   .. attribute:: _idx

      The Index of the Fundamental Dimension (precedence in the Dimensional Matrix).

      :type: int

   .. attribute:: _sym

      The symbol of the Fundamental Dimension (LaTeX or alphanumeric).

      :type: str

   .. attribute:: _alias

      The Python-compatible alias for the Fundamental Dimension, used in executable code.

      :type: str

   .. attribute:: _fwk

      The framework of the Fundamental Dimension (PHYSICAL, COMPUTATION, SOFTWARE, CUSTOM).

      :type: str

   .. attribute:: _unit

      The basic unit of the Fundamental Dimension, useful for unit of meassure convertion (e.g.: km -> m or GB -> bit).

      :type: str

   .. attribute:: name

      User-friendly name of the Fundamental Dimension.

      :type: str

   .. attribute:: description

      Brief summary of the Fundamental Dimension.

      :type: str


   .. py:attribute:: _unit
      :type:  str
      :value: ''


      m, s, bit).

      :type: Basic unit of the Fundamental Dimension (e.g.


   .. py:property:: unit
      :type: str


      *unit* Get the framework.

      :returns: Frameworks value
      :rtype: str


   .. py:method:: to_dict()

      *to_dict* Convert the Dimension to a dictionary representation.

      :returns: Dictionary representation of the Dimension.
      :rtype: dict



   .. py:method:: from_dict(data)
      :classmethod:


      *from_dict* Create a Dimension instance from a dictionary.

      :param data: Dictionary containing Dimension attributes.
      :type data: dict

      :returns: Instance of Dimension created from the dictionary.
      :rtype: Dimension