JointProbe

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.JointProbe

Bases: object

Defines a BoltPretensionProbe.

Overview

Methods

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

Properties

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

Property detail

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

Gets the internal object. For advanced usage only.

property JointProbe.Status: System.Int32 | None

Gets the Status.

property JointProbe.ResultType: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None

Gets or sets the ResultType.

property JointProbe.OrientationMethod: System.Boolean | None

Gets the OrientationMethod.

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

Gets the current DataModelObject’s category.

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

Gets or sets the Summation.

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

Gets or sets the LocationMethod.

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

Gets or sets the GeometryLocation.

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

Gets or sets the CoordinateSystemSelection.

property JointProbe.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 JointProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None

Gets or sets the ContactRegionSelection.

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

Gets or sets the RemotePointSelection.

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

Gets or sets the BeamSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the MeshConnectionSelection.

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

Gets or sets the SpringSelection.

property JointProbe.IsSolved: System.Boolean | None

Gets the IsSolved.

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

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

property JointProbe.IterationNumber: System.Int32 | None

Gets the IterationNumber.

property JointProbe.LoadStep: System.Int32 | None

Gets the LoadStep.

property JointProbe.LoadStepNumber: System.UInt32 | None

Gets or sets the LoadStepNumber.

property JointProbe.Substep: System.Int32 | None

Gets the Substep.

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

Gets or sets the DisplayTime.

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

Gets the MaximumTotal.

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

Gets the MaximumXAxis.

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

Gets the MaximumYAxis.

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

Gets the MaximumZAxis.

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

Gets the MinimumTotal.

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

Gets the MinimumXAxis.

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

Gets the MinimumYAxis.

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

Gets the MinimumZAxis.

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

Gets the Time.

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

Gets the Total.

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

Gets the XAxis.

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

Gets the YAxis.

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

Gets the ZAxis.

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

Gets or sets the ResultSelection.

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

Gets or sets the SpatialResolution.

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

Gets the Type.

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

Gets or sets the DpfEvaluation.

property JointProbe.Suppressed: System.Boolean | None

Gets or sets the Suppressed.

property JointProbe.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets the list of children.

property JointProbe.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None

Gets the list of associated comments.

property JointProbe.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property JointProbe.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None

Gets the list of associated images.

property JointProbe.InternalObject: System.Object | None

Gets the internal object. For advanced usage only.

property JointProbe.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

Gets the list of properties for this object.

property JointProbe.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None

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

Method detail

JointProbe.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → System.Void

Run the ExportAnimation action.

JointProbe.ClearGeneratedData() → System.Void

Run the ClearGeneratedData action.

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

Run the DuplicateWithoutResults action.

JointProbe.EvaluateAllResults() → System.Void

Run the EvaluateAllResults action.

JointProbe.SnapToMeshNodes() → System.Void

Snap the coordinates of probe result to the mesh nodes.

JointProbe.RenameBasedOnDefinition() → System.Void

Run the RenameBasedOnDefinition action.

JointProbe.Delete() → System.Void

Run the Delete action.

JointProbe.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]

Gets the list of children, filtered by type.

JointProbe.GetChildren(category: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory, recurses: System.Boolean, children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]) → System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Gets the list of children, filtered by type.

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

Creates a new child Comment.

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

Creates a new child Figure.

JointProbe.AddImage(filePath: System.String) → 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.

JointProbe.Activate() → System.Void

Activate the current object.

JointProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void

Copies all visible properties from this object to another.

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

Creates a copy of the current DataModelObject.

JointProbe.GroupAllSimilarChildren() → System.Void

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

JointProbe.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

JointProbe.PropertyByAPIName(name: System.String) → 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.

JointProbe.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Creates a new parameter for a Property.

JointProbe.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

JointProbe.RemoveParameter(propName: System.String) → System.Void

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