ContactDistanceProbe

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ContactDistanceProbe(internalObject: Any)

Bases: object

Defines a ContactDistanceProbe.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
ClearGeneratedData	Run the ClearGeneratedData action.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
DuplicateWithoutResults	Run the DuplicateWithoutResults action.
Equals	Equals method.
EvaluateAllResults	Run the EvaluateAllResults action.
ExportAnimation	Run the ExportAnimation action.
GetAPIName	GetAPIName method.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
RenameBasedOnDefinition	Run the RenameBasedOnDefinition action.
RetrieveResult	Evaluates the individual probe result without evaluating all the results in the same solution.
SnapToMeshNodes	Snap the coordinates of probe result to the mesh nodes.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
BeamSelection	Gets or sets the BeamSelection.
BoundaryConditionSelection	Gets or sets the BoundaryConditionSelection. In order to select the option 'WeakSprings', please use the property 'LocationMethod = LocationDefinitionMethod.WeakSprings'.
Children	Gets the list of children.
ClsId	ClsId property.
Comments	Gets the list of associated comments.
ContactRegionSelection	Gets or sets the ContactRegionSelection.
CoordinateSystemSelection	Gets or sets the CoordinateSystemSelection.
DataModelObjectCategory	Gets the current DataModelObject's category.
DisplayTime	Gets or sets the DisplayTime.
DpfEvaluation	Gets or sets the DpfEvaluation.
Figures	Gets the list of associated figures.
GeometryLocation	Gets or sets the GeometryLocation.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IsSolved	Gets the IsSolved.
IterationNumber	Gets the IterationNumber.
LoadStep	Gets the LoadStep.
LoadStepNumber	Gets or sets the LoadStepNumber.
LocationMethod	Gets or sets the LocationMethod.
MaximumTotal	Gets the MaximumTotal.
MaximumValueOverTime	Gets the MaximumValueOverTime.
MaximumXAxis	Gets the MaximumXAxis.
MaximumYAxis	Gets the MaximumYAxis.
MaximumZAxis	Gets the MaximumZAxis.
MeshConnectionSelection	Gets or sets the MeshConnectionSelection.
MinimumTotal	Gets the MinimumTotal.
MinimumValueOverTime	Gets the MinimumValueOverTime.
MinimumXAxis	Gets the MinimumXAxis.
MinimumYAxis	Gets the MinimumYAxis.
MinimumZAxis	Gets the MinimumZAxis.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Orientation	Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
Parent	Parent property.
Properties	Gets the list of properties for this object.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
RemotePointSelection	Gets or sets the RemotePointSelection.
ResultSelection	Gets or sets the ResultSelection.
Results	Gets the Results.
RpmSetNumber	Gets or sets the RpmSetNumber.
SpatialResolution	Gets or sets the SpatialResolution.
SpringSelection	Gets or sets the SpringSelection.
State	State property.
Substep	Gets the Substep.
Summation	Gets or sets the Summation.
Suppressed	Gets or sets the Suppressed.
SurfaceSelection	Gets or sets the MeshConnectionSelection.
Time	Gets the Time.
Total	Gets the Total.
Type	Gets the Type.
VisibleProperties	Gets the list of properties that are visible for this object.
XAxis	Gets the XAxis.
YAxis	Gets the YAxis.
ZAxis	Gets the ZAxis.

Property detail

property ContactDistanceProbe.AttachedRefs: List[int] | None

AttachedRefs property.

property ContactDistanceProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None

Gets or sets the BeamSelection.

property ContactDistanceProbe.BoundaryConditionSelection: Ansys.ACT.Automation.Mechanical.DataModelObject | None

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

property ContactDistanceProbe.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property ContactDistanceProbe.ClsId: int | None

ClsId property.

property ContactDistanceProbe.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property ContactDistanceProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

property ContactDistanceProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystemSelection.

property ContactDistanceProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property ContactDistanceProbe.DisplayTime: Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property ContactDistanceProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

property ContactDistanceProbe.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property ContactDistanceProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the GeometryLocation.

property ContactDistanceProbe.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property ContactDistanceProbe.IconName: str | None

IconName property.

property ContactDistanceProbe.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property ContactDistanceProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None

Gets the internal object. For advanced usage only.

property ContactDistanceProbe.IsSolved: bool | None

Gets the IsSolved.

property ContactDistanceProbe.IterationNumber: int | None

Gets the IterationNumber.

property ContactDistanceProbe.LoadStep: int | None

Gets the LoadStep.

property ContactDistanceProbe.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

property ContactDistanceProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None

Gets or sets the LocationMethod.

property ContactDistanceProbe.MaximumTotal: Ansys.Core.Units.Quantity | None

Gets the MaximumTotal.

property ContactDistanceProbe.MaximumValueOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumValueOverTime.

property ContactDistanceProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None

Gets the MaximumXAxis.

property ContactDistanceProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None

