.. include:: ../../toolkit-substitutions

.. oe:namespace:: OEModels

.. meta::
   :keywords: OEROCSQueryModelOptions, ROCSQueryModelOptions


.. _OEModels_OEROCSQueryModelOptions:

.. oe:class:: OEROCSQueryModelOptions

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEROCSQueryModelOptions : public OESystem::OEOptions
      
   This class provides an interface to setup options required for building
   a **ROCS** query model using *OEROCSQueryModelBuilder*.

   The :ref:`OEROCSQueryModelOptions <OEModels_OEROCSQueryModelOptions>` class defines the following public methods:
    * :oe:meth:`GetColorForceField<OEModels::OEROCSQueryModelOptions::GetColorForceField>` and
      :oe:meth:`SetColorForceField<OEModels::OEROCSQueryModelOptions::SetColorForceField>`
    * :oe:meth:`GetMergeColorAtoms<OEModels::OEROCSQueryModelOptions::GetMergeColorAtoms>` and
      :oe:meth:`SetMergeColorAtoms<OEModels::OEROCSQueryModelOptions::SetMergeColorAtoms>`
    * :oe:meth:`GetMaxMoleculesPerModel<OEModels::OEROCSQueryModelOptions::GetMaxMoleculesPerModel>` and
      :oe:meth:`SetMaxMoleculesPerModel<OEModels::OEROCSQueryModelOptions::SetMaxMoleculesPerModel>`
    * :oe:meth:`GetNumModels<OEModels::OEROCSQueryModelOptions::GetNumModels>` and
      :oe:meth:`SetNumModels<OEModels::OEROCSQueryModelOptions::SetNumModels>`
    * :oe:meth:`CreateCopy<OEModels::OEROCSQueryModelOptions::CreateCopy>`

   .. oe:method:: Constructor

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

         .. oe:api::

            OEROCSQueryModelOptions()
            OEROCSQueryModelOptions(const OEROCSQueryModelOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEROCSQueryModelOptions() -> OEROCSQueryModelOptions
            OEROCSQueryModelOptions(arg2: OEROCSQueryModelOptions) -> OEROCSQueryModelOptions

      Default and copy constructors.

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

      .. oe:api::

         OEROCSQueryModelOptions &operator=(const OEROCSQueryModelOptions &)

      Assignment operator.


   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEROCSQueryModelOptions* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEROCSQueryModelOptions

      Creates and returns a deep copy of this object.

   .. oe:method:: GetColorForceField

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

         .. oe:api::

            const OEColorForceField* GetColorForceField() const

      .. oe:language:: python

         .. oe:api:: python

            GetColorForceField() -> OEColorForceField

      See :oe:meth:`SetColorForceField<OEModels::OEROCSQueryModelOptions::SetColorForceField>` method.

   .. oe:method:: GetMergeColorAtoms

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

         .. oe:api::

            bool GetMergeColorAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMergeColorAtoms() -> bool

      See :oe:meth:`SetMergeColorAtoms<OEModels::OEROCSQueryModelOptions::SetMergeColorAtoms>` method.

   .. oe:method:: GetMaxMoleculesPerModel

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

         .. oe:api::

            unsigned GetMaxMoleculesPerModel() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxMoleculesPerModel() -> int

      See :oe:meth:`SetMaxMoleculesPerModel<OEModels::OEROCSQueryModelOptions::SetMaxMoleculesPerModel>` method.

   .. oe:method:: GetNumModels

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

         .. oe:api::

            unsigned GetNumModels() const

      .. oe:language:: python

         .. oe:api:: python

            GetNumModels() -> int

      See :oe:meth:`SetNumModels<OEModels::OEROCSQueryModelOptions::SetNumModels>` method.

   .. oe:method:: SetColorForceField

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

         .. oe:api::

            bool SetColorForceField(unsigned int type)
            bool SetColorForceField(OEPlatform::oeistream& is)
            bool SetColorForceField(const std::string& filename)
            bool SetColorForceField(const OEColorForceField& cff)

      .. oe:language:: python

         .. oe:api:: python

            SetColorForceField(value: int) -> bool
            SetColorForceField(value: oeistream) -> bool
            SetColorForceField(value: str) -> bool
            SetColorForceField(value: OEColorForceField) -> bool

      Sets the color force field to be used. By default the ImplicitMillsDean
      color force field is used.

   .. oe:method:: SetMergeColorAtoms

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

         .. oe:api::

            bool SetMergeColorAtoms(const bool)

      .. oe:language:: python

         .. oe:api:: python

            SetMergeColorAtoms(value: bool) -> bool

      Sets **flag** if color atoms should be merged if applicable.
      **Default: True**

   .. oe:method:: SetMaxMoleculesPerModel

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

         .. oe:api::

            bool SetMaxMoleculesPerModel(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxMoleculesPerModel(value: int) -> bool

      Sets the **maximum number of molecules** to be combined in creating a single query.
      **Default: 3**

   .. oe:method:: SetNumModels

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

         .. oe:api::

            bool SetNumModels(const unsigned)

      .. oe:language:: python

         .. oe:api:: python

            SetNumModels(value: int) -> bool

      Sets the **maximum number query model** to be returned from modeling building.
      **Default: 1**
