.. oe:namespace:: OEChem



.. meta::
   :keywords: OECIFOptions, CIFOptions


.. _OEChem_OECIFOptions:

.. oe:class:: OECIFOptions

   .. oe:api::


      class OECIFOptions

An option handling class for the :oe:func:`OEChem::OEUpdateMMCIFData` function
   and :oe:meth:`OEChem::OECIFData::Update` method in the :oe:cls:`OEChem::OECIFData` class.
   The :ref:`section_moldata_CIF` section explains in more detail the perception process and what CIF attributes
   are affected when an OECIFOption is set to ``true`` for a given perception method.

   .. seealso::

      * :oe:cls:`OEChem::OECIFData` class
      * :ref:`section_moldata_CIF` section

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OECIFOptions()
            OECIFOptions(const OECIFOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OECIFOptions() -> OECIFOptions
            OECIFOptions(arg2: OECIFOptions) -> OECIFOptions

      Default and copy a constructor that constructs an OECIFOptions object.

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OECIFOptions & operator=(const OECIFOptions &)

      Assignment operator.


   .. oe:method:: GetPerceiveEntity

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveEntity() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveEntity() -> bool

      A value of ``true`` will perceive all entity-related CIF attributes.

   .. oe:method:: GetPerceiveChemComp

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveChemComp() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveChemComp() -> bool

      A value of ``true`` will perceive all chemical component-related CIF attributes.

   .. oe:method:: GetPerceiveCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveCell() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveCell() -> bool

      A value of ``true`` will perceive CIF attributes related to the structure cell.

   .. oe:method:: GetPerceiveSymmetry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveSymmetry() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveSymmetry() -> bool

      A value of ``true`` will perceive CIF attributes related to structural symmetry.

   .. oe:method:: GetPerceiveStruct

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveStruct() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveStruct() -> bool

      A value of ``true`` will perceive all struct or structure-related CIF attributes.

   .. oe:method:: GetPerceiveExperimental

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveExperimental() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveExperimental() -> bool

      A value of ``true`` will coordinate the experimental CIF attributes with the perceived header values.


   .. oe:method:: GetPerceiveOther

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool GetPerceiveOther() const

      .. oe:language:: python

         .. oe:api:: python

            GetPerceiveOther() -> bool

      All remaining CIF categories not covered in the other perception options are coordinated with the perceived header values.

   .. oe:method:: SetPerceiveEntity

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveEntity(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveEntity(value: bool) -> bool

      Sets whether to perceive entity-related CIF attributes during header updates when molecule data informs
      header values. Default is ``false``.

   .. oe:method:: SetPerceiveChemComp

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveChemComp(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveChemComp(value: bool) -> bool

      Sets whether to perceive chemical component-related CIF attributes during header updates when molecule data
      informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveCell

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveCell(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveCell(value: bool) -> bool

      Sets whether to perceive CIF attributes related to the structure cell during header updates when molecule data
      informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveSymmetry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveSymmetry(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveSymmetry(value: bool) -> bool

      Sets whether to perceive CIF attributes related to the structural symmetry during header updates when
      molecule data informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveStruct

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveEntity(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveStruct(value: bool) -> bool

      Sets whether to perceive struct or structure related CIF attributes during header updates when molecule data
      informs header values. Default is ``false``.

   .. oe:method:: SetPerceiveExperimental

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveExperimental(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveExperimental(value: bool) -> bool

      Sets whether to coordinate experimental CIF attributes with the perceived header values. Default is ``false``.

   .. oe:method:: SetPerceiveOther

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool SetPerceiveOther(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetPerceiveOther(value: bool) -> bool

      Sets whether to coordinate all remaining CIF categories not covered in the other perception options.
      Default is ``false``.
