ISPGCouplingTracker

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

Bases: object

Defines a ISPGCouplingTracker.

Overview

Methods

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.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Creates a copy of the current DataModelObject.
Equals	Equals method.
EvaluateAllResults	Run the EvaluateAllResults action.
ExportAnimation	Run the ExportAnimation action.
GetAPIName	Property name bound to dispId.
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.
GetQuantityName	GetQuantityName method.
GetQuantityNameFromType	GetQuantityNameFromType 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.
ToString	ToString method.

Properties

AccelerationType	Gets or sets the AccelerationType.
AttachedRefs	AttachedRefs property.
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.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Maximum	Gets the Maximum.
MaximumAmplitude	Gets the MaximumAmplitude.
MaximumFrequency	Gets or sets the MaximumFrequency.
Minimum	Gets the Minimum.
MinimumFrequency	Gets or sets the MinimumFrequency.
Name	Name property.
NamedSelections	Gets or sets the NamedSelections.
NormalOrientation	Gets or sets the NormalOrientation.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
PhaseAngle	Gets the PhaseAngle.
Properties	Gets the list of properties for this object.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
RealAtMaximumAmplitude	Gets the RealAtMaximumAmplitude.
ReportedFrequency	Gets the ReportedFrequency.
RequestedFrequency	Gets or sets the RequestedFrequency.
ResultChartType	Gets the ResultChartType.
RpmSetNumber	Gets or sets the RpmSetNumber.
SectorNumber	Gets or sets the SectorNumber.
ShearOrientation	Gets or sets the ShearOrientation.
SpatialResolution	Gets or sets the SpatialResolution.
Spring	Gets or sets the Spring.
State	State property.
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 ISPGCouplingTracker.AccelerationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the AccelerationType.

property ISPGCouplingTracker.AttachedRefs: List[int] | None

AttachedRefs property.

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

Gets or sets the BoundaryCondition.

property ISPGCouplingTracker.ChartDimensions: Ansys.Mechanical.DataModel.Enums.ChartDimensions | None

Gets or sets the Chart Dimensions

property ISPGCouplingTracker.ChartViewingStyle: Ansys.Mechanical.DataModel.Enums.ChartAxisScaleType | None

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

property ISPGCouplingTracker.ClsId: int | None

ClsId property.

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

Gets the list of associated comments.

property ISPGCouplingTracker.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None

Gets or sets the CoordinateSystem.

property ISPGCouplingTracker.CurvesAppearanceDisplay: Ansys.Mechanical.DataModel.Enums.ChartPlotStyle | None

Gets or sets the CurvesAppearanceDisplay.

property ISPGCouplingTracker.CutFrequency: float | None

Gets or sets the CutFrequency.

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

Gets the current DataModelObject's category.

property ISPGCouplingTracker.DeformationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

property ISPGCouplingTracker.Duration: Ansys.Core.Units.Quantity | None

Gets or sets the Duration.

property ISPGCouplingTracker.EnhancedTracking: bool | None

Gets the EnhancedTracking.

property ISPGCouplingTracker.FilterMaximum: Ansys.Core.Units.Quantity | None

Gets the FilterMaximum.

property ISPGCouplingTracker.FilterMinimum: Ansys.Core.Units.Quantity | None

Gets the FilterMinimum.

property ISPGCouplingTracker.FilterType: Ansys.Mechanical.DataModel.Enums.FilterType | None

Gets or sets the FilterType.

property ISPGCouplingTracker.FrequencyAtMaximumAmplitude: Ansys.Core.Units.Quantity | None

Gets the FrequencyAtMaximumAmplitude.

property ISPGCouplingTracker.GeometrySelectionString: str | None

Gets or sets the GeometrySelectionString.

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

GroupingFolder property.

property ISPGCouplingTracker.IconName: str | None

IconName property.

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

Gets the list of associated images.

property ISPGCouplingTracker.ImaginaryAtMaximumAmplitude: Ansys.Core.Units.Quantity | None

Gets the ImaginaryAtMaximumAmplitude.

property ISPGCouplingTracker.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto | None

Gets the internal object. For advanced usage only.

property ISPGCouplingTracker.IsSolved: bool | None

Gets the IsSolved.

property ISPGCouplingTracker.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

property ISPGCouplingTracker.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property ISPGCouplingTracker.Maximum: Ansys.Core.Units.Quantity | None

Gets the Maximum.

property ISPGCouplingTracker.MaximumAmplitude: Ansys.Core.Units.Quantity | None

Gets the MaximumAmplitude.

property ISPGCouplingTracker.MaximumFrequency: Ansys.Core.Units.Quantity | None

