UserDefinedResult
#
- class ansys.mechanical.stubs.v241.Ansys.ACT.Automation.Mechanical.Results.UserDefinedResult#
Bases:
object
Defines a UserDefinedResult.
Overview#
|
Run the ClearGeneratedData action. |
|
Run the FetchRemoteResult action. |
|
Run the ExportToTextFile action. |
|
Run the ExportAnimation action. |
|
Run the DuplicateWithoutResults action. |
|
Run the EvaluateAllResults action. |
|
Run the PromoteToNamedSelection action. |
|
Creates results at all sets for results under a solution. |
|
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 result table. |
|
Gets or sets the Mode (Result Set Number). |
|
Gets or sets the Coordinate System. |
|
Gets or sets the Ply selection. |
|
Plies property. |
|
Gets the IsSolved. |
|
Gets or sets the Location. |
|
Gets or sets the ScopingMethod. |
|
Gets or sets the ScaleFactorValue. |
|
Gets or sets the OutputUnit. |
|
Gets or sets the Set Number. |
|
Gets or sets the Combination Number for a Solution Combination result. |
|
Gets or sets the SolutionCombinationDriver. |
|
Gets the internal object. For advanced usage only. |
|
Gets or sets the CyclicMode. |
|
Gets or sets the Expression. |
|
Gets or sets the GlobalIDs. |
|
Gets or sets the Identifier. |
|
Gets the IterationNumber. |
|
Gets or sets the Layer. |
|
Gets the LoadMultiplier. |
|
Gets the LoadStep. |
|
Gets the MaximumOccursOn. |
|
Gets the MinimumOccursOn. |
|
Gets or sets the LoadStepNumber. |
|
Gets or sets the SolverComponentIDs. |
|
Gets the Substep. |
|
Gets the Type. |
|
Gets the ReportedFrequency. |
|
Gets the Average. |
|
Gets or sets the DisplayTime. |
|
Gets the Maximum. |
|
Gets the MaximumOfMaximumOverTime. |
|
Gets the MaximumOfMinimumOverTime. |
|
Gets the Minimum. |
|
Gets the MinimumOfMaximumOverTime. |
|
Gets the MinimumOfMinimumOverTime. |
|
Gets or sets the SweepingPhase. |
|
Gets or sets the PhaseIncrement. |
|
Gets or sets the RequestedFrequency. |
|
Gets the Time. |
|
Gets or sets the GraphControlsXAxis. |
|
Gets or sets the ResponseType. |
|
Gets or sets the DisplayOption. |
|
Gets or sets the ScaleFactor. |
|
Gets or sets the By. |
|
Gets or sets the Position. |
|
Gets or sets the ItemType. |
|
Gets or sets the SubScopeBy. |
|
Gets the InputUnitSystem. |
|
Gets or sets the CalculateTimeHistory. |
|
Gets or sets the AverageAcrossBodies. |
|
Gets or sets the Suppressed. |
|
Gets the current DataModelObject’s category. |
|
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 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.