ImpedanceProbe
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.ProbeResults.ImpedanceProbe#
Bases:
object
Defines a ImpedanceProbe.
Overview#
|
Run the ExportAnimation action. |
|
Run the ClearGeneratedData action. |
|
Run the DuplicateWithoutResults action. |
|
Run the EvaluateAllResults action. |
|
Snap the coordinates of probe result to the mesh nodes. |
|
Run the RenameBasedOnDefinition action. |
|
Run the Delete action. |
|
Gets the list of children, filtered by type. |
|
Gets the list of children, filtered by type. |
|
Creates a new child Comment. |
|
Creates a new child Figure. |
|
Creates a new child Image. |
|
Activate the current object. |
|
Copies all visible properties from this object to another. |
|
Creates a copy of the current DataModelObject. |
|
Run the GroupAllSimilarChildren action. |
|
Run the GroupSimilarObjects action. |
|
Get a property by its unique name. |
|
Get a property by its API name. |
|
Creates a new parameter for a Property. |
|
Gets the parameter corresponding to the given property. |
|
Removes the parameter from the parameter set corresponding to the given property. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the SetNumber. |
|
Gets the ReportedFrequency. |
|
Gets the ImpedanceReal. |
|
Gets or sets the Frequency. |
|
Gets the ImpedanceImag. |
|
Gets the MaximumRealImpedance. |
|
Gets the MaximumImagImpedance. |
|
Gets the MinimumRealImpedance. |
|
Gets the MinimumImagImpedance. |
|
Gets or sets the SweepingPhase. |
|
Gets or sets the By. |
|
Gets the current DataModelObject’s category. |
|
Gets or sets the Summation. |
|
Gets or sets the LocationMethod. |
|
Gets or sets the GeometryLocation. |
|
Gets or sets the CoordinateSystemSelection. |
|
Gets or sets the BoundaryConditionSelection. In order to select the option ‘WeakSprings’, please use the property ‘LocationMethod = LocationDefinitionMethod.WeakSprings’. |
|
Gets or sets the ContactRegionSelection. |
|
Gets or sets the RemotePointSelection. |
|
Gets or sets the BeamSelection. |
|
Gets or sets the MeshConnectionSelection. |
|
Gets or sets the MeshConnectionSelection. |
|
Gets or sets the SpringSelection. |
|
Gets the IsSolved. |
|
Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System. |
|
Gets the IterationNumber. |
|
Gets the LoadStep. |
|
Gets or sets the LoadStepNumber. |
|
Gets the Substep. |
|
Gets or sets the DisplayTime. |
|
Gets the MaximumTotal. |
|
Gets the MaximumXAxis. |
|
Gets the MaximumYAxis. |
|
Gets the MaximumZAxis. |
|
Gets the MinimumTotal. |
|
Gets the MinimumXAxis. |
|
Gets the MinimumYAxis. |
|
Gets the MinimumZAxis. |
|
Gets the Time. |
|
Gets the Total. |
|
Gets the XAxis. |
|
Gets the YAxis. |
|
Gets the ZAxis. |
|
Gets or sets the ResultSelection. |
|
Gets or sets the SpatialResolution. |
|
Gets the Type. |
|
Gets or sets the DpfEvaluation. |
|
Gets or sets the Suppressed. |
|
Gets the list of children. |
|
Gets the list of associated comments. |
|
Gets the list of associated figures. |
|
Gets the list of associated images. |
|
Gets the internal object. For advanced usage only. |
|
Gets the list of properties for this object. |
|
Gets the list of properties that are visible for this object. |
Property detail#
- property ImpedanceProbe.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSProbeResultAuto | None
Gets the internal object. For advanced usage only.
- property ImpedanceProbe.SetNumber: System.UInt32 | None
Gets or sets the SetNumber.
- property ImpedanceProbe.ReportedFrequency: Ansys.Core.Units.Quantity | None
Gets the ReportedFrequency.
- property ImpedanceProbe.ImpedanceReal: Ansys.Core.Units.Quantity | None
Gets the ImpedanceReal.
- property ImpedanceProbe.Frequency: Ansys.Core.Units.Quantity | None
Gets or sets the Frequency.
- property ImpedanceProbe.ImpedanceImag: Ansys.Core.Units.Quantity | None
Gets the ImpedanceImag.
- property ImpedanceProbe.MaximumRealImpedance: Ansys.Core.Units.Quantity | None
Gets the MaximumRealImpedance.
- property ImpedanceProbe.MaximumImagImpedance: Ansys.Core.Units.Quantity | None
Gets the MaximumImagImpedance.
- property ImpedanceProbe.MinimumRealImpedance: Ansys.Core.Units.Quantity | None
Gets the MinimumRealImpedance.
- property ImpedanceProbe.MinimumImagImpedance: Ansys.Core.Units.Quantity | None
Gets the MinimumImagImpedance.
- property ImpedanceProbe.SweepingPhase: Ansys.Core.Units.Quantity | None
Gets or sets the SweepingPhase.
- property ImpedanceProbe.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None
Gets or sets the By.
- property ImpedanceProbe.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
- property ImpedanceProbe.Summation: Ansys.Mechanical.DataModel.Enums.MomentsAtSummationPointType | None
Gets or sets the Summation.
- property ImpedanceProbe.LocationMethod: Ansys.Mechanical.DataModel.Enums.LocationDefinitionMethod | None
Gets or sets the LocationMethod.
- property ImpedanceProbe.GeometryLocation: Ansys.ACT.Interfaces.Common.ISelectionInfo | None
Gets or sets the GeometryLocation.
- property ImpedanceProbe.CoordinateSystemSelection: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the CoordinateSystemSelection.
- property ImpedanceProbe.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 ImpedanceProbe.ContactRegionSelection: Ansys.ACT.Automation.Mechanical.Connections.ContactRegion | None
Gets or sets the ContactRegionSelection.
- property ImpedanceProbe.RemotePointSelection: Ansys.ACT.Automation.Mechanical.RemotePoint | None
Gets or sets the RemotePointSelection.
- property ImpedanceProbe.BeamSelection: Ansys.ACT.Automation.Mechanical.Connections.Beam | None
Gets or sets the BeamSelection.
- property ImpedanceProbe.MeshConnectionSelection: Ansys.ACT.Automation.Mechanical.MeshConnection | None
Gets or sets the MeshConnectionSelection.
- property ImpedanceProbe.SurfaceSelection: Ansys.ACT.Automation.Mechanical.Surface | None
Gets or sets the MeshConnectionSelection.
- property ImpedanceProbe.SpringSelection: Ansys.ACT.Automation.Mechanical.Connections.Spring | None
Gets or sets the SpringSelection.
- property ImpedanceProbe.IsSolved: System.Boolean | None
Gets the IsSolved.
- property ImpedanceProbe.Orientation: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None
Gets or sets the Orientation. Accepts/Returns None if it is the Solution Coordinate System.
- property ImpedanceProbe.IterationNumber: System.Int32 | None
Gets the IterationNumber.
- property ImpedanceProbe.LoadStep: System.Int32 | None
Gets the LoadStep.
- property ImpedanceProbe.LoadStepNumber: System.UInt32 | None
Gets or sets the LoadStepNumber.
- property ImpedanceProbe.Substep: System.Int32 | None
Gets the Substep.
- property ImpedanceProbe.DisplayTime: Ansys.Core.Units.Quantity | None
Gets or sets the DisplayTime.
- property ImpedanceProbe.MaximumTotal: Ansys.Core.Units.Quantity | None
Gets the MaximumTotal.
- property ImpedanceProbe.MaximumXAxis: Ansys.Core.Units.Quantity | None
Gets the MaximumXAxis.
- property ImpedanceProbe.MaximumYAxis: Ansys.Core.Units.Quantity | None
Gets the MaximumYAxis.
- property ImpedanceProbe.MaximumZAxis: Ansys.Core.Units.Quantity | None
Gets the MaximumZAxis.
- property ImpedanceProbe.MinimumTotal: Ansys.Core.Units.Quantity | None
Gets the MinimumTotal.
- property ImpedanceProbe.MinimumXAxis: Ansys.Core.Units.Quantity | None
Gets the MinimumXAxis.
- property ImpedanceProbe.MinimumYAxis: Ansys.Core.Units.Quantity | None
Gets the MinimumYAxis.
- property ImpedanceProbe.MinimumZAxis: Ansys.Core.Units.Quantity | None
Gets the MinimumZAxis.
- property ImpedanceProbe.Time: Ansys.Core.Units.Quantity | None
Gets the Time.
- property ImpedanceProbe.Total: Ansys.Core.Units.Quantity | None
Gets the Total.
- property ImpedanceProbe.XAxis: Ansys.Core.Units.Quantity | None
Gets the XAxis.
- property ImpedanceProbe.YAxis: Ansys.Core.Units.Quantity | None
Gets the YAxis.
- property ImpedanceProbe.ZAxis: Ansys.Core.Units.Quantity | None
Gets the ZAxis.
- property ImpedanceProbe.ResultSelection: Ansys.Mechanical.DataModel.Enums.ProbeDisplayFilter | None
Gets or sets the ResultSelection.
- property ImpedanceProbe.SpatialResolution: Ansys.Mechanical.DataModel.Enums.MinimumOrMaximum | None
Gets or sets the SpatialResolution.
- property ImpedanceProbe.Type: Ansys.Mechanical.DataModel.Enums.ProbeResultType | None
Gets the Type.
- property ImpedanceProbe.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None
Gets or sets the DpfEvaluation.
- property ImpedanceProbe.Suppressed: System.Boolean | None
Gets or sets the Suppressed.
- property ImpedanceProbe.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None
Gets the list of children.
- property ImpedanceProbe.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None
Gets the list of associated comments.
- property ImpedanceProbe.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None
Gets the list of associated figures.
- property ImpedanceProbe.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None
Gets the list of associated images.
- property ImpedanceProbe.InternalObject: System.Object | None
Gets the internal object. For advanced usage only.
- property ImpedanceProbe.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
- property ImpedanceProbe.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail#
- ImpedanceProbe.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) System.Void
Run the ExportAnimation action.
- ImpedanceProbe.ClearGeneratedData() System.Void
Run the ClearGeneratedData action.
- ImpedanceProbe.DuplicateWithoutResults() Ansys.ACT.Automation.Mechanical.DataModelObject
Run the DuplicateWithoutResults action.
- ImpedanceProbe.EvaluateAllResults() System.Void
Run the EvaluateAllResults action.
- ImpedanceProbe.SnapToMeshNodes() System.Void
Snap the coordinates of probe result to the mesh nodes.
- ImpedanceProbe.RenameBasedOnDefinition() System.Void
Run the RenameBasedOnDefinition action.
- ImpedanceProbe.Delete() System.Void
Run the Delete action.
- ImpedanceProbe.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) System.Collections.Generic.IList[ChildrenType]
Gets the list of children, filtered by type.
- ImpedanceProbe.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.
- ImpedanceProbe.AddComment() Ansys.ACT.Automation.Mechanical.Comment
Creates a new child Comment.
- ImpedanceProbe.AddFigure() Ansys.ACT.Automation.Mechanical.Figure
Creates a new child Figure.
- ImpedanceProbe.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.
- ImpedanceProbe.Activate() System.Void
Activate the current object.
- ImpedanceProbe.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) System.Void
Copies all visible properties from this object to another.
- ImpedanceProbe.Duplicate() Ansys.Mechanical.DataModel.Interfaces.IDataModelObject
Creates a copy of the current DataModelObject.
- ImpedanceProbe.GroupAllSimilarChildren() System.Void
Run the GroupAllSimilarChildren action.
- ImpedanceProbe.GroupSimilarObjects() Ansys.ACT.Automation.Mechanical.TreeGroupingFolder
Run the GroupSimilarObjects action.
- ImpedanceProbe.PropertyByName(name: System.String) Ansys.ACT.Automation.Mechanical.Property
Get a property by its unique name.
- ImpedanceProbe.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.
- ImpedanceProbe.CreateParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Creates a new parameter for a Property.
- ImpedanceProbe.GetParameter(propName: System.String) Ansys.ACT.Interfaces.Mechanical.IParameter
Gets the parameter corresponding to the given property.
- ImpedanceProbe.RemoveParameter(propName: System.String) System.Void
Removes the parameter from the parameter set corresponding to the given property.