AcousticSPLFrequencyResponse#

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.FrequencyResponseResults.AcousticSPLFrequencyResponse#

Bases: object

Defines a AcousticSPLFrequencyResponse.

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.

ExportToWAVFile

Run the ExportToWAVFile action.

ExportToXMLFile

Run the ExportToXMLFile 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.

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 AcousticSPLFrequencyResponse.AccelerationType: Ansys.Mechanical.DataModel.Enums.TotalOrDirectional | None#

Gets or sets the AccelerationType.

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

Gets or sets the BoundaryCondition.

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

Gets or sets the Chart Dimensions

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

Gets or sets the ChartViewingStyle.

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

Gets the list of children.

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

Gets the list of associated comments.

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

Gets or sets the CoordinateSystem.

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

Gets or sets the CurvesAppearanceDisplay.

property AcousticSPLFrequencyResponse.CutFrequency: float | None#

Gets or sets the CutFrequency.

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

Gets the current DataModelObject's category.

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

Gets or sets the DeformationType.

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

Gets or sets the DpfEvaluation.

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

Gets or sets the Duration.

property AcousticSPLFrequencyResponse.EnhancedTracking: bool | None#

Gets the EnhancedTracking.

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

Gets the FilterMaximum.

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

Gets the FilterMinimum.

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

Gets or sets the FilterType.

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

Gets the FrequencyAtMaximumAmplitude.

property AcousticSPLFrequencyResponse.GeometrySelectionString: str | None#

Gets or sets the GeometrySelectionString.

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

Gets the list of associated images.

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

Gets the ImaginaryAtMaximumAmplitude.

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

Gets the internal object. For advanced usage only.

property AcousticSPLFrequencyResponse.IsSolved: bool | None#

Gets the IsSolved.

property AcousticSPLFrequencyResponse.LoadStepNumber: int | None#

Gets or sets the LoadStepNumber.

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

Gets or sets the Location.

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

Gets the Maximum.

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

Gets the MaximumAmplitude.

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

Gets or sets the MaximumFrequency.

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

Gets the Minimum.

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

Gets or sets the MinimumFrequency.

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

Gets or sets the NormalOrientation.

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

Gets the PhaseAngle.

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

Gets the list of properties for this object.

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

Gets the RealAtMaximumAmplitude.

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

Gets the ReportedFrequency.

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

Gets or sets the RequestedFrequency.

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

Gets the ResultChartType.

property AcousticSPLFrequencyResponse.SectorNumber: int | None#

Gets or sets the SectorNumber.

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

Gets or sets the ShearOrientation.

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

Gets or sets the SpatialResolution.

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

Gets or sets the Spring.

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

Gets or sets the StressStrainType.

property AcousticSPLFrequencyResponse.Suppressed: bool | None#

Gets or sets the Suppressed.

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

Gets or sets the TimeHistoryDisplay.

property AcousticSPLFrequencyResponse.UseParentFrequencyRange: bool | None#

Gets or sets the UseParentFrequencyRange.

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

Gets or sets the VelocityType.

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

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

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

Gets or sets the XAxisValues.

Method detail#

AcousticSPLFrequencyResponse.Activate() None#

Activate the current object.

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

Creates a new child Comment.

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

Run the ClearGeneratedData action.

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

Copies all visible properties from this object to another.

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

Creates a new parameter for a Property.

AcousticSPLFrequencyResponse.Delete() None#

Run the Delete action.

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

Creates a copy of the current DataModelObject.

AcousticSPLFrequencyResponse.EvaluateAllResults() None#

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

AcousticSPLFrequencyResponse.ExportToWAVFile(filePath: str) None#

Run the ExportToWAVFile action.

AcousticSPLFrequencyResponse.ExportToXMLFile(filePath: str) None#

Run the ExportToXMLFile action.

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

Gets the list of children, filtered by type.

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

Gets the parameter corresponding to the given property.

AcousticSPLFrequencyResponse.GroupAllSimilarChildren() None#

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

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

Get a property by its unique name.

AcousticSPLFrequencyResponse.RemoveParameter(propName: str) None#

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

AcousticSPLFrequencyResponse.RenameBasedOnDefinition() None#

Run the RenameBasedOnDefinition action.