`UserDefinedResult`#

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

Bases: object

Defines a UserDefinedResult.

Overview#

Methods

`ClearGeneratedData`	Run the ClearGeneratedData action.
`FetchRemoteResults`	Run the FetchRemoteResult action.
`ExportToTextFile`	Run the ExportToTextFile action.
`ExportAnimation`	Run the ExportAnimation action.
`DuplicateWithoutResults`	Run the DuplicateWithoutResults action.
`EvaluateAllResults`	Run the EvaluateAllResults action.
`PromoteToNamedSelection`	Run the PromoteToNamedSelection action.
`CreateResultsAtAllSets`	Creates results at all sets for results under a solution.
`RenameBasedOnDefinition`	Run the RenameBasedOnDefinition action.
`Delete`	Run the Delete action.
`GetChildren`	Gets the list of children, filtered by type.
`GetChildren`	Gets the list of children, filtered by type.
`AddComment`	Creates a new child Comment.
`AddFigure`	Creates a new child Figure.
`AddImage`	Creates a new child Image.
`Activate`	Activate the current object.
`CopyTo`	Copies all visible properties from this object to another.
`Duplicate`	Creates a copy of the current DataModelObject.
`GroupAllSimilarChildren`	Run the GroupAllSimilarChildren action.
`GroupSimilarObjects`	Run the GroupSimilarObjects action.
`PropertyByName`	Get a property by its unique name.
`PropertyByAPIName`	Get a property by its API name.
`CreateParameter`	Creates a new parameter for a Property.
`GetParameter`	Gets the parameter corresponding to the given property.
`RemoveParameter`	Removes the parameter from the parameter set corresponding to the given property.

Properties

`PlotData`	Gets the result table.
`Mode`	Gets or sets the Mode (Result Set Number).
`CoordinateSystem`	Gets or sets the Coordinate System.
`Ply`	Gets or sets the Ply selection.
`Plies`	Plies property.
`IsSolved`	Gets the IsSolved.
`Location`	Gets or sets the Location.
`ScopingMethod`	Gets or sets the ScopingMethod.
`ScaleFactorValue`	Gets or sets the ScaleFactorValue.
`OutputUnit`	Gets or sets the OutputUnit.
`SetNumber`	Gets or sets the Set Number.
`CombinationNumber`	Gets or sets the Combination Number for a Solution Combination result.
`SolutionCombinationDriver`	Gets or sets the SolutionCombinationDriver.
`InternalObject`	Gets the internal object. For advanced usage only.
`CyclicMode`	Gets or sets the CyclicMode.
`Expression`	Gets or sets the Expression.
`GlobalIDs`	Gets or sets the GlobalIDs.
`Identifier`	Gets or sets the Identifier.
`IterationNumber`	Gets the IterationNumber.
`Layer`	Gets or sets the Layer.
`LoadMultiplier`	Gets the LoadMultiplier.
`LoadStep`	Gets the LoadStep.
`MaximumOccursOn`	Gets the MaximumOccursOn.
`MinimumOccursOn`	Gets the MinimumOccursOn.
`LoadStepNumber`	Gets or sets the LoadStepNumber.
`SolverComponentIDs`	Gets or sets the SolverComponentIDs.
`Substep`	Gets the Substep.
`Type`	Gets the Type.
`ReportedFrequency`	Gets the ReportedFrequency.
`Average`	Gets the Average.
`DisplayTime`	Gets or sets the DisplayTime.
`Maximum`	Gets the Maximum.
`MaximumOfMaximumOverTime`	Gets the MaximumOfMaximumOverTime.
`MaximumOfMinimumOverTime`	Gets the MaximumOfMinimumOverTime.
`Minimum`	Gets the Minimum.
`MinimumOfMaximumOverTime`	Gets the MinimumOfMaximumOverTime.
`MinimumOfMinimumOverTime`	Gets the MinimumOfMinimumOverTime.
`SweepingPhase`	Gets or sets the SweepingPhase.
`PhaseIncrement`	Gets or sets the PhaseIncrement.
`RequestedFrequency`	Gets or sets the RequestedFrequency.
`Time`	Gets the Time.
`GraphControlsXAxis`	Gets or sets the GraphControlsXAxis.
`ResponseType`	Gets or sets the ResponseType.
`DisplayOption`	Gets or sets the DisplayOption.
`ScaleFactor`	Gets or sets the ScaleFactor.
`By`	Gets or sets the By.
`Position`	Gets or sets the Position.
`ItemType`	Gets or sets the ItemType.
`SubScopeBy`	Gets or sets the SubScopeBy.
`InputUnitSystem`	Gets the InputUnitSystem.
`CalculateTimeHistory`	Gets or sets the CalculateTimeHistory.
`AverageAcrossBodies`	Gets or sets the AverageAcrossBodies.
`Suppressed`	Gets or sets the Suppressed.
`DataModelObjectCategory`	Gets the current DataModelObject’s category.
`Children`	Gets the list of children.
`Comments`	Gets the list of associated comments.
`Figures`	Gets the list of associated figures.
`Images`	Gets the list of associated images.
`InternalObject`	Gets the internal object. For advanced usage only.
`Properties`	Gets the list of properties for this object.
`VisibleProperties`	Gets the list of properties that are visible for this object.

