``options``
===============================

.. py:module:: optimeed.core.options


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

Classes
~~~~~~~

.. autoapisummary::

   optimeed.core.options.Base_Option
   optimeed.core.options.Option_bool
   optimeed.core.options.Option_str
   optimeed.core.options.Option_int
   optimeed.core.options.Option_float
   optimeed.core.options.Option_dict
   optimeed.core.options.Option_class




.. py:class:: Base_Option(name, based_value, choices=None)


   .. py:method:: get_value()


   .. py:method:: get_name()


   .. py:method:: set_value(value)


   .. py:method:: get_choices()



.. py:class:: Option_bool(name, based_value, choices=None)


   Bases: :py:obj:`Base_Option`

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: value
      :type: bool

      

   .. py:method:: set_value(value)


   .. py:method:: get_choices()



.. py:class:: Option_str(name, based_value, choices=None)


   Bases: :py:obj:`Base_Option`

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: value
      :type: str

      

   .. py:method:: set_value(value)



.. py:class:: Option_int(name, based_value, choices=None)


   Bases: :py:obj:`Base_Option`

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: value
      :type: int

      

   .. py:method:: set_value(value)



.. py:class:: Option_float(name, based_value, choices=None)


   Bases: :py:obj:`Base_Option`

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: value
      :type: float

      

   .. py:method:: set_value(value)



.. py:class:: Option_dict(name, based_value, choices=None)


   Bases: :py:obj:`Base_Option`

   .. py:attribute:: name
      :type: str

      

   .. py:attribute:: value
      :type: dict

      

   .. py:method:: set_value(value)



.. py:class:: Option_class


   .. py:attribute:: options_bool
      :type: Dict[int, Option_bool]

      

   .. py:attribute:: options_str
      :type: Dict[int, Option_str]

      

   .. py:attribute:: options_int
      :type: Dict[int, Option_int]

      

   .. py:attribute:: options_float
      :type: Dict[int, Option_float]

      

   .. py:attribute:: options_dict
      :type: Dict[int, Option_dict]

      

   .. py:method:: get_option_attributes()
      :staticmethod:


   .. py:method:: add_option(idOption, theOption)


   .. py:method:: get_option_name(idOption)


   .. py:method:: get_option_value(idOption)


   .. py:method:: set_option(idOption, value)


   .. py:method:: _pack_options()


   .. py:method:: __str__()

      Return str(self).