.. oe:namespace:: OEBio



.. meta::
   :keywords: OEMolComplexFilter, MolComplexFilter


.. _OEBio_OEMolComplexFilter:

.. oe:class:: OEMolComplexFilter

   .. oe:api::


      class OEMolComplexFilter : public OESystem::OEUnaryPredicate<OESystem::OERoleSet>

   The class `OEMolComplexFilter` represents a predicate over
   :ref:`OERoleSet <OESystem_OERoleSet>` objects used
   by :oe:func:`OEBio::OESplitMolComplex` and
   :oe:func:`OEBio::OEGetMolComplexComponents`
   to filter components by their functional roles.

   The following factories are used to generate `OEMolComplexFilter` objects:

   ============================================ ================================================
   :oe:func:`OEBio::OEMolComplexFilterFactory`  :oe:func:`OEBio::OERoleMolComplexFilterFactory`
   ============================================ ================================================

   `OEMolComplexFilter`  objects can be combined
   into arbitrarily complex expressions using
   composition functors (see the :ref:`section_predicates_composition_functors` section).

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMolComplexFilter()
            OEMolComplexFilter(const OEMolComplexFilter& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEMolComplexFilter() -> OEMolComplexFilter
            OEMolComplexFilter(rhs: OEMolComplexFilter) -> OEMolComplexFilter
            OEMolComplexFilter(impl: OEMolComplexFilterImpl) -> OEMolComplexFilter

      Constructor and copy constructor.

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

      .. oe:api::

         OEMolComplexFilter &operator=(const OEMolComplexFilter &rhs)

      Assignment operator.

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OESystem::OERoleSet& roles) const

      .. oe:language:: python

         .. oe:api:: python

            __call__(roles: OERoleSet) -> bool

      Returns ``true`` if the :ref:`OERoleSet <OESystem_OERoleSet>` matches the filter.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OESystem::OEUnaryFunction<OESystem::OERoleSet, bool>* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolComplexFilter

      CreateCopy method.