Property detail#

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

property UserDefinedResult.Mode: System.UInt32 | None: Gets or sets the Mode (Result Set Number).

property UserDefinedResult.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 UserDefinedResult.Ply: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.AnalysisPly] | None: Gets or sets the Ply selection.

property UserDefinedResult.Plies: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.ImportedPliesCollection] | None: Plies property.

property UserDefinedResult.IsSolved: System.Boolean | None: Gets the IsSolved.

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

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

property UserDefinedResult.ScaleFactorValue: System.Double | None: Gets or sets the ScaleFactorValue.

property UserDefinedResult.OutputUnit: Ansys.Mechanical.DataModel.Enums.UnitCategoryType | None: Gets or sets the OutputUnit.

property UserDefinedResult.SetNumber: System.UInt32 | None: Gets or sets the Set Number.

property UserDefinedResult.CombinationNumber: System.UInt32 | None: Gets or sets the Combination Number for a Solution Combination result.

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

property UserDefinedResult.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSCustomResultAuto | None: Gets the internal object. For advanced usage only.

property UserDefinedResult.CyclicMode: System.UInt32 | None: Gets or sets the CyclicMode.

property UserDefinedResult.Expression: System.String | None: Gets or sets the Expression.

property UserDefinedResult.GlobalIDs: System.String | None: Gets or sets the GlobalIDs.

property UserDefinedResult.Identifier: System.String | None: Gets or sets the Identifier.

property UserDefinedResult.IterationNumber: System.Int32 | None: Gets the IterationNumber.

property UserDefinedResult.Layer: System.Int32 | None: Gets or sets the Layer.

property UserDefinedResult.LoadMultiplier: System.Double | None: Gets the LoadMultiplier.

property UserDefinedResult.LoadStep: System.Int32 | None: Gets the LoadStep.

property UserDefinedResult.MaximumOccursOn: System.String | None: Gets the MaximumOccursOn.

property UserDefinedResult.MinimumOccursOn: System.String | None: Gets the MinimumOccursOn.

property UserDefinedResult.LoadStepNumber: System.UInt32 | None: Gets or sets the LoadStepNumber.

property UserDefinedResult.SolverComponentIDs: System.String | None: Gets or sets the SolverComponentIDs.

property UserDefinedResult.Substep: System.Int32 | None: Gets the Substep.

property UserDefinedResult.Type: System.String | None: Gets the Type.

property UserDefinedResult.ReportedFrequency: Ansys.Core.Units.Quantity | None: Gets the ReportedFrequency.

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

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

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

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

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

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

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

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

property UserDefinedResult.SweepingPhase: Ansys.Core.Units.Quantity | None: Gets or sets the SweepingPhase.

property UserDefinedResult.PhaseIncrement: Ansys.Core.Units.Quantity | None: Gets or sets the PhaseIncrement.

property UserDefinedResult.RequestedFrequency: Ansys.Core.Units.Quantity | None: Gets or sets the RequestedFrequency.

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

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

