PositionTracker#

class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ResultTrackers.PositionTracker#

Bases: object

Defines a PositionTracker.

Overview#

Activate

Activate the current object.

AddComment

Creates a new child Comment.

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.

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.

AccelerationType

Gets or sets the AccelerationType.

BoundaryCondition

Gets or sets the BoundaryCondition.

ChartDimensions

Gets or sets the Chart Dimensions

ChartViewingStyle

Gets or sets the ChartViewingStyle.

Children

Gets the list of children.

Comments

Gets the list of associated comments.

CoordinateSystem

Gets or sets the CoordinateSystem.

CurvesAppearanceDisplay

Gets or sets the CurvesAppearanceDisplay.

CutFrequency

Gets or sets the CutFrequency.

DataModelObjectCategory

Gets the current DataModelObject's category.

DeformationType

Gets or sets the DeformationType.

DpfEvaluation

Gets or sets the DpfEvaluation.

Duration

Gets or sets the Duration.

EnhancedTracking

Gets the EnhancedTracking.

FilterMaximum

Gets the FilterMaximum.

FilterMinimum

Gets the FilterMinimum.

FilterType

Gets or sets the FilterType.

FrequencyAtMaximumAmplitude

Gets the FrequencyAtMaximumAmplitude.

GeometrySelectionString

Gets or sets the GeometrySelectionString.

Images

Gets the list of associated images.

ImaginaryAtMaximumAmplitude

Gets the ImaginaryAtMaximumAmplitude.

InternalObject

Gets the internal object. For advanced usage only.

IsSolved

Gets the IsSolved.

LoadStepNumber

Gets or sets the LoadStepNumber.

Location

Gets or sets the Location.

LocationCoordinateSystem

Gets or sets the LocationCoordinateSystem.

LocationMethod

Gets or sets the LocationMethod.

LocationXCoordinate

Gets or sets the LocationXCoordinate.

LocationYCoordinate

Gets or sets the LocationYCoordinate.

LocationZCoordinate

Gets or sets the LocationZCoordinate.

Maximum

Gets the Maximum.

MaximumAmplitude

Gets the MaximumAmplitude.

MaximumFrequency

Gets or sets the MaximumFrequency.

Minimum

Gets the Minimum.

MinimumFrequency

Gets or sets the MinimumFrequency.

NormalOrientation

Gets or sets the NormalOrientation.

PhaseAngle

Gets the PhaseAngle.

Properties

Gets the list of properties for this object.

RealAtMaximumAmplitude

Gets the RealAtMaximumAmplitude.

ReportedFrequency

Gets the ReportedFrequency.

RequestedFrequency

Gets or sets the RequestedFrequency.

ResultChartType

Gets the ResultChartType.

SectorNumber

Gets or sets the SectorNumber.

ShearOrientation

Gets or sets the ShearOrientation.

SpatialResolution

Gets or sets the SpatialResolution.

Spring

Gets or sets the Spring.

StressStrainType

Gets or sets the StressStrainType.

Suppressed

Gets or sets the Suppressed.

TimeHistoryDisplay

Gets or sets the TimeHistoryDisplay.

UseParentFrequencyRange

Gets or sets the UseParentFrequencyRange.

VelocityType

Gets or sets the VelocityType.

VisibleProperties

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

XAxisValues

Gets or sets the XAxisValues.

Property detail#

property PositionTracker.AccelerationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the AccelerationType.

property PositionTracker.BoundaryCondition: Ansys.ACT.Automation.Mechanical.BoundaryConditions.GenericBoundaryCondition | None#

Gets or sets the BoundaryCondition.

property PositionTracker.ChartDimensions: Ansys.Mechanical.DataModel.Enums.ChartDimensions | None#

Gets or sets the Chart Dimensions

property PositionTracker.ChartViewingStyle: Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None#

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

property PositionTracker.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the CoordinateSystem.

property PositionTracker.CurvesAppearanceDisplay: Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None#

Gets or sets the CurvesAppearanceDisplay.

property PositionTracker.CutFrequency: float | None#

Gets or sets the CutFrequency.

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

Gets the current DataModelObject's category.

