`MCFWaterfallDiagram`#

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

Bases: object

Defines a MCFWaterfallDiagram.

Overview#

Methods

`Activate`	Activate the current object.
`AddAlert`	Creates a new Alert
`AddComment`	Creates a new child Comment.
`AddConvergence`	Creates a new Convergence
`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`	CreateParameter method.
`CreateResultsAtAllSets`	Creates results at all sets for results under a solution.
`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.
`ExportToTextFile`	Run the ExportToTextFile action.
`FetchRemoteResults`	Run the FetchRemoteResult 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.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection 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.

Properties

`Average`	Gets the Average.
`By`	Gets or sets the By.
`CalculateTimeHistory`	Gets or sets the CalculateTimeHistory.
`Children`	Gets the list of children.
`CombinationNumber`	Gets or sets the Combination Number for a Solution Combination result.
`Comments`	Gets the list of associated comments.
`CoordinateSystem`	Gets or sets the Coordinate System.
`CrackFrontNumber`	Gets or sets the CrackFrontNumber.
`DataModelObjectCategory`	Gets the current DataModelObject's category.
`DisplayOption`	Gets or sets the DisplayOption.
`DisplayTime`	Gets or sets the DisplayTime.
`DpfEvaluation`	Gets or sets the DpfEvaluation.
`Figures`	Gets the list of associated figures.
`GlobalIDs`	Gets or sets the GlobalIDs.
`GraphControlsXAxis`	Gets or sets the GraphControlsXAxis.
`Identifier`	Gets or sets the Identifier.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`IsSolved`	Gets the IsSolved.
`ItemType`	Gets or sets the ItemType.
`IterationNumber`	Gets the IterationNumber.
`LoadStep`	Gets the LoadStep.
`LoadStepForMaximumOfMaximumValues`	Get the Load Step for the maximum of maximum values.
`LoadStepForMaximumOfMinimumValues`	Get the Load Step for the maximum of minimum values.
`LoadStepForMinimumOfMaximumValues`	Get the Load Step for the minimum of maximum values.
`LoadStepForMinimumOfMinimumValues`	Get the Load Step for the minimum of minimum values.
`LoadStepNumber`	Gets or sets the LoadStepNumber.
`Location`	Gets or sets the Location.
`Maximum`	Gets the Maximum.
`MaximumOccursOn`	Gets the MaximumOccursOn.
`MaximumOfMaximumOverTime`	Gets the MaximumOfMaximumOverTime.
`MaximumOfMinimumOverTime`	Gets the MaximumOfMinimumOverTime.
`Minimum`	Gets the Minimum.
`MinimumOccursOn`	Gets the MinimumOccursOn.
`MinimumOfMaximumOverTime`	Gets the MinimumOfMaximumOverTime.
`MinimumOfMinimumOverTime`	Gets the MinimumOfMinimumOverTime.
`NamedSelections`	Gets or sets the NamedSelections.
`Path`	Path property.
`PlotData`	Gets the result table.
`Properties`	Gets the list of properties for this object.
`ScopingMethod`	Gets or sets the ScopingMethod.
`SetNumber`	Gets or sets the Set Number.
`SolutionCombinationDriver`	Gets or sets the SolutionCombinationDriver.
`SolverComponentIDs`	Gets or sets the SolverComponentIDs.
`Substep`	Gets the Substep.
`Suppressed`	Gets or sets the Suppressed.
`Surface`	Surface property.
`SurfaceCoating`	SurfaceCoating property.
`Time`	Gets the Time.
`TimeForMaximumOfMaximumValues`	Get the Time for the maximum of maximum values.
`TimeForMaximumOfMinimumValues`	Get the Time for the maximum of minimum values.
`TimeForMinimumOfMaximumValues`	Get the Time for the minimum of maximum values.
`TimeForMinimumOfMinimumValues`	Get the Time for the minimum of minimum values.
`VisibleProperties`	Gets the list of properties that are visible for this object.
`WaterfallShowTextOnMosaic`	Gets or sets the Waterfall Mosaic Text Property.

Property detail#

property MCFWaterfallDiagram.Average: Ansys.Core.Units.Quantity | None#: Gets the Average.

property MCFWaterfallDiagram.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None#: Gets or sets the By.

property MCFWaterfallDiagram.CalculateTimeHistory: bool | None#: Gets or sets the CalculateTimeHistory.

property MCFWaterfallDiagram.Children: List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets the list of children.

property MCFWaterfallDiagram.CombinationNumber: int | None#: Gets or sets the Combination Number for a Solution Combination result.

property MCFWaterfallDiagram.Comments: Iterable[Ansys.ACT.Automation.Mechanical.Comment] | None#: Gets the list of associated comments.

property MCFWaterfallDiagram.CoordinateSystem: Ansys.ACT.Automation.Mechanical.CoordinateSystem | None#: Gets or sets the Coordinate System. Accepts/Returns None for Solution Coordinate System in the general case (if applicable). Accepts/Returns None for Fiber Coordinate System for a result that is sub scoped by ply.

property MCFWaterfallDiagram.CrackFrontNumber: int | None#: Gets or sets the CrackFrontNumber.

property MCFWaterfallDiagram.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None#: Gets the current DataModelObject's category.

property MCFWaterfallDiagram.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None#: Gets or sets the DisplayOption.

property MCFWaterfallDiagram.DisplayTime: Ansys.Core.Units.Quantity | None#: Gets or sets the DisplayTime.

property MCFWaterfallDiagram.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None#: Gets or sets the DpfEvaluation.

property MCFWaterfallDiagram.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None#: Gets the list of associated figures.

property MCFWaterfallDiagram.GlobalIDs: str | None#: Gets or sets the GlobalIDs.

property MCFWaterfallDiagram.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None#: Gets or sets the GraphControlsXAxis.

property MCFWaterfallDiagram.Identifier: str | None#: Gets or sets the Identifier.

property MCFWaterfallDiagram.Images: Iterable[Ansys.ACT.Automation.Mechanical.Image] | None#: Gets the list of associated images.

property MCFWaterfallDiagram.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None#: Gets the internal object. For advanced usage only.

property MCFWaterfallDiagram.IsSolved: bool | None#: Gets the IsSolved.

property MCFWaterfallDiagram.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None#: Gets or sets the ItemType.

property MCFWaterfallDiagram.IterationNumber: int | None#: Gets the IterationNumber.

property MCFWaterfallDiagram.LoadStep: int | None#: Gets the LoadStep.

property MCFWaterfallDiagram.LoadStepForMaximumOfMaximumValues: int | None#: Get the Load Step for the maximum of maximum values.

property MCFWaterfallDiagram.LoadStepForMaximumOfMinimumValues: int | None#: Get the Load Step for the maximum of minimum values.

property MCFWaterfallDiagram.LoadStepForMinimumOfMaximumValues: int | None#: Get the Load Step for the minimum of maximum values.

property MCFWaterfallDiagram.LoadStepForMinimumOfMinimumValues: int | None#: Get the Load Step for the minimum of minimum values.

property MCFWaterfallDiagram.LoadStepNumber: int | None#: Gets or sets the LoadStepNumber.

property MCFWaterfallDiagram.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None#: Gets or sets the Location.

property MCFWaterfallDiagram.Maximum: Ansys.Core.Units.Quantity | None#: Gets the Maximum.

property MCFWaterfallDiagram.MaximumOccursOn: str | None#: Gets the MaximumOccursOn.

property MCFWaterfallDiagram.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#: Gets the MaximumOfMaximumOverTime.

property MCFWaterfallDiagram.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#: Gets the MaximumOfMinimumOverTime.

property MCFWaterfallDiagram.Minimum: Ansys.Core.Units.Quantity | None#: Gets the Minimum.

property MCFWaterfallDiagram.MinimumOccursOn: str | None#: Gets the MinimumOccursOn.

property MCFWaterfallDiagram.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None#: Gets the MinimumOfMaximumOverTime.

property MCFWaterfallDiagram.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None#: Gets the MinimumOfMinimumOverTime.

property MCFWaterfallDiagram.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None#: Gets or sets the NamedSelections.

property MCFWaterfallDiagram.Path: Ansys.ACT.Automation.Mechanical.Path | None#: Path property.

property MCFWaterfallDiagram.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None#: Gets the result table.

property MCFWaterfallDiagram.Properties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties for this object.

property MCFWaterfallDiagram.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None#: Gets or sets the ScopingMethod.

property MCFWaterfallDiagram.SetNumber: int | None#: Gets or sets the Set Number.

property MCFWaterfallDiagram.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None#: Gets or sets the SolutionCombinationDriver.

property MCFWaterfallDiagram.SolverComponentIDs: str | None#: Gets or sets the SolverComponentIDs.

property MCFWaterfallDiagram.Substep: int | None#: Gets the Substep.

property MCFWaterfallDiagram.Suppressed: bool | None#: Gets or sets the Suppressed.

property MCFWaterfallDiagram.Surface: Ansys.ACT.Automation.Mechanical.Surface | None#: Surface property.

property MCFWaterfallDiagram.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None#: SurfaceCoating property.

property MCFWaterfallDiagram.Time: Ansys.Core.Units.Quantity | None#: Gets the Time.

property MCFWaterfallDiagram.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None#: Get the Time for the maximum of maximum values.

property MCFWaterfallDiagram.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None#: Get the Time for the maximum of minimum values.

property MCFWaterfallDiagram.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None#: Get the Time for the minimum of maximum values.

property MCFWaterfallDiagram.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None#: Get the Time for the minimum of minimum values.

property MCFWaterfallDiagram.VisibleProperties: tuple[Ansys.ACT.Automation.Mechanical.Property] | None#: Gets the list of properties that are visible for this object.

property MCFWaterfallDiagram.WaterfallShowTextOnMosaic: bool | None#: Gets or sets the Waterfall Mosaic Text Property.

Method detail#

MCFWaterfallDiagram.Activate() → None#: Activate the current object.

MCFWaterfallDiagram.AddAlert() → Ansys.ACT.Automation.Mechanical.Results.Alert#: Creates a new Alert

MCFWaterfallDiagram.AddComment() → Ansys.ACT.Automation.Mechanical.Comment#: Creates a new child Comment.

MCFWaterfallDiagram.AddConvergence() → Ansys.ACT.Automation.Mechanical.Results.Convergence#: Creates a new Convergence

MCFWaterfallDiagram.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure#: Creates a new child Figure.

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

MCFWaterfallDiagram.ClearGeneratedData() → None#: Run the ClearGeneratedData action.

MCFWaterfallDiagram.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None#: Copies all visible properties from this object to another.

MCFWaterfallDiagram.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: CreateParameter method.

MCFWaterfallDiagram.CreateResultsAtAllSets() → List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]#: Creates results at all sets for results under a solution.

MCFWaterfallDiagram.Delete() → None#: Run the Delete action.

MCFWaterfallDiagram.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Creates a copy of the current DataModelObject.

MCFWaterfallDiagram.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject#: Run the DuplicateWithoutResults action.

MCFWaterfallDiagram.EvaluateAllResults() → None#: Run the EvaluateAllResults action.

MCFWaterfallDiagram.ExportAnimation(filePath: str, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → None#: Run the ExportAnimation action.

MCFWaterfallDiagram.ExportToTextFile(filePath: str) → None#: Run the ExportToTextFile action.

MCFWaterfallDiagram.FetchRemoteResults() → None#: Run the FetchRemoteResult action.

MCFWaterfallDiagram.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]#: Gets the list of children, filtered by type.

MCFWaterfallDiagram.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter#: Gets the parameter corresponding to the given property.

MCFWaterfallDiagram.GroupAllSimilarChildren() → None#: Run the GroupAllSimilarChildren action.

MCFWaterfallDiagram.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder#: Run the GroupSimilarObjects action.

MCFWaterfallDiagram.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]#: Run the PromoteToNamedSelection action.

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

MCFWaterfallDiagram.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property#: Get a property by its unique name.

MCFWaterfallDiagram.RemoveParameter(propName: str) → None#: Removes the parameter from the parameter set corresponding to the given property.

MCFWaterfallDiagram.RenameBasedOnDefinition() → None#: Run the RenameBasedOnDefinition action.