Gets or sets the MaximumFrequency.

property ISPGCouplingTracker.Minimum: Ansys.Core.Units.Quantity | None

Gets the Minimum.

property ISPGCouplingTracker.MinimumFrequency: Ansys.Core.Units.Quantity | None

Gets or sets the MinimumFrequency.

property ISPGCouplingTracker.Name: str | None

Name property.

property ISPGCouplingTracker.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets or sets the NamedSelections.

property ISPGCouplingTracker.NormalOrientation: Ansys.Mechanical.DataModel.Enums.NormalOrientationType | None

Gets or sets the NormalOrientation.

property ISPGCouplingTracker.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

property ISPGCouplingTracker.PhaseAngle: Ansys.Core.Units.Quantity | None

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

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

property ISPGCouplingTracker.RealAtMaximumAmplitude: Ansys.Core.Units.Quantity | None

Gets the RealAtMaximumAmplitude.

property ISPGCouplingTracker.ReportedFrequency: Ansys.Core.Units.Quantity | None

Gets the ReportedFrequency.

property ISPGCouplingTracker.RequestedFrequency: Ansys.Core.Units.Quantity | None

Gets or sets the RequestedFrequency.

property ISPGCouplingTracker.ResultChartType: Ansys.Mechanical.DataModel.Enums.ChartResultType | None

Gets the ResultChartType.

property ISPGCouplingTracker.RpmSetNumber: int | None

Gets or sets the RpmSetNumber.

property ISPGCouplingTracker.SectorNumber: int | None

Gets or sets the SectorNumber.

property ISPGCouplingTracker.ShearOrientation: Ansys.Mechanical.DataModel.Enums.ShearOrientationType | None

Gets or sets the ShearOrientation.

property ISPGCouplingTracker.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MultipleNodeType | None

Gets or sets the SpatialResolution.

property ISPGCouplingTracker.Spring: Ansys.ACT.Automation.Mechanical.Connections.Spring | None

Gets or sets the Spring.

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

State property.

property ISPGCouplingTracker.StressStrainType: Ansys.Mechanical.DataModel.Enums.StressStrainType | None

Gets or sets the StressStrainType.

property ISPGCouplingTracker.Suppressed: bool | None

Gets or sets the Suppressed.

property ISPGCouplingTracker.TimeHistoryDisplay: Ansys.Mechanical.DataModel.Enums.TimeHistoryDisplayType | None

Gets or sets the TimeHistoryDisplay.

property ISPGCouplingTracker.UseParentFrequencyRange: bool | None

Gets or sets the UseParentFrequencyRange.

property ISPGCouplingTracker.VelocityType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None

Gets or sets the VelocityType.

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

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

property ISPGCouplingTracker.XAxisValues: Ansys.Mechanical.DataModel.Enums.XAxisValues | None

Gets or sets the XAxisValues.

Method detail

ISPGCouplingTracker.Activate() → None

Activate the current object.

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

Creates a new child Comment.

ISPGCouplingTracker.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.

ISPGCouplingTracker.ClearGeneratedData() → None

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

ISPGCouplingTracker.Delete() → None

Run the Delete action.

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

Creates a copy of the current DataModelObject.

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

Equals method.

ISPGCouplingTracker.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

ISPGCouplingTracker.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

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

GetDetailsView method.

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

Enum name bound to value

ISPGCouplingTracker.GetHashCode() → int

GetHashCode method.

ISPGCouplingTracker.GetIconFile() → System.Byte

GetIconFile method.

ISPGCouplingTracker.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

ISPGCouplingTracker.GetPath() → str

GetPath method.

ISPGCouplingTracker.GetPropertyName(dispId: int) → str

GetPropertyName method.

ISPGCouplingTracker.GetPropertyValue(name: str) → Any

GetPropertyValue method.

ISPGCouplingTracker.GetQuantityName(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto) → str

GetQuantityName method.

ISPGCouplingTracker.GetQuantityNameFromType(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultChartAuto) → str

GetQuantityNameFromType method.

ISPGCouplingTracker.GetType() → type

GetType method.

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

GetVisibleProperties method.

ISPGCouplingTracker.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

ISPGCouplingTracker.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

ISPGCouplingTracker.InitializeLifetimeService() → Any

InitializeLifetimeService method.

ISPGCouplingTracker.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

ISPGCouplingTracker.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

ISPGCouplingTracker.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.

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

PropertyById method.

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

Get a property by its unique name.

ISPGCouplingTracker.RemoveParameter(propName: str) → None

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

ISPGCouplingTracker.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

ISPGCouplingTracker.ToString() → str

ToString method.