property PositionTracker.DeformationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

property PositionTracker.Duration: Ansys.Core.Units.Quantity | None#

Gets or sets the Duration.

property PositionTracker.EnhancedTracking: bool | None#

Gets the EnhancedTracking.

property PositionTracker.FilterMaximum: Ansys.Core.Units.Quantity | None#

Gets the FilterMaximum.

property PositionTracker.FilterMinimum: Ansys.Core.Units.Quantity | None#

Gets the FilterMinimum.

property PositionTracker.FilterType: Ansys.Mechanical.DataModel.Enums.FilterType | None#

Gets or sets the FilterType.

property PositionTracker.FrequencyAtMaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the FrequencyAtMaximumAmplitude.

property PositionTracker.GeometrySelectionString: str | None#

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

property PositionTracker.ImaginaryAtMaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the ImaginaryAtMaximumAmplitude.

property PositionTracker.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None#

Gets the internal object. For advanced usage only.

property PositionTracker.IsSolved: bool | None#

Gets the IsSolved.

property PositionTracker.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

property PositionTracker.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#

Gets or sets the Location.

property PositionTracker.LocationCoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#

Gets or sets the LocationCoordinateSystem.

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

Gets or sets the LocationMethod.

property PositionTracker.LocationXCoordinate: Ansys.Core.Units.Quantity | None#

Gets or sets the LocationXCoordinate.

property PositionTracker.LocationYCoordinate: Ansys.Core.Units.Quantity | None#

Gets or sets the LocationYCoordinate.

property PositionTracker.LocationZCoordinate: Ansys.Core.Units.Quantity | None#

Gets or sets the LocationZCoordinate.

property PositionTracker.Maximum: Ansys.Core.Units.Quantity | None#

Gets the Maximum.

property PositionTracker.MaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the MaximumAmplitude.

property PositionTracker.MaximumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MaximumFrequency.

property PositionTracker.Minimum: Ansys.Core.Units.Quantity | None#

Gets the Minimum.

property PositionTracker.MinimumFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the MinimumFrequency.

property PositionTracker.NormalOrientation: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None#

Gets or sets the NormalOrientation.

property PositionTracker.PhaseAngle: Ansys.Core.Units.Quantity | None#

Gets the PhaseAngle.

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

Gets the list of properties for this object.

property PositionTracker.RealAtMaximumAmplitude: Ansys.Core.Units.Quantity | None#

Gets the RealAtMaximumAmplitude.

property PositionTracker.ReportedFrequency: Ansys.Core.Units.Quantity | None#

Gets the ReportedFrequency.

property PositionTracker.RequestedFrequency: Ansys.Core.Units.Quantity | None#

Gets or sets the RequestedFrequency.

property PositionTracker.ResultChartType: Ansys.Mechanical.DataModel.Enums.ChartResultType | None#

Gets the ResultChartType.

property PositionTracker.SectorNumber: int | None#

Gets or sets the SectorNumber.

property PositionTracker.ShearOrientation: Ansys.Mechanical.DataModel.Enums.ShearOrientationType | None#

Gets or sets the ShearOrientation.

property PositionTracker.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None#

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

property PositionTracker.StressStrainType: Ansys.Mechanical.DataModel.Enums.StressStrainType | None#

Gets or sets the StressStrainType.

property PositionTracker.Suppressed: bool | None#

Gets or sets the Suppressed.

property PositionTracker.TimeHistoryDisplay: Ansys.Mechanical.DataModel.Enums.TimeHistoryDisplayType | None#

Gets or sets the TimeHistoryDisplay.

property PositionTracker.UseParentFrequencyRange: bool | None#

Gets or sets the UseParentFrequencyRange.

property PositionTracker.VelocityType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the VelocityType.

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

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

property PositionTracker.XAxisValues: Ansys.Mechanical.DataModel.Enums.XAxisValues | None#

Gets or sets the XAxisValues.

Method detail#

PositionTracker.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

PositionTracker.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

PositionTracker.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

PositionTracker.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

PositionTracker.RemoveParameter(propName: str) None#

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

PositionTracker.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.