RAParticleJointsData

class ansys.rocky.app.ra_particle_joints_data.RAParticleJointsData

Bases: ansys.rocky.app.ra_grid_process_element.RAGridProcessElementItem

Rocky API process model.

Overview

Constructors

GetWrappedClass
GetClassName

Methods

RemoveProcess	It is not possible to remove the item “Joints” from the project.
GetCollectJointData	Get the value of “Collect Joint Data”.
SetCollectJointData	Set the value of “Collect Joint Data”.
EnableCollectJointData	Set the value of “Collect Joint Data” to True.
DisableCollectJointData	Set the value of “Collect Joint Data” to False.
IsCollectJointDataEnabled	Check if the “Collect Joint Data” is enabled.

Import detail

from ansys.rocky.app.ra_particle_joints_data import RAParticleJointsData

Method detail

classmethod RAParticleJointsData.GetWrappedClass()

classmethod RAParticleJointsData.GetClassName()

RAParticleJointsData.RemoveProcess() → None

It is not possible to remove the item “Joints” from the project.

RAParticleJointsData.GetCollectJointData() → bool

Get the value of “Collect Joint Data”.

RAParticleJointsData.SetCollectJointData(value: bool) → None

Set the value of “Collect Joint Data”.

Parameters:

value – The value to set.

RAParticleJointsData.EnableCollectJointData() → None

Set the value of “Collect Joint Data” to True.

RAParticleJointsData.DisableCollectJointData() → None

Set the value of “Collect Joint Data” to False.

RAParticleJointsData.IsCollectJointDataEnabled() → bool

Check if the “Collect Joint Data” is enabled.