## On this page

  

 

 # `ContactDistanceProbe`

 Last update: 16.07.2025 

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

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

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

Defines a ContactDistanceProbe.

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

## Overview

### Methods

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

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

## Property detail

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

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

Gets or sets the BeamSelection.

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

### *property* ContactDistanceProbe.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="ContactDistanceProbe.Children"></a>

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

Gets the list of children.

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

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

Gets the list of associated comments.

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

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

Gets or sets the ContactRegionSelection.

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

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

Gets or sets the CoordinateSystemSelection.

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

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

Gets the current DataModelObject’s category.

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

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

Gets or sets the DisplayTime.

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

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

Gets or sets the DpfEvaluation.

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

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

Gets the list of associated figures.

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

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

Gets or sets the GeometryLocation.

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

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

Gets the list of associated images.

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

### *property* ContactDistanceProbe.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="ContactDistanceProbe.IsSolved"></a>

### *property* ContactDistanceProbe.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="ContactDistanceProbe.IterationNumber"></a>

### *property* ContactDistanceProbe.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="ContactDistanceProbe.LoadStep"></a>

### *property* ContactDistanceProbe.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="ContactDistanceProbe.LoadStepNumber"></a>

### *property* ContactDistanceProbe.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="ContactDistanceProbe.LocationMethod"></a>

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

Gets or sets the LocationMethod.

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

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

Gets the MaximumTotal.

<a id="ContactDistanceProbe.MaximumValueOverTime"></a>

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

Gets the MaximumValueOverTime.

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

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

Gets the MaximumXAxis.

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

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

Gets the MaximumYAxis.

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

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

Gets the MaximumZAxis.

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

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

Gets or sets the MeshConnectionSelection.

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

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

Gets the MinimumTotal.

<a id="ContactDistanceProbe.MinimumValueOverTime"></a>

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

Gets the MinimumValueOverTime.

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

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

Gets the MinimumXAxis.

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

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

Gets the MinimumYAxis.

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

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

Gets the MinimumZAxis.

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

### *property* ContactDistanceProbe.Orientation *: [Ansys.ACT.Automation.Mechanical.CoordinateSystem](../../CoordinateSystem.md#ansys.mechanical.stubs.v242.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="ContactDistanceProbe.Properties"></a>

### *property* ContactDistanceProbe.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="ContactDistanceProbe.RemotePointSelection"></a>

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

Gets or sets the RemotePointSelection.

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

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

Gets or sets the ResultSelection.

<a id="ContactDistanceProbe.Results"></a>

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

Gets the Results.

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

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

Gets or sets the SpatialResolution.

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

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

Gets or sets the SpringSelection.

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

### *property* ContactDistanceProbe.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="ContactDistanceProbe.Summation"></a>

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

Gets or sets the Summation.

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

### *property* ContactDistanceProbe.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="ContactDistanceProbe.SurfaceSelection"></a>

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

Gets or sets the MeshConnectionSelection.

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

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

Gets the Time.

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

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

Gets the Total.

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

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

Gets the Type.

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

### *property* ContactDistanceProbe.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="ContactDistanceProbe.XAxis"></a>

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

Gets the XAxis.

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

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

Gets the YAxis.

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

### *property* ContactDistanceProbe.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="ContactDistanceProbe.Activate"></a>

### ContactDistanceProbe.Activate()

Activate the current object.

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

### ContactDistanceProbe.AddComment()

Creates a new child Comment.

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

### ContactDistanceProbe.AddFigure()

Creates a new child Figure.

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

### ContactDistanceProbe.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="ContactDistanceProbe.ClearGeneratedData"></a>

### ContactDistanceProbe.ClearGeneratedData()

Run the ClearGeneratedData action.

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

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

Copies all visible properties from this object to another.

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

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

Creates a new parameter for a Property.

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

### ContactDistanceProbe.Delete()

Run the Delete action.

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

### ContactDistanceProbe.Duplicate()

Creates a copy of the current DataModelObject.

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

### ContactDistanceProbe.DuplicateWithoutResults()

Run the DuplicateWithoutResults action.

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

### ContactDistanceProbe.EvaluateAllResults()

Run the EvaluateAllResults action.

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

### ContactDistanceProbe.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.v242.Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat), settings: [Ansys.Mechanical.Graphics.AnimationExportSettings](../../../../../Mechanical/Graphics/AnimationExportSettings.md#ansys.mechanical.stubs.v242.Ansys.Mechanical.Graphics.AnimationExportSettings))

Run the ExportAnimation action.

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

### ContactDistanceProbe.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="ContactDistanceProbe.GetParameter"></a>

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

Gets the parameter corresponding to the given property.

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

### ContactDistanceProbe.GroupAllSimilarChildren()

Run the GroupAllSimilarChildren action.

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

### ContactDistanceProbe.GroupSimilarObjects()

Run the GroupSimilarObjects action.

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

### ContactDistanceProbe.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="ContactDistanceProbe.PropertyByName"></a>

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

Get a property by its unique name.

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

### ContactDistanceProbe.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="ContactDistanceProbe.RenameBasedOnDefinition"></a>

### ContactDistanceProbe.RenameBasedOnDefinition()

Run the RenameBasedOnDefinition action.

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

### ContactDistanceProbe.SnapToMeshNodes()

Snap the coordinates of probe result to the mesh nodes.