property UserDefinedResult.ResponseType: Ansys.Mechanical.DataModel.Enums.CoreResultType | None: Gets or sets the ResponseType.

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

property UserDefinedResult.ScaleFactor: Ansys.Mechanical.DataModel.Enums.ScaleFactorType | None: Gets or sets the ScaleFactor.

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

property UserDefinedResult.Position: Ansys.Mechanical.DataModel.Enums.ShellFaceType | None: Gets or sets the Position.

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

property UserDefinedResult.SubScopeBy: Ansys.Mechanical.DataModel.Enums.SubScopingDefineByType | None: Gets or sets the SubScopeBy.

property UserDefinedResult.InputUnitSystem: Ansys.Mechanical.DataModel.Enums.WBUnitSystemType | None: Gets the InputUnitSystem.

property UserDefinedResult.CalculateTimeHistory: System.Boolean | None: Gets or sets the CalculateTimeHistory.

property UserDefinedResult.AverageAcrossBodies: System.Boolean | None: Gets or sets the AverageAcrossBodies.

property UserDefinedResult.Suppressed: System.Boolean | None: Gets or sets the Suppressed.

property UserDefinedResult.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None: Gets the current DataModelObject’s category.

property UserDefinedResult.Children: System.Collections.Generic.IList[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None: Gets the list of children.

property UserDefinedResult.Comments: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Comment] | None: Gets the list of associated comments.

property UserDefinedResult.Figures: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Figure] | None: Gets the list of associated figures.

property UserDefinedResult.Images: System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.Image] | None: Gets the list of associated images.

property UserDefinedResult.InternalObject: System.Object | None: Gets the internal object. For advanced usage only.

property UserDefinedResult.Properties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties for this object.

property UserDefinedResult.VisibleProperties: System.Collections.Generic.IReadOnlyList[Ansys.ACT.Automation.Mechanical.Property] | None: Gets the list of properties that are visible for this object.

Method detail#

UserDefinedResult.ClearGeneratedData() → System.Void: Run the ClearGeneratedData action.

UserDefinedResult.FetchRemoteResults() → System.Void: Run the FetchRemoteResult action.

UserDefinedResult.ExportToTextFile(filePath: System.String) → System.Void: Run the ExportToTextFile action.

UserDefinedResult.ExportAnimation(filePath: System.String, format: Ansys.Mechanical.DataModel.Enums.GraphicsAnimationExportFormat, settings: Ansys.Mechanical.Graphics.AnimationExportSettings) → System.Void: Run the ExportAnimation action.

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

UserDefinedResult.EvaluateAllResults() → System.Void: Run the EvaluateAllResults action.

UserDefinedResult.PromoteToNamedSelection() → System.Collections.Generic.IEnumerable[Ansys.ACT.Automation.Mechanical.NamedSelection]: Run the PromoteToNamedSelection action.

UserDefinedResult.CreateResultsAtAllSets() → System.Collections.Generic.List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]: Creates results at all sets for results under a solution.

UserDefinedResult.RenameBasedOnDefinition() → System.Void: Run the RenameBasedOnDefinition action.

UserDefinedResult.Delete() → System.Void: Run the Delete action.

UserDefinedResult.GetChildren(recurses: System.Boolean, children: System.Collections.Generic.IList[ChildrenType]) → System.Collections.Generic.IList[ChildrenType]: Gets the list of children, filtered by type.

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

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

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

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

UserDefinedResult.Activate() → System.Void: Activate the current object.

UserDefinedResult.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → System.Void: Copies all visible properties from this object to another.

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

UserDefinedResult.GroupAllSimilarChildren() → System.Void: Run the GroupAllSimilarChildren action.

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

UserDefinedResult.PropertyByName(name: System.String) → Ansys.ACT.Automation.Mechanical.Property: Get a property by its unique name.

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

UserDefinedResult.CreateParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Creates a new parameter for a Property.

UserDefinedResult.GetParameter(propName: System.String) → Ansys.ACT.Interfaces.Mechanical.IParameter: Gets the parameter corresponding to the given property.

UserDefinedResult.RemoveParameter(propName: System.String) → System.Void: Removes the parameter from the parameter set corresponding to the given property.