.. oe:namespace:: OESystem


.. meta::
   :keywords: OEUnaryFunction, UnaryFunction


.. _OESystem_OEUnaryFunction:

.. oe:class:: OEUnaryFunction

   .. oe:api::


      template<class Arg, class Result, bool ConstArg, bool ConstFcn>
      class OEUnaryFunction

   This class represents `OEUnaryFunction`.

   This is the default functor base-class in *OEChem*.

   The following specializations exist for this template:

    * OESystem::OEUnaryFunction< Arg, Result, false, false >
    * OESystem::OEUnaryFunction< Arg, Result, false, true >
    * OESystem::OEUnaryFunction< Arg, Result, true, false >


   The following classes derive from this class:
    * :ref:`OEHasAlternateLocation <OEBio_OEHasAlternateLocation>`
    * :ref:`OEHasPDBAtomIndex <OEBio_OEHasPDBAtomIndex>`
    * :ref:`OEIsAlphaCarbon <OEBio_OEIsAlphaCarbon>`
    * :ref:`OEIsBackboneAtom <OEBio_OEIsBackboneAtom>`
    * :ref:`OEHasIdx <OEChem_OEHasIdx>`
    * :ref:`OEIdxSelected <OEChem_OEIdxSelected>`
    * :ref:`OEIsMember <OEChem_OEIsMember>`
    * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`
    * :ref:`OEMatch <OEChem_OEMatch>`
    * :ref:`OEAtomIsInAgent <OEChem_OEAtomIsInAgent>`
    * :ref:`OEAtomIsInProduct <OEChem_OEAtomIsInProduct>`
    * :ref:`OEAtomIsInReactant <OEChem_OEAtomIsInReactant>`
    * :ref:`OEAtomIsInResidue <OEChem_OEAtomIsInResidue>`
    * :ref:`OEAtomIsInRing <OEChem_OEAtomIsInRing>`
    * :ref:`OEBondIsInRing <OEChem_OEBondIsInRing>`
    * :ref:`OEGetNbrAtom <OEChem_OEGetNbrAtom>`
    * :ref:`OEHasAtomName <OEChem_OEHasAtomName>`
    * :ref:`OEHasAtomStereoSpecified <OEChem_OEHasAtomStereoSpecified>`
    * :ref:`OEHasAtomicNum <OEChem_OEHasAtomicNum>`
    * :ref:`OEHasBondStereoSpecified <OEChem_OEHasBondStereoSpecified>`
    * :ref:`OEHasChainID <OEChem_OEHasChainID>`
    * :ref:`OEHasFragmentNumber <OEChem_OEHasFragmentNumber>`
    * :ref:`OEHasIdx <OEChem_OEHasIdx>`
    * :ref:`OEHasMapIdx <OEChem_OEHasMapIdx>`
    * :ref:`OEHasOrder <OEChem_OEHasOrder>`
    * :ref:`OEHasResidueNumber <OEChem_OEHasResidueNumber>`
    * :ref:`OEIsAromaticAtom <OEChem_OEIsAromaticAtom>`
    * :ref:`OEIsAromaticBond <OEChem_OEIsAromaticBond>`
    * :ref:`OEIsCAlpha <OEChem_OEIsCAlpha>`
    * :ref:`OEIsCarbon <OEChem_OEIsCarbon>`
    * :ref:`OEIsChiralAtom <OEChem_OEIsChiralAtom>`
    * :ref:`OEIsChiralBond <OEChem_OEIsChiralBond>`
    * :ref:`OEIsHalide <OEChem_OEIsHalide>`
    * :ref:`OEIsHalogen <OEChem_OEIsHalogen>`
    * :ref:`OEIsHeavy <OEChem_OEIsHeavy>`
    * :ref:`OEIsHydrogen <OEChem_OEIsHydrogen>`
    * :ref:`OEIsMember <OEChem_OEIsMember>`
    * :ref:`OEIsMemberPtr <OEChem_OEIsMemberPtr>`
    * :ref:`OEIsNitrogen <OEChem_OEIsNitrogen>`
    * :ref:`OEIsOxygen <OEChem_OEIsOxygen>`
    * :ref:`OEIsPhosphorus <OEChem_OEIsPhosphorus>`
    * :ref:`OEIsPolar <OEChem_OEIsPolar>`
    * :ref:`OEIsPolarHydrogen <OEChem_OEIsPolarHydrogen>`
    * :ref:`OEIsRGroup <OEChem_OEIsRGroup>`
    * :ref:`OEIsRotor <OEChem_OEIsRotor>`
    * :ref:`OEIsSulfur <OEChem_OEIsSulfur>`
    * :ref:`OEIsValidAtomValence <OEChem_OEIsValidAtomValence>`
    * :ref:`OEIsValidMDLAtomValence <OEChem_OEIsValidMDLAtomValence>`
    * :ref:`OEMatchFunc <OEChem_OEMatchFunc>`
    * :ref:`OENthAtom <OEChem_OENthAtom>`
    * :ref:`OEPartPredT <OEChem_OEPartPredT>`
    * :ref:`OEAnd <OESystem_OEAnd>`
    * :ref:`OENot <OESystem_OENot>`
    * :ref:`OEOr <OESystem_OEOr>`
    * :ref:`OEUnaryFalse <OESystem_OEUnaryFalse>`
    * :ref:`OEUnaryPredicate <OESystem_OEUnaryPredicate>`


   .. oe:method:: operator()

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

         .. oe:api::

            Result operator()(const Arg &) const = 0

      .. oe:language:: python

         .. oe:api:: python

            __call__(Arg) -> Result

      It is a virtual const :oe:meth:`OESystem::OEUnaryFunction::operator()` which takes
      a const argument.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            base_type* CreateCopy() const = 0

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEUnaryFunction

      It is a virtual const constructor which allows copying of concrete
      derived objects using a reference to this base class.
