:class:`RAParticleAssemblyPart`
===============================


.. py:class:: ansys.rocky.app.ra_particle_assembly.RAParticleAssemblyPart(id: str, model_id: str | None = None)

   Bases: :py:obj:`ansys.rocky.app.api_element_item.ApiElementItem`


   
   Rocky PrePost Scripting wrapper for a single entry in a single Particle Assembly's part list.

   Access this wrapper from a given :class:`RAParticleAssembly` with:

   .. code-block:: python

       assembly_parts = particle_assembly.GetAssemblyParts()
       assembly_part_1 = assembly_parts.New()
       assembly_part_1.SetParticle('Particle 1')
       assembly_part_1.SetPositionX(0.75, 'm')















   ..
       !! processed by numpydoc !!




.. py:currentmodule:: RAParticleAssemblyPart

Overview
--------

.. tab-set::


   .. tab-item:: Constructors

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetWrappedClass`
            - 
          * - :py:attr:`~GetClassName`
            - 


   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~GetAngle`
            - Get the value of "Angle".
          * - :py:attr:`~SetAngle`
            - Set the value of "Angle".
          * - :py:attr:`~GetPositionX`
            - Get the value of "Position X".
          * - :py:attr:`~SetPositionX`
            - Set the value of "Position X".
          * - :py:attr:`~GetPositionY`
            - Get the value of "Position Y".
          * - :py:attr:`~SetPositionY`
            - Set the value of "Position Y".
          * - :py:attr:`~GetPositionZ`
            - Get the value of "Position Z".
          * - :py:attr:`~SetPositionZ`
            - Set the value of "Position Z".
          * - :py:attr:`~GetRotationX`
            - Get the value of "Rotation X".
          * - :py:attr:`~SetRotationX`
            - Set the value of "Rotation X".
          * - :py:attr:`~GetRotationY`
            - Get the value of "Rotation Y".
          * - :py:attr:`~SetRotationY`
            - Set the value of "Rotation Y".
          * - :py:attr:`~GetRotationZ`
            - Get the value of "Rotation Z".
          * - :py:attr:`~SetRotationZ`
            - Set the value of "Rotation Z".
          * - :py:attr:`~GetScale`
            - Get the value of "Scale".
          * - :py:attr:`~SetScale`
            - Set the value of "Scale".
          * - :py:attr:`~GetParticle`
            - Get the "Particle".
          * - :py:attr:`~SetParticle`
            - Set the "Particle".
          * - :py:attr:`~GetAvailableParticles`
            - Get all available Particles.








Import detail
-------------

.. code-block:: python

    from ansys.rocky.app.ra_particle_assembly import RAParticleAssemblyPart



Method detail
-------------

.. py:method:: GetWrappedClass() -> type[rocky30.models.particle.particle_assembly.ParticleAssemblyPart]
   :classmethod:


.. py:method:: GetClassName()
   :classmethod:


.. py:method:: GetAngle(unit: str | None = None) -> float

   
   Get the value of "Angle".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "dega".















   ..
       !! processed by numpydoc !!

.. py:method:: SetAngle(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Angle".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "dega".















   ..
       !! processed by numpydoc !!

.. py:method:: GetPositionX(unit: str | None = None) -> float

   
   Get the value of "Position X".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetPositionX(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Position X".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: GetPositionY(unit: str | None = None) -> float

   
   Get the value of "Position Y".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetPositionY(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Position Y".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: GetPositionZ(unit: str | None = None) -> float

   
   Get the value of "Position Z".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetPositionZ(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Position Z".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: GetRotationX(unit: str | None = None) -> float

   
   Get the value of "Rotation X".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetRotationX(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Rotation X".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: GetRotationY(unit: str | None = None) -> float

   
   Get the value of "Rotation Y".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetRotationY(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Rotation Y".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: GetRotationZ(unit: str | None = None) -> float

   
   Get the value of "Rotation Z".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: SetRotationZ(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Rotation Z".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "m".















   ..
       !! processed by numpydoc !!

.. py:method:: GetScale(unit: str | None = None) -> float

   
   Get the value of "Scale".

   :param unit:
       The unit for the returned value. If no unit is provided, the returned value will be in "-".















   ..
       !! processed by numpydoc !!

.. py:method:: SetScale(value: str | float, unit: str | None = None) -> None

   
   Set the value of "Scale".

   :param value:
       The value to set. This value can be an expression with input variables or float type.
   :param unit:
       The unit for `value`. If no unit is provided, `value` is assumed to be in "-".















   ..
       !! processed by numpydoc !!

.. py:method:: GetParticle()

   
   Get the "Particle".

   :rtype: :class:`RAParticle`















   ..
       !! processed by numpydoc !!

.. py:method:: SetParticle(value) -> None

   
   Set the "Particle".

   :param unicode, :class:`RAParticle` value:
       Either the API object wrapping the desired entity or its name.















   ..
       !! processed by numpydoc !!

.. py:method:: GetAvailableParticles()

   
   Get all available Particles.

   :rtype: List[:class:`RAParticle`]
       A list of :class:`RAParticle`.















   ..
       !! processed by numpydoc !!