## On this page

  

 

 # `JointProbe`

 Last update: 09.03.2026 

<a id="ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.JointProbe"></a>

#### *class* Ansys.ACT.Automation.Mechanical.Results.ProbeResults.JointProbe

Bases: [`object`](https://docs.python.org/3/library/functions.html#object)

Defines a BoltPretensionProbe.

<a id="overview"></a>

## Overview

### Methods

NameDescription[`Activate`](#JointProbe.Activate)Activate the current object.[`AddComment`](#JointProbe.AddComment)Creates a new child Comment.[`AddFigure`](#JointProbe.AddFigure)Creates a new child Figure.[`AddImage`](#JointProbe.AddImage)Creates a new child Image.[`ClearGeneratedData`](#JointProbe.ClearGeneratedData)Run the ClearGeneratedData action.[`CopyTo`](#JointProbe.CopyTo)Copies all visible properties from this object to another.[`CreateParameter`](#JointProbe.CreateParameter)Creates a new parameter for a Property.[`Delete`](#JointProbe.Delete)Run the Delete action.[`Duplicate`](#JointProbe.Duplicate)Creates a copy of the current DataModelObject.[`DuplicateWithoutResults`](#JointProbe.DuplicateWithoutResults)Run the DuplicateWithoutResults action.[`EvaluateAllResults`](#JointProbe.EvaluateAllResults)Run the EvaluateAllResults action.[`ExportAnimation`](#JointProbe.ExportAnimation)Run the ExportAnimation action.[`GetChildren`](#JointProbe.GetChildren)Gets the list of children, filtered by type.[`GetParameter`](#JointProbe.GetParameter)Gets the parameter corresponding to the given property.[`GroupAllSimilarChildren`](#JointProbe.GroupAllSimilarChildren)Run the GroupAllSimilarChildren action.[`GroupSimilarObjects`](#JointProbe.GroupSimilarObjects)Run the GroupSimilarObjects action.[`PropertyByAPIName`](#JointProbe.PropertyByAPIName)Get a property by its API name.[`PropertyByName`](#JointProbe.PropertyByName)Get a property by its unique name.[`RemoveParameter`](#JointProbe.RemoveParameter)Removes the parameter from the parameter set corresponding to the given property.[`RenameBasedOnDefinition`](#JointProbe.RenameBasedOnDefinition)Run the RenameBasedOnDefinition action.[`SnapToMeshNodes`](#JointProbe.SnapToMeshNodes)Snap the coordinates of probe result to the mesh nodes.### Properties

NameDescription[`BeamSelection`](#JointProbe.BeamSelection)Gets or sets the BeamSelection.[`BoundaryConditionSelection`](#JointProbe.BoundaryConditionSelection)Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.[`Children`](#JointProbe.Children)Gets the list of children.[`Comments`](#JointProbe.Comments)Gets the list of associated comments.[`ContactRegionSelection`](#JointProbe.ContactRegionSelection)Gets or sets the ContactRegionSelection.[`CoordinateSystemSelection`](#JointProbe.CoordinateSystemSelection)Gets or sets the CoordinateSystemSelection.[`DataModelObjectCategory`](#JointProbe.DataModelObjectCategory)Gets the current DataModelObject’s category.[`DisplayTime`](#JointProbe.DisplayTime)Gets or sets the DisplayTime.[`DpfEvaluation`](#JointProbe.DpfEvaluation)Gets or sets the DpfEvaluation.[`Figures`](#JointProbe.Figures)Gets the list of associated figures.[`GeometryLocation`](#JointProbe.GeometryLocation)Gets or sets the GeometryLocation.[`Images`](#JointProbe.Images)Gets the list of associated images.[`InternalObject`](#JointProbe.InternalObject)Gets the internal object. For advanced usage only.[`IsSolved`](#JointProbe.IsSolved)Gets the IsSolved.[`IterationNumber`](#JointProbe.IterationNumber)Gets the IterationNumber.[`LoadStep`](#JointProbe.LoadStep)Gets the LoadStep.[`LoadStepNumber`](#JointProbe.LoadStepNumber)Gets or sets the LoadStepNumber.[`LocationMethod`](#JointProbe.LocationMethod)Gets or sets the LocationMethod.[`MaximumTotal`](#JointProbe.MaximumTotal)Gets the MaximumTotal.[`MaximumXAxis`](#JointProbe.MaximumXAxis)Gets the MaximumXAxis.[`MaximumYAxis`](#JointProbe.MaximumYAxis)Gets the MaximumYAxis.[`MaximumZAxis`](#JointProbe.MaximumZAxis)Gets the MaximumZAxis.[`MeshConnectionSelection`](#JointProbe.MeshConnectionSelection)Gets or sets the MeshConnectionSelection.[`MinimumTotal`](#JointProbe.MinimumTotal)Gets the MinimumTotal.[`MinimumXAxis`](#JointProbe.MinimumXAxis)Gets the MinimumXAxis.[`MinimumYAxis`](#JointProbe.MinimumYAxis)Gets the MinimumYAxis.[`MinimumZAxis`](#JointProbe.MinimumZAxis)Gets the MinimumZAxis.[`Orientation`](#JointProbe.Orientation)Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.[`OrientationMethod`](#JointProbe.OrientationMethod)Gets the OrientationMethod.[`Properties`](#JointProbe.Properties)Gets the list of properties for this object.[`RPMSelection`](#JointProbe.RPMSelection)Gets or sets the RPM Selection value at which the results are evaluated.[`RemotePointSelection`](#JointProbe.RemotePointSelection)Gets or sets the RemotePointSelection.[`ResultSelection`](#JointProbe.ResultSelection)Gets or sets the ResultSelection.[`ResultType`](#JointProbe.ResultType)Gets or sets the ResultType.[`SpatialResolution`](#JointProbe.SpatialResolution)Gets or sets the SpatialResolution.[`SpringSelection`](#JointProbe.SpringSelection)Gets or sets the SpringSelection.[`Status`](#JointProbe.Status)Gets the Status.[`Substep`](#JointProbe.Substep)Gets the Substep.[`Summation`](#JointProbe.Summation)Gets or sets the Summation.[`Suppressed`](#JointProbe.Suppressed)Gets or sets the Suppressed.[`SurfaceSelection`](#JointProbe.SurfaceSelection)Gets or sets the MeshConnectionSelection.[`Time`](#JointProbe.Time)Gets the Time.[`Total`](#JointProbe.Total)Gets the Total.[`Type`](#JointProbe.Type)Gets the Type.[`VisibleProperties`](#JointProbe.VisibleProperties)Gets the list of properties that are visible for this object.[`XAxis`](#JointProbe.XAxis)Gets the XAxis.[`YAxis`](#JointProbe.YAxis)Gets the YAxis.[`ZAxis`](#JointProbe.ZAxis)Gets the ZAxis.<a id="property-detail"></a>

## Property detail

<a id="JointProbe.BeamSelection"></a>

### *property* JointProbe.BeamSelection *: [Ansys.ACT.Automation.Mechanical.Connections.Beam](../../Connections/Beam.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Connections.Beam) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BeamSelection.

<a id="JointProbe.BoundaryConditionSelection"></a>

### *property* JointProbe.BoundaryConditionSelection *: Ansys.ACT.Automation.Mechanical.DataModelObject | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’.

<a id="JointProbe.Children"></a>

### *property* JointProbe.Children *: List\[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of children.

<a id="JointProbe.Comments"></a>

### *property* JointProbe.Comments *: Iterable\[[Ansys.ACT.Automation.Mechanical.Comment](../../Comment.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Comment)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated comments.

<a id="JointProbe.ContactRegionSelection"></a>

### *property* JointProbe.ContactRegionSelection *: [Ansys.ACT.Automation.Mechanical.Connections.ContactRegion](../../Connections/ContactRegion.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Connections.ContactRegion) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ContactRegionSelection.

<a id="JointProbe.CoordinateSystemSelection"></a>

### *property* JointProbe.CoordinateSystemSelection *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../../CoordinateSystem.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the CoordinateSystemSelection.

<a id="JointProbe.DataModelObjectCategory"></a>

### *property* JointProbe.DataModelObjectCategory *: [Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory](../../../../../Mechanical/DataModel/Enums/DataModelObjectCategory.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the current DataModelObject’s category.

<a id="JointProbe.DisplayTime"></a>

### *property* JointProbe.DisplayTime *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DisplayTime.

<a id="JointProbe.DpfEvaluation"></a>

### *property* JointProbe.DpfEvaluation *: [Ansys.Mechanical.DataModel.Enums.DpfEvaluationType](../../../../../Mechanical/DataModel/Enums/DpfEvaluationType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.DpfEvaluationType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the DpfEvaluation.

<a id="JointProbe.Figures"></a>

### *property* JointProbe.Figures *: Iterable\[[Ansys.ACT.Automation.Mechanical.Figure](../../Figure.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Figure)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated figures.

<a id="JointProbe.GeometryLocation"></a>

### *property* JointProbe.GeometryLocation *: Ansys.ACT.Interfaces.Common.ISelectionInfo | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the GeometryLocation.

<a id="JointProbe.Images"></a>

### *property* JointProbe.Images *: Iterable\[[Ansys.ACT.Automation.Mechanical.Image](../../Image.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Image)\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of associated images.

<a id="JointProbe.InternalObject"></a>

### *property* JointProbe.InternalObject *: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the internal object. For advanced usage only.

<a id="JointProbe.IsSolved"></a>

### *property* JointProbe.IsSolved *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IsSolved.

<a id="JointProbe.IterationNumber"></a>

### *property* JointProbe.IterationNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the IterationNumber.

<a id="JointProbe.LoadStep"></a>

### *property* JointProbe.LoadStep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the LoadStep.

<a id="JointProbe.LoadStepNumber"></a>

### *property* JointProbe.LoadStepNumber *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LoadStepNumber.

<a id="JointProbe.LocationMethod"></a>

### *property* JointProbe.LocationMethod *: [Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod](../../../../../Mechanical/DataModel/Enums/LocationDefinitionMethod.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the LocationMethod.

<a id="JointProbe.MaximumTotal"></a>

### *property* JointProbe.MaximumTotal *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumTotal.

<a id="JointProbe.MaximumXAxis"></a>

### *property* JointProbe.MaximumXAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumXAxis.

<a id="JointProbe.MaximumYAxis"></a>

### *property* JointProbe.MaximumYAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumYAxis.

<a id="JointProbe.MaximumZAxis"></a>

### *property* JointProbe.MaximumZAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MaximumZAxis.

<a id="JointProbe.MeshConnectionSelection"></a>

### *property* JointProbe.MeshConnectionSelection *: [Ansys.ACT.Automation.Mechanical.MeshConnection](../../MeshConnection.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.MeshConnection) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MeshConnectionSelection.

<a id="JointProbe.MinimumTotal"></a>

### *property* JointProbe.MinimumTotal *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumTotal.

<a id="JointProbe.MinimumXAxis"></a>

### *property* JointProbe.MinimumXAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumXAxis.

<a id="JointProbe.MinimumYAxis"></a>

### *property* JointProbe.MinimumYAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumYAxis.

<a id="JointProbe.MinimumZAxis"></a>

### *property* JointProbe.MinimumZAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the MinimumZAxis.

<a id="JointProbe.Orientation"></a>

### *property* JointProbe.Orientation *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../../CoordinateSystem.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.CoordinateSystem) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.

<a id="JointProbe.OrientationMethod"></a>

### *property* JointProbe.OrientationMethod *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the OrientationMethod.

<a id="JointProbe.Properties"></a>

### *property* JointProbe.Properties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties for this object.

<a id="JointProbe.RPMSelection"></a>

### *property* JointProbe.RPMSelection *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RPM Selection value at which the results are evaluated.

<a id="JointProbe.RemotePointSelection"></a>

### *property* JointProbe.RemotePointSelection *: [Ansys.ACT.Automation.Mechanical.RemotePoint](../../RemotePoint.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.RemotePoint) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the RemotePointSelection.

<a id="JointProbe.ResultSelection"></a>

### *property* JointProbe.ResultSelection *: [Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter](../../../../../Mechanical/DataModel/Enums/ProbeDisplayFilter.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ResultSelection.

<a id="JointProbe.ResultType"></a>

### *property* JointProbe.ResultType *: [Ansys.Mechanical.DataModel.Enums.ProbeResultType](../../../../../Mechanical/DataModel/Enums/ProbeResultType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.ProbeResultType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the ResultType.

<a id="JointProbe.SpatialResolution"></a>

### *property* JointProbe.SpatialResolution *: [Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum](../../../../../Mechanical/DataModel/Enums/MinimumOrMaximum.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SpatialResolution.

<a id="JointProbe.SpringSelection"></a>

### *property* JointProbe.SpringSelection *: [Ansys.ACT.Automation.Mechanical.Connections.Spring](../../Connections/Spring.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Connections.Spring) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the SpringSelection.

<a id="JointProbe.Status"></a>

### *property* JointProbe.Status *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Status.

<a id="JointProbe.Substep"></a>

### *property* JointProbe.Substep *: [int](https://docs.python.org/3/library/functions.html#int) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Substep.

<a id="JointProbe.Summation"></a>

### *property* JointProbe.Summation *: [Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType](../../../../../Mechanical/DataModel/Enums/MomentsAtSummationPointType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Summation.

<a id="JointProbe.Suppressed"></a>

### *property* JointProbe.Suppressed *: [bool](https://docs.python.org/3/library/functions.html#bool) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the Suppressed.

<a id="JointProbe.SurfaceSelection"></a>

### *property* JointProbe.SurfaceSelection *: [Ansys.ACT.Automation.Mechanical.Surface](../../Surface.md#ansys.mechanical.stubs.v251.Ansys.ACT.Automation.Mechanical.Surface) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets or sets the MeshConnectionSelection.

<a id="JointProbe.Time"></a>

### *property* JointProbe.Time *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Time.

<a id="JointProbe.Total"></a>

### *property* JointProbe.Total *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Total.

<a id="JointProbe.Type"></a>

### *property* JointProbe.Type *: [Ansys.Mechanical.DataModel.Enums.ProbeResultType](../../../../../Mechanical/DataModel/Enums/ProbeResultType.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.ProbeResultType) | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the Type.

<a id="JointProbe.VisibleProperties"></a>

### *property* JointProbe.VisibleProperties *: [tuple](https://docs.python.org/3/library/stdtypes.html#tuple)\[Ansys.ACT.Automation.Mechanical.Property\] | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the list of properties that are visible for this object.

<a id="JointProbe.XAxis"></a>

### *property* JointProbe.XAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the XAxis.

<a id="JointProbe.YAxis"></a>

### *property* JointProbe.YAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the YAxis.

<a id="JointProbe.ZAxis"></a>

### *property* JointProbe.ZAxis *: Ansys.Core.Units.Quantity | [None](https://docs.python.org/3/library/constants.html#None)*

Gets the ZAxis.

<a id="method-detail"></a>

## Method detail

<a id="JointProbe.Activate"></a>

### JointProbe.Activate()

Activate the current object.

<a id="JointProbe.AddComment"></a>

### JointProbe.AddComment()

Creates a new child Comment.

<a id="JointProbe.AddFigure"></a>

### JointProbe.AddFigure()

Creates a new child Figure.

<a id="JointProbe.AddImage"></a>

### JointProbe.AddImage(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Creates a new child Image.
If a filePath is provided, the image will be loaded from that file,
if not, the image will be a screen capture of the Geometry window.

```

<a id="JointProbe.ClearGeneratedData"></a>

### JointProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

<a id="JointProbe.CopyTo"></a>

### JointProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)

Copies all visible properties from this object to another.

<a id="JointProbe.CreateParameter"></a>

### JointProbe.CreateParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Creates a new parameter for a Property.

<a id="JointProbe.Delete"></a>

### JointProbe.Delete()

Run the Delete action.

<a id="JointProbe.Duplicate"></a>

### JointProbe.Duplicate()

Creates a copy of the current DataModelObject.

<a id="JointProbe.DuplicateWithoutResults"></a>

### JointProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

<a id="JointProbe.EvaluateAllResults"></a>

### JointProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

<a id="JointProbe.ExportAnimation"></a>

### JointProbe.ExportAnimation(filePath: [str](https://docs.python.org/3/library/stdtypes.html#str), format: [Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat](../../../../../Mechanical/DataModel/Enums/GraphicsAnimationExportFormat.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat), settings: [Ansys.Mechanical.Graphics.AnimationExportSettings](../../../../../Mechanical/Graphics/AnimationExportSettings.md#ansys.mechanical.stubs.v251.Ansys.Mechanical.Graphics.AnimationExportSettings))

Run the ExportAnimation action.

<a id="JointProbe.GetChildren"></a>

### JointProbe.GetChildren(recurses: [bool](https://docs.python.org/3/library/functions.html#bool), children: List\[ChildrenType\])

Gets the list of children, filtered by type.

<a id="JointProbe.GetParameter"></a>

### JointProbe.GetParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Gets the parameter corresponding to the given property.

<a id="JointProbe.GroupAllSimilarChildren"></a>

### JointProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

<a id="JointProbe.GroupSimilarObjects"></a>

### JointProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

<a id="JointProbe.PropertyByAPIName"></a>

### JointProbe.PropertyByAPIName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

```text
Get a property by its API name.
If multiple properties have the same API Name, only the first property with that name will be returned.

```

<a id="JointProbe.PropertyByName"></a>

### JointProbe.PropertyByName(name: [str](https://docs.python.org/3/library/stdtypes.html#str))

Get a property by its unique name.

<a id="JointProbe.RemoveParameter"></a>

### JointProbe.RemoveParameter(propName: [str](https://docs.python.org/3/library/stdtypes.html#str))

Removes the parameter from the parameter set corresponding to the given property.

<a id="JointProbe.RenameBasedOnDefinition"></a>

### JointProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

<a id="JointProbe.SnapToMeshNodes"></a>

### JointProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.