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

.. oe:namespace:: OEMolPotential



.. _OEMolPotential_OEOutOfPlaneParams:

.. oe:class:: OEOutOfPlaneParams

   .. attention::

      |TWOLANGUAGE|

   .. oe:api::


      class  OEOutOfPlaneParams : public OEMolPotential::OEInteractParams

   The :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` class defines generic parameters for out-of-plane
   term which might be used in any force field.

   The following methods are publicly inherited from :ref:`OEInteractParams <OEMolPotential_OEInteractParams>`:
    * :oe:meth:`Clear<OEMolPotential::OEInteractParams::Clear>`
    * :oe:meth:`Get<OEMolPotential::OEInteractParams::Get>`
    * :oe:meth:`Set<OEMolPotential::OEInteractParams::Set>`

   The :ref:`OETorsionParams <OEMolPotential_OETorsionParams>` class defines the following public methods:
    * :oe:meth:`GetAtomIndex1<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex1>`
    * :oe:meth:`GetAtomIndex2<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex2>`
    * :oe:meth:`GetAtomIndex3<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex3>`
    * :oe:meth:`GetAtomIndex4<OEMolPotential::OEOutOfPlaneParams::GetAtomIndex4>`
    * :oe:meth:`IsValid<OEMolPotential::OEOutOfPlaneParams::IsValid>`


   .. oe:method:: Constructors

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

         .. oe:api::

            OEOutOfPlaneParams(const OEChem::OEAtomBase* atom1,
                               const OEChem::OEAtomBase* atom2,
                               const OEChem::OEAtomBase* atom3,
                               const OEChem::OEAtomBase* atom4,
                               const unsigned type = OEFormatType::AMBER)
            OEOutOfPlaneParams(const OEOutOfPlaneParams&)

      .. oe:language:: python

         .. oe:api:: python

            OEOutOfPlaneParams(atom1: OEAtomBase, atom2: OEAtomBase,
                               atom3: OEAtomBase, atom4: OEAtomBase, type: int) -> OEOutOfPlaneParams
            OEOutOfPlaneParams(arg2: OEOutOfPlaneParams) -> OEOutOfPlaneParams

      Constructor and copy constructor.
      Constructs an :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` object for for atoms
      defining improper torsion passed as arguments. Second atom (second argument) is
      an atom which might occure above or beyond the plane make by 3 remaining atoms.

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

      .. oe:api::

         OEOutOfPlaneParams& operator=(const OEOutOfPlaneParams&)

      The assignment operator.

      Assignment operator.


   .. oe:method:: GetAtomIndex1

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

         .. oe:api::

            unsigned GetAtomIndex1() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex1() -> int

      Returns atom index of the first atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: GetAtomIndex2

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

         .. oe:api::

            unsigned GetAtomIndex2() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex2() -> int

      Returns atom index of the second atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: GetAtomIndex3

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

         .. oe:api::

            unsigned GetAtomIndex3() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex3() -> int

      Returns atom index of the third atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.


   .. oe:method:: GetAtomIndex4

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

         .. oe:api::

            unsigned GetAtomIndex4() const

      .. oe:language:: python

         .. oe:api:: python

            GetAtomIndex4() -> int

      Returns atom index of the forth atom for an improper torsion for which the instance of
      :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>` was created.

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OESystem::OEUnaryPredicate<OEChem::OEAtomBase>& pred) const

      .. oe:language:: python

         .. oe:api:: python

            IsValid(pred: OEUnaryAtomPred) -> bool

      Method which checks if an instance of the :ref:`OEOutOfPlaneParams <OEMolPotential_OEOutOfPlaneParams>`
      class was created for the improper torsion to be included in force field calculation.
      Method provides a predicate which should be used to test all 4 atoms used to make this 
      instance.
      

       

 
