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

.. oe:namespace:: OESpruce



.. _OESpruce_OEDesignUnitEnumerateSitesOptions:

.. oe:class:: OEDesignUnitEnumerateSitesOptions

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class OEDesignUnitEnumerateSitesOptions : public OESystem::OEOptions

   This class stores the optional parameter sets for design unit binding site enumeration for use in the :oe:func:`OESpruce::OEEnumerateSites` function.


   .. oe:method:: Constructors

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

         .. oe:api::

            OEDesignUnitEnumerateSitesOptions()
            OEDesignUnitEnumerateSitesOptions(const OEDesignUnitEnumerateSitesOptions &)

      .. oe:language:: python

         .. oe:api:: python

            OEDesignUnitEnumerateSitesOptions() -> OEDesignUnitEnumerateSitesOptions
            OEDesignUnitEnumerateSitesOptions(arg2: OEDesignUnitEnumerateSitesOptions) -> OEDesignUnitEnumerateSitesOptions

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

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

      .. oe:api::

         OEDesignUnitEnumerateSitesOptions &operator=(const OEDesignUnitEnumerateSitesOptions &)

      Assignment operator.

   .. oe:method:: GetAddInteractionHints

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

         .. oe:api::

            bool GetAddInteractionHints() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddInteractionHints() -> bool

      Returns the boolean whether or not to add interaction hints.

   .. oe:method:: GetAddStyle

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

         .. oe:api::

            bool GetAddStyle() const

      .. oe:language:: python

         .. oe:api:: python

            GetAddStyle() -> bool

      Returns the boolean whether or not to add style.

   .. oe:method:: GetCollapseNonSiteAlts

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

         .. oe:api::

            bool GetCollapseNonSiteAlts() const

      .. oe:language:: python

         .. oe:api:: python

            GetCollapseNonSiteAlts() -> bool

      Returns the boolean whether or not to collapse non site alternate locations.

   .. oe:method:: GetDuplicateRemoval

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

         .. oe:api::

            bool GetDuplicateRemoval() const

      .. oe:language:: python

         .. oe:api:: python

            GetDuplicateRemoval() -> bool

      Returns the boolean whether or not to remove duplicate sites.

   .. oe:method:: GetEnumerateCofactorSites

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

         .. oe:api::

            bool GetEnumerateCofactorSites() const

      .. oe:language:: python

         .. oe:api:: python

            GetEnumerateCofactorSites() -> bool

      Returns the boolean whether or not to enumerate cofactor sites.

   .. oe:method:: GetRestrictToRefSite

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

         .. oe:api::

            bool GetRestrictToRefSite() const

      .. oe:language:: python

         .. oe:api:: python

            GetRestrictToRefSite() -> bool

      Returns the boolean whether or not to restrict enumeration to the site of the reference structure.

   .. oe:method:: GetSiteSize

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

         .. oe:api::

            double GetSiteSize() const

      .. oe:language:: python

         .. oe:api:: python

            GetSiteSize() -> float

      Returns the size of the site.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetAddInteractionHints:

   .. oe:method:: SetAddInteractionHints

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

         .. oe:api::

            bool SetAddInteractionHints(bool addInteractions)

      .. oe:language:: python

         .. oe:api:: python

            SetAddInteractionHints(value: bool) -> bool

      Sets the boolean whether or not to add interactions.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetAddStyle:

   .. oe:method:: SetAddStyle

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

         .. oe:api::

            bool SetAddStyle(bool addStyle)

      .. oe:language:: python

         .. oe:api:: python

            SetAddStyle(value: bool) -> bool

      Sets the boolean whether or not to add style.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetCollapseNonSiteAlts:

   .. oe:method:: SetCollapseNonSiteAlts

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

         .. oe:api::

            bool SetCollapseNonSiteAlts(bool collapseNonSiteAlts)

      .. oe:language:: python

         .. oe:api:: python

            SetCollapseNonSiteAlts(value: bool) -> bool

      Sets the boolean whether or not to collapse non site alternate locations.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetDuplicateRemoval:

   .. oe:method:: SetDuplicateRemoval

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

         .. oe:api::

            bool SetDuplicateRemoval(bool duplicateRemoval)

      .. oe:language:: python

         .. oe:api:: python

            SetDuplicateRemoval(value: bool) -> bool

      Sets the boolean whether or not to remove duplicate sites.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetEnumerateCofactorSites:

   .. oe:method:: SetEnumerateCofactorSites

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

         .. oe:api::

            bool SetEnumerateCofactorSites(bool enumCofactorSites)

      .. oe:language:: python

         .. oe:api:: python

            SetEnumerateCofactorSites(value: bool) -> bool

      Sets the boolean whether or not to enumerate cofactor sites.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetRestrictToRefSite:

   .. oe:method:: SetRestrictToRefSite

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

         .. oe:api::

            bool SetRestrictToRefSite(bool restrictToRefSite)

      .. oe:language:: python

         .. oe:api:: python

            SetRestrictToRefSite(value: bool) -> bool

      Sets the boolean whether or not to restrict enumeration to the reference site.

.. _OESpruce_OEDesignUnitEnumerateSitesOptions_SetSiteSize:

   .. oe:method:: SetSiteSize

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

         .. oe:api::

            bool SetSiteSize(double siteSize)

      .. oe:language:: python

         .. oe:api:: python

            SetSiteSize(value: float) -> bool

      Sets the size of the site.

   .. seealso::

      * :ref:`OEMakeDesignUnitOptions <OESpruce_OEMakeDesignUnitOptions>` class
      * :ref:`OEDesignUnitPrepOptions <OESpruce_OEDesignUnitPrepOptions>` class
      * :ref:`OEDesignUnitEnumerateSitesOptions <OESpruce_OEDesignUnitEnumerateSitesOptions>` class
