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

.. oe:namespace:: OESpruce



.. _OESpruce_OESpruceFilterOptions:

.. oe:class:: OESpruceFilterOptions

   .. attention::

      |TWOLANGUAGE|

   The :ref:`OESpruceFilterOptions <OESpruce_OESpruceFilterOptions>` class holds options classes that are used for structural checks. Default constructing this options class, constructs all the necessary
   options classes, which can then be accessed and modified.
   This class stores the optional parameter sets for use in the :oe:func:`OESpruce::OEMakeDesignUnits` and
   :oe:func:`OESpruce::OEMakeDesignUnit` functions.


   .. oe:method:: Constructors

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

         .. oe:api::

            OESpruceFilterOptions()
            OESpruceFilterOptions(const OESpruceFilterOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OESpruceFilterOptions() -> OESpruceFilterOptions
            OESpruceFilterOptions(arg2: OESpruceFilterOptions) -> OESpruceFilterOptions

      Default, copy, and advanced constructor that constructs a `OESpruceFilterOptions` object. 

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

      .. oe:api::

         OESpruceFilterOptions &operator=(const OESpruceFilterOptions &)

      Assignment operator.


   .. oe:method:: GetDeleteFloatingRes

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

         .. oe:api::

            bool GetDeleteFloatingRes() const

      .. oe:language:: python

         .. oe:api:: python

            GetDeleteFloatingRes() -> bool

      Returns the boolean whether or not to delete floating residues

   .. oe:method:: GetFixBackboneAtoms

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

         .. oe:api::

            bool GetFixBackboneAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixBackboneAtoms() -> bool

      Returns the boolean whether or not to fix incorrect backbone atoms. If FixBackboneAtoms is set to true, spruce filter will delete incorrect partial backbone atoms.

   .. oe:method:: GetFixBondsToMetals

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

         .. oe:api::

            bool GetFixBondsToMetals() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixBondsToMetals() -> bool

      Returns the boolean whether or not to fix covalent bonds to metals. If FixBondsToMetals option is set to true, spruce filter function will set bond order of the incorrect covalent bonds to metals to 0.

   .. oe:method:: GetFixChainIDs

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

         .. oe:api::

            bool GetFixChainIDs() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixChainIDs() -> bool

      Returns the boolean whether or not to fix chain IDs. If FixChainIDs is set to true, spruce filter will assign incorrect chain IDs based on structural context.

   .. oe:method:: GetFixInvalidCovalentBonds

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

         .. oe:api::

            bool GetFixInvalidCovalentBonds() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixInvalidCovalentBonds() -> bool

      Returns the boolean of whether or not to fix covalent bond structure. If FixInvalidCovalentBonds option is set to true, bonds deemed invalid will be deleted or flagged, depending on whether structural modifications are allowed.

   .. oe:method:: GetFixNames

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

         .. oe:api::

            bool GetFixNames() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixNames() -> bool

      Returns the boolean whether or not to fix incorrect names for all components. If FixNames is set to true, spruce filter function will rename ligands named "UNL" to "LIG" and residues named "NMA" will change to "NME" with CA atoms renamed to "CH3".
      Spruce filter will fail if residue has name "UNK".

   .. oe:method:: GetFixResStates

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

         .. oe:api::

            bool GetFixResStates() const

      .. oe:language:: python

         .. oe:api:: python

            GetFixResStates() -> bool

      Returns the boolean of whether or not to fix protein residue states


.. _OESpruce_OESpruceFilterOptions_SetDeleteFloatingRes:

   .. oe:method:: SetDeleteFloatingRes

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

         .. oe:api::

            bool SetDeleteFloatingRes(bool DeleteFloatingRes)

      .. oe:language:: python

         .. oe:api:: python

            SetDeleteFloatingRes(value: bool) -> bool

      Sets the boolean of whether or not to delete floating residues

.. _OESpruce_OESpruceFilterOptions_SetFixBackboneAtoms:

   .. oe:method:: SetFixBackboneAtoms

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

         .. oe:api::

            bool SetFixBackboneAtoms(bool FixBackboneAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetFixBackboneAtoms(value: bool) -> bool

      Sets the boolean of whether or not to fix incorrect backbone atoms

.. _OESpruce_OESpruceFilterOptions_SetFixBondsToMetals:

   .. oe:method:: SetFixBondsToMetals

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

         .. oe:api::

            bool SetFixBondsToMetals(bool FixBondOrder)

      .. oe:language:: python

         .. oe:api:: python

            SetFixBondsToMetals(value: bool) -> bool

      Sets the boolean of whether or not to fix covalent bonds to metals

.. _OESpruce_OESpruceFilterOptions_SetFixChainIDs:

   .. oe:method:: SetFixChainIDs

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

         .. oe:api::

            bool SetFixChainIDs(bool FixChainIDs)

      .. oe:language:: python

         .. oe:api:: python

            SetFixChainIDs(value: bool) -> bool

      Sets the boolean of whether or not to fix fix chainIDs

.. _OESpruce_OESpruceFilterOptions_SetFixInvalidCovalentBonds:

   .. oe:method:: SetFixInvalidCovalentBonds

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

         .. oe:api::

            bool SetFixInvalidCovalentBonds(bool FixInvalidCovalentBonds)

      .. oe:language:: python

         .. oe:api:: python

            SetFixInvalidCovalentBonds(value: bool) -> bool

      Returns the boolean of whether or not to fix covalent bond structure

.. _OESpruce_OESpruceFilterOptions_SetFixNames:

   .. oe:method:: SetFixNames

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

         .. oe:api::

            bool SetFixNames(bool FixNames)

      .. oe:language:: python

         .. oe:api:: python

            SetFixNames(value: bool) -> bool

      Sets the boolean of whether or not to fix incorrect names for all components.

.. _OESpruce_OESpruceFilterOptions_SetFixResStates:

   .. oe:method:: SetFixResStates

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

         .. oe:api::

            bool GetFixResStates() const

      .. oe:language:: python

         .. oe:api:: python

            SetFixResStates(value: bool) -> bool

      Sets the boolean of whether or not to fix protein residue states

