.. oe:namespace:: OEBio


.. _OEBio_OECrystalSymmetryParams:

.. oe:class:: OECrystalSymmetryParams

   .. oe:api::

      class OECrystalSymmetryParams

   This class represents the :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` class
   that stores crystal symmetry parameters:

   * standard cell lengths
   * cell angles 'alpha', 'beta' and 'gamma' and
   * spacegroup number
   * z-value

   .. seealso::

      * :oe:func:`OEBio::OEGetCrystalSymmetry` function
      * :oe:func:`OEBio::OESetCrystalSymmetry` function


   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

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

         .. oe:api::

            OECrystalSymmetryParams()

      .. oe:language:: python

         .. oe:api:: python

            OECrystalSymmetryParams() -> OECrystalSymmetryParams

      Default constructor.

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

         .. oe:api::

            OECrystalSymmetryParams(float a, float b, float c, float alpha,
                                    float beta, float gamma,
                                    unsigned int sgnumber,
                                    unsigned int zvalue = 0u)

      .. oe:language:: python

         .. oe:api:: python

            OECrystalSymmetryParams(a: float, b: float, c: float, alpha: float,
                                    beta: float, gamma: float, sgnumber: int,
                                    zvalue: int = 0) -> OECrystalSymmetryParams

      Constructors an :ref:`OECrystalSymmetryParams <OEBio_OECrystalSymmetryParams>` object with the given values.

   .. oe:method:: GetA

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

         .. oe:api::

            float GetA() const

      .. oe:language:: python

         .. oe:api:: python

            GetA() -> float

   .. oe:method:: GetAlpha

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

         .. oe:api::

            float GetAlpha() const

      .. oe:language:: python

         .. oe:api:: python

            GetAlpha() -> float

   .. oe:method:: GetB

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

         .. oe:api::

            float GetB() const

      .. oe:language:: python

         .. oe:api:: python

            GetB() -> float

   .. oe:method:: GetBeta

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

         .. oe:api::

            float GetBeta() const

      .. oe:language:: python

         .. oe:api:: python

            GetBeta() -> float

   .. oe:method:: GetC

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

         .. oe:api::

            float GetC() const

      .. oe:language:: python

         .. oe:api:: python

            GetC() -> float

   .. oe:method:: GetGamma

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

         .. oe:api::

            float GetGamma() const

      .. oe:language:: python

         .. oe:api:: python

            GetGamma() -> float

   .. oe:method:: GetSpaceGroup

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

         .. oe:api::

            unsigned int GetSpaceGroup() const

      .. oe:language:: python

         .. oe:api:: python

            GetSpaceGroup() -> int

   .. oe:method:: GetZValue

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

         .. oe:api::

            unsigned int GetZValue() const

      .. oe:language:: python

         .. oe:api:: python

            GetZValue() -> int

   .. oe:method:: SetA

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

         .. oe:api::

            void SetA(float a)

      .. oe:language:: python

         .. oe:api:: python

            SetA(a: float) -> None

   .. oe:method:: SetAlpha

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

         .. oe:api::

            void SetAlpha(float alpha)

      .. oe:language:: python

         .. oe:api:: python

            SetAlpha(alpha: float) -> None

   .. oe:method:: SetB

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

         .. oe:api::

            void SetB(float b)

      .. oe:language:: python

         .. oe:api:: python

            SetB(b: float) -> None

   .. oe:method:: SetBeta

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

         .. oe:api::

            void SetBeta(float beta)

      .. oe:language:: python

         .. oe:api:: python

            SetBeta(beta: float) -> None

   .. oe:method:: SetC

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

         .. oe:api::

            void SetC(float c)

      .. oe:language:: python

         .. oe:api:: python

            SetC(c: float) -> None

   .. oe:method:: SetGamma

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

         .. oe:api::

            void SetGamma(float gamma)

      .. oe:language:: python

         .. oe:api:: python

            SetGamma(gamma: float) -> None

   .. oe:method:: SetSpaceGroup

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

         .. oe:api::

            void SetSpaceGroup(unsigned int sgnumber)

      .. oe:language:: python

         .. oe:api:: python

            SetSpaceGroup(sgnumber: int) -> None

   .. oe:method:: SetZValue

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

         .. oe:api::

            void SetZValue(unsigned int zvalue)

      .. oe:language:: python

         .. oe:api:: python

            SetZValue(zvalue: int) -> None
