FlexibleRotationProbe#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.FlexibleRotationProbe#

Bases: object

Defines a FlexibleRotationProbe.

Overview#

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.

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.

EvaluateAllResults

Run the EvaluateAllResults action.

ExportAnimation

Run the ExportAnimation action.

GetChildren

Gets the list of children, filtered by type.

GetParameter

Gets the parameter corresponding to the given property.

GroupAllSimilarChildren

Run the GroupAllSimilarChildren action.

GroupSimilarObjects

Run the GroupSimilarObjects action.

PropertyByAPIName

Get a property by its API name.

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.

SnapToMeshNodes

Snap the coordinates of probe result to the mesh nodes.

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.

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.

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.

MaximumXAxis

Gets the MaximumXAxis.

MaximumXAxisRotation

Gets the MaximumXAxisRotation.

MaximumYAxis

Gets the MaximumYAxis.

MaximumYAxisRotation

Gets the MaximumYAxisRotation.

MaximumZAxis

Gets the MaximumZAxis.

MaximumZAxisRotation

Gets the MaximumZAxisRotation.

MeshConnectionSelection

Gets or sets the MeshConnectionSelection.

MinimumTotal

Gets the MinimumTotal.

MinimumXAxis

Gets the MinimumXAxis.

MinimumXAxisRotation

Gets the MinimumXAxisRotation.

MinimumYAxis

Gets the MinimumYAxis.

MinimumYAxisRotation

Gets the MinimumYAxisRotation.

MinimumZAxis

Gets the MinimumZAxis.

MinimumZAxisRotation

Gets the MinimumZAxisRotation.

Orientation

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

Properties

Gets the list of properties for this object.

RemotePointSelection

Gets or sets the RemotePointSelection.

ResultSelection

Gets or sets the ResultSelection.

SpatialResolution

Gets or sets the SpatialResolution.

SpringSelection

Gets or sets the SpringSelection.

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.

XAxisRotation

Gets the XAxisRotation.

YAxis

Gets the YAxis.

YAxisRotation

Gets the YAxisRotation.

ZAxis

Gets the ZAxis.

ZAxisRotation

Gets the ZAxisRotation.

Property detail#

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

Gets or sets the BeamSelection.

property FlexibleRotationProbe.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 FlexibleRotationProbe.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the ContactRegionSelection.

property FlexibleRotationProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystemSelection.

property FlexibleRotationProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#

Gets the current DataModelObject's category.

property FlexibleRotationProbe.DisplayTime: Ansys.Core.Units.Quantity | None#

Gets or sets the DisplayTime.

property FlexibleRotationProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#

Gets or sets the DpfEvaluation.

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

Gets the list of associated figures.

property FlexibleRotationProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the GeometryLocation.

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

Gets the list of associated images.

property FlexibleRotationProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None#

Gets the internal object. For advanced usage only.

property FlexibleRotationProbe.IsSolved: bool | None#

Gets the IsSolved.

property FlexibleRotationProbe.IterationNumber: int | None#

Gets the IterationNumber.

property FlexibleRotationProbe.LoadStep: int | None#

Gets the LoadStep.

property FlexibleRotationProbe.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property FlexibleRotationProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None#

Gets or sets the LocationMethod.

property FlexibleRotationProbe.MaximumTotal: Ansys.Core.Units.Quantity | None#

Gets the MaximumTotal.

property FlexibleRotationProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumXAxis.

property FlexibleRotationProbe.MaximumXAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the MaximumXAxisRotation.

property FlexibleRotationProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumYAxis.

property FlexibleRotationProbe.MaximumYAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the MaximumYAxisRotation.

property FlexibleRotationProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MaximumZAxis.

property FlexibleRotationProbe.MaximumZAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the MaximumZAxisRotation.

property FlexibleRotationProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None#

Gets or sets the MeshConnectionSelection.

property FlexibleRotationProbe.MinimumTotal: Ansys.Core.Units.Quantity | None#

Gets the MinimumTotal.

property FlexibleRotationProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumXAxis.

property FlexibleRotationProbe.MinimumXAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the MinimumXAxisRotation.

property FlexibleRotationProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumYAxis.

property FlexibleRotationProbe.MinimumYAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the MinimumYAxisRotation.

property FlexibleRotationProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None#

Gets the MinimumZAxis.

property FlexibleRotationProbe.MinimumZAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the MinimumZAxisRotation.

property FlexibleRotationProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

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

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

Gets the list of properties for this object.

property FlexibleRotationProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None#

Gets or sets the RemotePointSelection.

property FlexibleRotationProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None#

Gets or sets the ResultSelection.

property FlexibleRotationProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None#

Gets or sets the SpatialResolution.

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

Gets or sets the SpringSelection.

property FlexibleRotationProbe.Substep: int | None#

Gets the Substep.

property FlexibleRotationProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None#

Gets or sets the Summation.

property FlexibleRotationProbe.Suppressed: bool | None#

Gets or sets the Suppressed.

property FlexibleRotationProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None#

Gets or sets the MeshConnectionSelection.

property FlexibleRotationProbe.Time: Ansys.Core.Units.Quantity | None#

Gets the Time.

property FlexibleRotationProbe.Total: Ansys.Core.Units.Quantity | None#

Gets the Total.

property FlexibleRotationProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None#

Gets the Type.

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

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

property FlexibleRotationProbe.XAxis: Ansys.Core.Units.Quantity | None#

Gets the XAxis.

property FlexibleRotationProbe.XAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the XAxisRotation.

property FlexibleRotationProbe.YAxis: Ansys.Core.Units.Quantity | None#

Gets the YAxis.

property FlexibleRotationProbe.YAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the YAxisRotation.

property FlexibleRotationProbe.ZAxis: Ansys.Core.Units.Quantity | None#

Gets the ZAxis.

property FlexibleRotationProbe.ZAxisRotation: Ansys.Core.Units.Quantity | None#

Gets the ZAxisRotation.

Method detail#

FlexibleRotationProbe.Activate() None#

Activate the current object.

FlexibleRotationProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment#

Creates a new child Comment.

FlexibleRotationProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure#

Creates a new child Figure.

FlexibleRotationProbe.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.
FlexibleRotationProbe.ClearGeneratedData() None#

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

FlexibleRotationProbe.CreateParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Creates a new parameter for a Property.

FlexibleRotationProbe.Delete() None#

Run the Delete action.

FlexibleRotationProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#

Creates a copy of the current DataModelObject.

FlexibleRotationProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject#

Run the DuplicateWithoutResults action.

FlexibleRotationProbe.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

FlexibleRotationProbe.GetChildren(recurses: bool, children: List[ChildrenType]) List[ChildrenType]#

Gets the list of children, filtered by type.

FlexibleRotationProbe.GetParameter(propName: str) Ansys.ACT.Interfaces.Mechanical.IParameter#

Gets the parameter corresponding to the given property.

FlexibleRotationProbe.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

FlexibleRotationProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#

Run the GroupSimilarObjects action.

FlexibleRotationProbe.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.
FlexibleRotationProbe.PropertyByName(name: str) Ansys.ACT.Automation.Mechanical.Property#

Get a property by its unique name.

FlexibleRotationProbe.RemoveParameter(propName: str) None#

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

FlexibleRotationProbe.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.

FlexibleRotationProbe.SnapToMeshNodes() None#

Snap the coordinates of probe result to the mesh nodes.