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

.. oe:namespace:: OESpruce



.. _OESpruce_OEDesignUnitSplitOptions:

.. oe:class:: OEDesignUnitSplitOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEDesignUnitSplitOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for splitting a structure into design unit components for use in the :oe:cls:`OESpruce::OEMakeDesignUnitOptions` class.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEDesignUnitSplitOptions()
            OEDesignUnitSplitOptions(const OEDesignUnitSplitOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitSplitOptions() -> OEDesignUnitSplitOptions
            OEDesignUnitSplitOptions(arg2: OEDesignUnitSplitOptions) -> OEDesignUnitSplitOptions

      Default and copy constructor that constructs a `OEDesignUnitSplitOptions` object.

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

      .. oe:api::

         OEDesignUnitSplitOptions &operator=(const OEDesignUnitSplitOptions &)

      Assignment operator.


   .. _OESpruce_OEDesignUnitSplitOptions_AddCofactorCode:


   .. oe:method:: AddCofactorCode

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

         .. oe:api::

            void AddCofactorCode(const std::string argValue)

      .. oe:language:: python

         .. oe:api:: python

            AddCofactorCode(addCode: str) -> None

      Explicitly sets the name of the molecule(s) to be considered a cofactor.


   .. _OESpruce_OEDesignUnitSplitOptions_AddExcipientCode:

   .. oe:method:: AddExcipientCode

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

         .. oe:api::

            void AddExcipientCode(const std::string argValue)

      .. oe:language:: python

         .. oe:api:: python

            AddExcipientCode(addCode: str) -> None

      Explicitly sets the name of the molecule(s) to be considered an excipient.

   .. _OESpruce_OEDesignUnitSplitOptions_AddLipidCode:

   .. oe:method:: AddLipidCode

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

         .. oe:api::

            void AddLipidCode(const std::string argValue)

      .. oe:language:: python

         .. oe:api:: python

            AddLipidCode(addCode: str) -> None

      Explicitly sets the name of the molecule(s) to be considered an lipid.

   .. _OESpruce_OEDesignUnitSplitOptions_ClearCofactorCodes:

   .. oe:method:: ClearCofactorCodes

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

         .. oe:api::

            void ClearCofactorCodes()

      .. oe:language:: python

         .. oe:api:: python

            ClearCofactorCodes() -> None

      Removes the name(s) of the molecules considered to be cofactors.

   .. _OESpruce_OEDesignUnitSplitOptions_ClearExcipientCodes:


   .. oe:method:: ClearExcipientCodes

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

         .. oe:api::

            void ClearExcipientCodes()

      .. oe:language:: python

         .. oe:api:: python

            ClearExcipientCodes() -> None

      Removes the name(s) of the molecules considered to be excipients.


   .. _OESpruce_OEDesignUnitSplitOptions_ClearLipidCodes:

   .. oe:method:: ClearLipidCodes

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

         .. oe:api::

            void ClearLipidCodes()

      .. oe:language:: python

         .. oe:api:: python

            ClearLipidCodes() -> None

      Removes the name(s) of the molecules considered to be lipids.

   .. _OESpruce_OEDesignUnitSplitOptions_GetAlternateLocationHandling:


   .. oe:method:: GetAlternateLocationHandling

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

         .. oe:api::

            unsigned GetAlternateLocationHandling() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlternateLocationHandling() -> int

      Returns the value of the alternate location handling mode, which is given by the :oe:constns:`OESpruce::OEAlternateLocationOption` namespace.

   .. _OESpruce_OEDesignUnitSplitOptions_GetCofactorCodes:


   .. oe:method:: GetCofactorCodes

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

         .. oe:api::

            std::vector<std::string> GetCofactorCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetCofactorCodes() -> OEStringVector

      Returns a reference to the vector of the name(s) of the molecule(s) considered to be cofactors.

   .. _OESpruce_OEDesignUnitSplitOptions_GetExcipientCodes:


   .. oe:method:: GetExcipientCodes

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

         .. oe:api::

            std::vector<std::string> GetExcipientCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetExcipientCodes() -> OEStringVector

      Returns a reference to the stored vector of strings representing names of molecules that should be considered excipients.

   .. _OESpruce_OEDesignUnitSplitOptions_GetLipidCodes:


   .. oe:method:: GetLipidCodes

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

         .. oe:api::

            std::vector<std::string> GetLipidCodes() const

      .. oe:language:: python

         .. oe:api:: python

            GetLipidCodes() -> OEStringVector

      Returns a reference to the stored vector of strings representing names of molecules that should be considered lipids.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMakePackingResidues:


   .. oe:method:: GetMakePackingResidues

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

         .. oe:api::

            bool GetMakePackingResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMakePackingResidues() -> bool

      Returns the boolean whether or not to make packing residues.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMaxLigAtoms:


   .. oe:method:: GetMaxLigAtoms

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

         .. oe:api::

            unsigned GetMaxLigAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLigAtoms() -> int

      Returns the maximum number of atoms for a molecule to still be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMaxLigResidues:


   .. oe:method:: GetMaxLigResidues

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

         .. oe:api::

            unsigned GetMaxLigResidues() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxLigResidues() -> int

      Returns the maximum number of residues for a molecule to still be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMaxSystemAtoms:


   .. oe:method:: GetMaxSystemAtoms

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

         .. oe:api::

            unsigned GetMaxSystemAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMaxSystemAtoms() -> int

      Returns the maximum number of atoms for a system to be split.

   .. _OESpruce_OEDesignUnitSplitOptions_GetMinLigAtoms:


   .. oe:method:: GetMinLigAtoms

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

         .. oe:api::

            unsigned GetMinLigAtoms() const

      .. oe:language:: python

         .. oe:api:: python

            GetMinLigAtoms() -> int

      Returns the minimum number of atoms for a molecule to still be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_GetTargetComponentID:


   .. oe:method:: GetTargetComponentID

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

         .. oe:api::

            unsigned GetTargetComponentID() const

      .. oe:language:: python

         .. oe:api:: python

            GetTargetComponentID() -> int

      Returns the constant of the target component, which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. _OESpruce_OEDesignUnitSplitOptions_SetAlternateLocationHandling:


   .. oe:method:: SetAlternateLocationHandling

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

         .. oe:api::

            bool SetAlternateLocationHandling(unsigned altLocHandling)

      .. oe:language:: python

         .. oe:api:: python

            SetAlternateLocationHandling(value: int) -> bool

      Sets the constant that controls how alternate location enumeration will be handled, which is taken from the :oe:constns:`OESpruce::OEAlternateLocationOption` namespace.

   .. _OESpruce_OEDesignUnitSplitOptions_SetCofactorCodes:


   .. oe:method:: SetCofactorCodes

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

         .. oe:api::

            bool SetCofactorCodes(const std::vector<std::string>& argValue)

      .. oe:language:: python

         .. oe:api:: python

            SetCofactorCodes(value: OEStringVector) -> bool

      Sets the vector of strings representing names of molecules that should be considered cofactors.

   .. _OESpruce_OEDesignUnitSplitOptions_SetExcipientCodes:


   .. oe:method:: SetExcipientCodes

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

         .. oe:api::

            bool SetExcipientCodes(const std::vector<std::string>& argValue)

      .. oe:language:: python

         .. oe:api:: python

            SetExcipientCodes(value: OEStringVector) -> bool

      Sets the vector of strings representing names of molecules that should be considered excipients.

   .. _OESpruce_OEDesignUnitSplitOptions_SetLipidCodes:


   .. oe:method:: SetLipidCodes

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

         .. oe:api::

            bool SetLipidCodes(const std::vector<std::string>& argValue)

      .. oe:language:: python

         .. oe:api:: python

            SetLipidCodes(value: OEStringVector) -> bool

      Sets the vector of strings representing names of molecules that should be considered lipids.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMakePackingResidues:


   .. oe:method:: SetMakePackingResidues

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

         .. oe:api::

            bool SetMakePackingResidues(bool makePackingResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetMakePackingResidues(value: bool) -> bool

      Sets the boolean of whether or not to make a packing residue component.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMaxLigAtoms:


   .. oe:method:: SetMaxLigAtoms

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

         .. oe:api::

            void SetMaxLigAtoms(unsigned maxLigAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLigAtoms(value: int) -> bool

      Sets the maximum number of atoms for a molecule to be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMaxLigResidues:


   .. oe:method:: SetMaxLigResidues

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

         .. oe:api::

            void SetMaxLigResidues(unsigned maxLigResidues)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxLigResidues(value: int) -> bool

      Sets the maximum number of residues for a molecule to be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMaxSystemAtoms:


   .. oe:method:: SetMaxSystemAtoms

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

         .. oe:api::

            bool SetMaxSystemAtoms(unsigned maxSystemAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMaxSystemAtoms(value: int) -> bool

      Sets the maximum number of atoms for a system to be split.

   .. _OESpruce_OEDesignUnitSplitOptions_SetMinLigAtoms:


   .. oe:method:: SetMinLigAtoms

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

         .. oe:api::

            void SetMinLigAtoms(unsigned minLigAtoms)

      .. oe:language:: python

         .. oe:api:: python

            SetMinLigAtoms(value: int) -> bool

      Sets the minimum number of atoms for a molecule to be considered a ligand.

   .. _OESpruce_OEDesignUnitSplitOptions_SetTargetComponentID:


   .. oe:method:: SetTargetComponentID

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

         .. oe:api::

            bool SetTargetComponentID(unsigned targetCompID)

      .. oe:language:: python

         .. oe:api:: python

            SetTargetComponentID(value: int) -> bool

      Sets the constant of the target component, which is taken from the :oe:constns:`OEBio::OEDesignUnitComponents` namespace.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
