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

.. oe:namespace:: OEBio


.. _OEBio_OEStructureQuality:

.. oe:class:: OEStructureQuality

   .. attention::

      |TWOLANGUAGE|
   
   .. oe:api::

      class OEStructureQuality

   This is a container class that holds all data relating to the
   structural quality of biomolecular system.

   .. seealso::

      * :ref:`OEIridiumData <OEBio_OEIridiumData>` class

   .. oe:method:: Constructors

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

         .. oe:api::

            OEStructureQuality()
            OEStructureQuality(const OEIridiumData& id)
            OEStructureQuality(const OEStructureQuality& rhs)

      .. oe:language:: python

         .. oe:api:: python

            OEStructureQuality() -> OEStructureQuality
            OEStructureQuality(id: OEIridiumData) -> OEStructureQuality
            OEStructureQuality(rhs: OEStructureQuality) -> OEStructureQuality

      Default and copy constructors.

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

      .. oe:api::

         OEStructureQuality &operator=(const OEStructureQuality &rhs)

      Assignment operator.

   .. oe:method:: operator bool

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

         .. oe:api::

            operator bool() const

      .. oe:language:: python

         .. oe:api:: python

            IsValid() -> bool

      Returns whether the :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object is valid.

   .. oe:method:: Clear

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

         .. oe:api::

            void Clear()

      .. oe:language:: python

         .. oe:api:: python

            Clear() -> None

      Resets the OEStructureQuality object to its initial state.

   .. oe:method:: GetIridiumData

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

         .. oe:api::

            OEIridiumData GetIridiumData()
            const OEIridiumData GetIridiumData() const

      .. oe:language:: python

         .. oe:api:: python

            GetIridiumData() -> OEIridiumData

      Returns a copy of the :ref:`OEIridiumData <OEBio_OEIridiumData>` object
      stored within the :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object.

   .. oe:method:: HasIridiumData

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

         .. oe:api::

            bool HasIridiumData() const

      .. oe:language:: python

         .. oe:api:: python

            HasIridiumData() -> bool

      Checks that the :ref:`OEIridiumData <OEBio_OEIridiumData>` object has been set.

   .. oe:method:: SetIridiumData

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

         .. oe:api::

            bool SetIridiumData(const OEIridiumData& id)

      .. oe:language:: python

         .. oe:api:: python

            SetIridiumData(id: OEIridiumData) -> bool

      Sets the :ref:`OEIridiumData <OEBio_OEIridiumData>` object on the
      :ref:`OEStructureQuality <OEBio_OEStructureQuality>` object. Returns ``true`` if
      successful, and ``false`` otherwise.