Gets the MaximumYAxis.

property ContactDistanceProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None

Gets the MaximumZAxis.

property ContactDistanceProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None

Gets or sets the MeshConnectionSelection.

property ContactDistanceProbe.MinimumTotal: Ansys.Core.Units.Quantity | None

Gets the MinimumTotal.

property ContactDistanceProbe.MinimumValueOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumValueOverTime.

property ContactDistanceProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None

Gets the MinimumXAxis.

property ContactDistanceProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None

Gets the MinimumYAxis.

property ContactDistanceProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None

Gets the MinimumZAxis.

property ContactDistanceProbe.Name: str | None

Name property.

property ContactDistanceProbe.ObjectId: int | None

ObjectId property.

property ContactDistanceProbe.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property ContactDistanceProbe.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property ContactDistanceProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

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

property ContactDistanceProbe.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property ContactDistanceProbe.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property ContactDistanceProbe.RPMSelection: Ansys.Core.Units.Quantity | None

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

property ContactDistanceProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None

Gets or sets the RemotePointSelection.

property ContactDistanceProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None

Gets or sets the ResultSelection.

property ContactDistanceProbe.Results: Ansys.Core.Units.Quantity | None

Gets the Results.

property ContactDistanceProbe.RpmSetNumber: int | None

Gets or sets the RpmSetNumber.

property ContactDistanceProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None

Gets or sets the SpatialResolution.

property ContactDistanceProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the SpringSelection.

property ContactDistanceProbe.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property ContactDistanceProbe.Substep: int | None

Gets the Substep.

property ContactDistanceProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None

Gets or sets the Summation.

property ContactDistanceProbe.Suppressed: bool | None

Gets or sets the Suppressed.

property ContactDistanceProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None

Gets or sets the MeshConnectionSelection.

property ContactDistanceProbe.Time: Ansys.Core.Units.Quantity | None

Gets the Time.

property ContactDistanceProbe.Total: Ansys.Core.Units.Quantity | None

Gets the Total.

property ContactDistanceProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets the Type.

property ContactDistanceProbe.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None

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

property ContactDistanceProbe.XAxis: Ansys.Core.Units.Quantity | None

Gets the XAxis.

property ContactDistanceProbe.YAxis: Ansys.Core.Units.Quantity | None

Gets the YAxis.

property ContactDistanceProbe.ZAxis: Ansys.Core.Units.Quantity | None

Gets the ZAxis.

Method detail

ContactDistanceProbe.Activate() → None

Activate the current object.

ContactDistanceProbe.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

ContactDistanceProbe.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

ContactDistanceProbe.AddImage(filePath: str) → Ansys.ACT.Automation.Mechanical.Image

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.

ContactDistanceProbe.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

ContactDistanceProbe.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

ContactDistanceProbe.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

ContactDistanceProbe.Delete() → None

Run the Delete action.

ContactDistanceProbe.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

ContactDistanceProbe.DuplicateWithoutResults() → Ansys.ACT.Automation.Mechanical.DataModelObject

Run the DuplicateWithoutResults action.

ContactDistanceProbe.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

ContactDistanceProbe.EvaluateAllResults() → None

Run the EvaluateAllResults action.

ContactDistanceProbe.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → None

Run the ExportAnimation action.

ContactDistanceProbe.GetAPIName(dispId: int) → str

GetAPIName method.

ContactDistanceProbe.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

ContactDistanceProbe.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

ContactDistanceProbe.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

ContactDistanceProbe.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

ContactDistanceProbe.GetHashCode() → int

GetHashCode method.

ContactDistanceProbe.GetIconFile() → System.Byte

GetIconFile method.

ContactDistanceProbe.GetLifetimeService() → Any

GetLifetimeService method.

ContactDistanceProbe.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

ContactDistanceProbe.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

ContactDistanceProbe.GetPath() → str

GetPath method.

ContactDistanceProbe.GetPropertyName(dispId: int) → str

GetPropertyName method.

ContactDistanceProbe.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ContactDistanceProbe.GetType() → type

GetType method.

ContactDistanceProbe.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

ContactDistanceProbe.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ContactDistanceProbe.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

ContactDistanceProbe.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

ContactDistanceProbe.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ContactDistanceProbe.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ContactDistanceProbe.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

ContactDistanceProbe.PropertyByAPIName(name: str) → Ansys.ACT.Automation.Mechanical.Property

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.

ContactDistanceProbe.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

ContactDistanceProbe.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

ContactDistanceProbe.RemoveParameter(propName: str) → None

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

ContactDistanceProbe.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

ContactDistanceProbe.RetrieveResult() → None

Evaluates the individual probe result without evaluating all the results in the same solution.

ContactDistanceProbe.SnapToMeshNodes() → None

Snap the coordinates of probe result to the mesh nodes.

ContactDistanceProbe.ToString() → str

ToString method.