:tocdepth: 3

:py:mod:`gws.base.model.scalar_field`
=====================================

.. py:module:: gws.base.model.scalar_field

.. autoapi-nested-parse::

   Generic scalar field.



**Source code:** :source:`gws.base.model.scalar_field<gws/base/model/scalar_field.py>`



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



.. py:class:: Config(*args, **kwargs)


   Bases: :py:obj:`gws.base.model.field.Config`

   Configuration for the scalar field.

   .. py:attribute:: isVirtual
      :type:  Optional[bool]

      The field is not stored in the DB. (added in 8.1)


.. py:class:: Object


   Bases: :py:obj:`gws.base.model.field.Object`

   Model field.

   .. py:attribute:: isVirtual
      :type:  bool

   .. py:method:: after_select(features, mc)

   .. py:method:: before_create(feature, mc)

   .. py:method:: before_select(mc)

   .. py:method:: before_update(feature, mc)

   .. py:method:: configure()

      Configuration hook.


   .. py:method:: do_init(feature, mc)

   .. py:method:: from_props(feature, mc)

   .. py:method:: from_record(feature, mc)

   .. py:method:: get_value(feature: gws.Feature, source: dict, has_access: bool, convert_fn: Callable, mc: gws.ModelContext)

   .. py:method:: model_value(mc: gws.ModelContext)

   .. py:method:: to_props(feature, mc)

   .. py:method:: to_record(feature, mc)


.. py:class:: Props(*args, **kwargs)


   Bases: :py:obj:`gws.base.model.field.Props`

   Object properties.