Result

class ansys.mechanical.stubs.v261.Ansys.ACT.Automation.Mechanical.Results.Result(internalObject: Any)

Bases: object

Defines a Result.

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.
BodyWhereMaximumOccurs	Gets the body that has the maximum result value.
ClearGeneratedData	Run the ClearGeneratedData action.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
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.
Equals	Equals method.
EvaluateAllResults	Run the EvaluateAllResults action.
ExportAnimation	Run the ExportAnimation action.
ExportToSTLFile	ExportToSTLFile method.
ExportToTextFile	ExportToTextFile method.
FetchRemoteResult	Run the FetchRemoteResult action.
FetchRemoteResults	Run the FetchRemoteResult action.
GetAPIName	GetAPIName method.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetDetailsView	GetDetailsView method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetNodalValues	GetNodalValues method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue method.
GetQuantityName	GetQuantityName method.
GetType	GetType method.
GetVisibleProperties	GetVisibleProperties method.
GetVisiblePropertyNames	GetVisiblePropertyNames method.
GroupAllSimilarChildren	Run the GroupAllSimilarChildren action.
GroupSimilarObjects	Run the GroupSimilarObjects action.
InitializeLifetimeService	InitializeLifetimeService method.
IsPropertyEditable	IsPropertyEditable method.
IsPropertyVisible	IsPropertyVisible method.
PromoteToNamedSelection	Run the PromoteToNamedSelection action.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
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.
RetrieveRemoteDPFResults	RetrieveRemoteDPFResults method.
RetrieveResult	Evaluates the individual result without evaluating all the results in the same solution.
ToString	ToString method.

Properties

AttachedRefs	AttachedRefs property.
Average	Gets the Average.
By	Gets or sets the By.
CalculateTimeHistory	Gets or sets the CalculateTimeHistory.
Children	Gets the list of children.
ClsId	ClsId property.
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.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
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.
Name	Name property.
NamedSelections	Gets or sets the NamedSelections.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Path	Path property.
PlotData	Gets the result table.
Properties	Gets the list of properties for this object.
RPMSelection	Gets or sets the RPM Selection value at which the results are evaluated.
ResultType	Gets or sets the ResultType.
RpmSetNumber	Gets or sets the RpmSetNumber.
ScopingMethod	Gets or sets the ScopingMethod.
SeparateDataByEntity	Gets or sets the SeparateDataByEntity.
SetNumber	Gets or sets the Set Number.
SolutionCombinationDriver	Gets or sets the SolutionCombinationDriver.
SolverComponentIDs	Gets or sets the SolverComponentIDs.
State	State property.
Substep	Gets the Substep.
Suppressed	Gets or sets the Suppressed.
Surface	Surface property.
SurfaceCoating	SurfaceCoating property.
TabularData	Gets the tabular data of the result. Use a to get index to each column of the tabular data.
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.
Total	Gets the Total.
VisibleProperties	Gets the list of properties that are visible for this object.
WaterfallDisplayFilterBy	Gets or sets the Filer in Waterfall.
WaterfallDisplayFrequencySelection	Gets or sets the Frequency Selection.
WaterfallDisplayInterpolateData	Gets or sets the Interpolate Data Property.
WaterfallDisplayLowerBand	Gets or sets the Lower Band Value.
WaterfallDisplayMaxRPM	Gets or sets the Display Max RPM.
WaterfallDisplayMinRPM	Gets or sets the Display Min RPM.
WaterfallDisplayModeSelection	Gets or sets the Mode Selection.
WaterfallDisplayOrderSelection	Gets or sets the Order Selection.
WaterfallDisplayRpmSelection	Gets or sets the RPM Selection.
WaterfallDisplayScopeToOrderLines	Gets or sets the Scope to Order Lines Property.
WaterfallDisplayTimeSelection	Gets or sets the Time Selection.
WaterfallDisplayUpperBand	Gets or sets the Upper Band Value.
WaterfallDisplayXAxisMaximum	Gets or sets the Maximum X-Axis Value.
WaterfallDisplayXAxisMinimum	Gets or sets the Minimum X-Axis Value.
WaterfallDisplayYAxisMaximum	Gets or sets the Maximum Y-Axis Value.
WaterfallDisplayYAxisMinimum	Gets or sets the Minimum Y-Axis Value.
WaterfallShowTextOnMosaic	Gets or sets the Waterfall Mosaic Text Property.

Property detail

property Result.AttachedRefs: List[int] | None

AttachedRefs property.

property Result.Average: Ansys.Core.Units.Quantity | None

Gets the Average.

property Result.By: Ansys.Mechanical.DataModel.Enums.SetDriverStyle | None

Gets or sets the By.

property Result.CalculateTimeHistory: bool | None

Gets or sets the CalculateTimeHistory.

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

Gets the list of children.

property Result.ClsId: int | None

ClsId property.

property Result.CombinationNumber: int | None

Gets or sets the Combination Number for a Solution Combination result.

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

Gets the list of associated comments.

property Result.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 Result.CrackFrontNumber: int | None

Gets or sets the CrackFrontNumber.

property Result.DataModelObjectCategory: Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None

Gets the current DataModelObject's category.

property Result.DisplayOption: Ansys.Mechanical.DataModel.Enums.ResultAveragingType | None

Gets or sets the DisplayOption.

property Result.DisplayTime: Ansys.Core.Units.Quantity | None

Gets or sets the DisplayTime.

property Result.DpfEvaluation: Ansys.Mechanical.DataModel.Enums.DpfEvaluationType | None

Gets or sets the DpfEvaluation.

property Result.Figures: Iterable[Ansys.ACT.Automation.Mechanical.Figure] | None

Gets the list of associated figures.

property Result.GlobalIDs: str | None

Gets or sets the GlobalIDs.

property Result.GraphControlsXAxis: Ansys.Mechanical.DataModel.Enums.GraphControlsXAxis | None

Gets or sets the GraphControlsXAxis.

property Result.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property Result.IconName: str | None

IconName property.

property Result.Identifier: str | None

Gets or sets the Identifier.

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

Gets the list of associated images.

property Result.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto | None

Gets the internal object. For advanced usage only.

property Result.IsSolved: bool | None

Gets the IsSolved.

property Result.ItemType: Ansys.Mechanical.DataModel.Enums.ResultFileItemType | None

Gets or sets the ItemType.

property Result.IterationNumber: int | None

Gets the IterationNumber.

property Result.LoadStep: int | None

Gets the LoadStep.

property Result.LoadStepForMaximumOfMaximumValues: int | None

Get the Load Step for the maximum of maximum values.

property Result.LoadStepForMaximumOfMinimumValues: int | None

Get the Load Step for the maximum of minimum values.

property Result.LoadStepForMinimumOfMaximumValues: int | None

Get the Load Step for the minimum of maximum values.

property Result.LoadStepForMinimumOfMinimumValues: int | None

Get the Load Step for the minimum of minimum values.

property Result.LoadStepNumber: int | None

Gets or sets the LoadStepNumber.

property Result.Location: Ansys.ACT.Interfaces.Common.ISelectionInfo | None

Gets or sets the Location.

property Result.Maximum: Ansys.Core.Units.Quantity | None

Gets the Maximum.

property Result.MaximumOccursOn: str | None

Gets the MaximumOccursOn.

property Result.MaximumOfMaximumOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumOfMaximumOverTime.

property Result.MaximumOfMinimumOverTime: Ansys.Core.Units.Quantity | None

Gets the MaximumOfMinimumOverTime.

property Result.Minimum: Ansys.Core.Units.Quantity | None

Gets the Minimum.

property Result.MinimumOccursOn: str | None

Gets the MinimumOccursOn.

property Result.MinimumOfMaximumOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumOfMaximumOverTime.

property Result.MinimumOfMinimumOverTime: Ansys.Core.Units.Quantity | None

Gets the MinimumOfMinimumOverTime.

property Result.Name: str | None

Name property.

property Result.NamedSelections: Iterable[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject] | None

Gets or sets the NamedSelections.

property Result.ObjectId: int | None

ObjectId property.

property Result.ObjectState: Ansys.Mechanical.DataModel.Enums.ObjectState | None

ObjectState property.

property Result.ObjectTags: Iterable[Ansys.Mechanical.DataModel.Interfaces.IObjectTag] | None

ObjectTags property.

property Result.Parent: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

Parent property.

property Result.Path: Ansys.ACT.Automation.Mechanical.Path | None

Path property.

property Result.PlotData: Ansys.Mechanical.DataModel.Results.ResultDataTable | None

Gets the result table.

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

Gets the list of properties for this object.

property Result.RPMSelection: Ansys.Core.Units.Quantity | None

Gets or sets the RPM Selection value at which the results are evaluated.

property Result.ResultType: Ansys.Mechanical.DataModel.Enums.ResultType | None

Gets or sets the ResultType.

property Result.RpmSetNumber: int | None

Gets or sets the RpmSetNumber.

property Result.ScopingMethod: Ansys.Mechanical.DataModel.Enums.GeometryDefineByType | None

Gets or sets the ScopingMethod.

property Result.SeparateDataByEntity: bool | None

Gets or sets the SeparateDataByEntity.

property Result.SetNumber: int | None

Gets or sets the Set Number.

property Result.SolutionCombinationDriver: Ansys.Mechanical.DataModel.Enums.SolutionCombinationDriverStyle | None

Gets or sets the SolutionCombinationDriver.

property Result.SolverComponentIDs: str | None

Gets or sets the SolverComponentIDs.

property Result.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

property Result.Substep: int | None

Gets the Substep.

property Result.Suppressed: bool | None

Gets or sets the Suppressed.

property Result.Surface: Ansys.ACT.Automation.Mechanical.Surface | None

Surface property.

property Result.SurfaceCoating: Ansys.ACT.Automation.Mechanical.SurfaceCoating | None

SurfaceCoating property.

property Result.TabularData: Ansys.Mechanical.Interfaces.ITable | None

Gets the tabular data of the result. Use a to get index to each column of the tabular data.

property Result.Time: Ansys.Core.Units.Quantity | None

Gets the Time.

property Result.TimeForMaximumOfMaximumValues: Ansys.Core.Units.Quantity | None

Get the Time for the maximum of maximum values.

property Result.TimeForMaximumOfMinimumValues: Ansys.Core.Units.Quantity | None

Get the Time for the maximum of minimum values.

property Result.TimeForMinimumOfMaximumValues: Ansys.Core.Units.Quantity | None

Get the Time for the minimum of maximum values.

property Result.TimeForMinimumOfMinimumValues: Ansys.Core.Units.Quantity | None

Get the Time for the minimum of minimum values.

property Result.Total: Ansys.Core.Units.Quantity | None

Gets the Total.

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

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

property Result.WaterfallDisplayFilterBy: Ansys.Mechanical.DataModel.Enums.WaterfallDisplayFilterBy | None

Gets or sets the Filer in Waterfall.

property Result.WaterfallDisplayFrequencySelection: str | None

Gets or sets the Frequency Selection.

property Result.WaterfallDisplayInterpolateData: bool | None

Gets or sets the Interpolate Data Property.

property Result.WaterfallDisplayLowerBand: float | None

Gets or sets the Lower Band Value.

property Result.WaterfallDisplayMaxRPM: Ansys.Core.Units.Quantity | None

Gets or sets the Display Max RPM.

property Result.WaterfallDisplayMinRPM: Ansys.Core.Units.Quantity | None

Gets or sets the Display Min RPM.

property Result.WaterfallDisplayModeSelection: str | None

Gets or sets the Mode Selection.

property Result.WaterfallDisplayOrderSelection: str | None

Gets or sets the Order Selection.

property Result.WaterfallDisplayRpmSelection: str | None

Gets or sets the RPM Selection.

property Result.WaterfallDisplayScopeToOrderLines: bool | None

Gets or sets the Scope to Order Lines Property.

property Result.WaterfallDisplayTimeSelection: str | None

Gets or sets the Time Selection.

property Result.WaterfallDisplayUpperBand: float | None

Gets or sets the Upper Band Value.

property Result.WaterfallDisplayXAxisMaximum: float | None

Gets or sets the Maximum X-Axis Value.

property Result.WaterfallDisplayXAxisMinimum: float | None

Gets or sets the Minimum X-Axis Value.

property Result.WaterfallDisplayYAxisMaximum: float | None

Gets or sets the Maximum Y-Axis Value.

property Result.WaterfallDisplayYAxisMinimum: float | None

Gets or sets the Minimum Y-Axis Value.

property Result.WaterfallShowTextOnMosaic: bool | None

Gets or sets the Waterfall Mosaic Text Property.

Method detail

Result.Activate() → None

Activate the current object.

Result.AddAlert() → Ansys.ACT.Automation.Mechanical.Results.Alert

Creates a new Alert

Result.AddComment() → Ansys.ACT.Automation.Mechanical.Comment

Creates a new child Comment.

Result.AddConvergence() → Ansys.ACT.Automation.Mechanical.Results.Convergence

Creates a new Convergence

Result.AddFigure() → Ansys.ACT.Automation.Mechanical.Figure

Creates a new child Figure.

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

Result.BodyWhereMaximumOccurs() → Ansys.ACT.Automation.Mechanical.Body

Gets the body that has the maximum result value.
Throws an exception if body not found.

Result.ClearGeneratedData() → None

Run the ClearGeneratedData action.

Result.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject) → None

Copies all visible properties from this object to another.

Result.CreateObjRef(requestedType: type) → System.Runtime.Remoting.ObjRef

CreateObjRef method.

Result.CreateParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

CreateParameter method.

Result.CreateResultsAtAllSets() → List[Ansys.Mechanical.DataModel.Interfaces.IDataModelObject]

Creates results at all sets for results under a solution.

Result.Delete() → None

Run the Delete action.

Result.Duplicate() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Creates a copy of the current DataModelObject.

Result.DuplicateWithoutResults() → Ansys.Mechanical.DataModel.Interfaces.IDataModelObject

Run the DuplicateWithoutResults action.

Result.Equals(other: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject) → bool

Equals method.

Result.EvaluateAllResults() → None

Run the EvaluateAllResults action.

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

Run the ExportAnimation action.

Result.ExportToSTLFile(filePath: str) → None

ExportToSTLFile method.

Result.ExportToTextFile(bIgnoreExcelPreference: bool, filePath: str) → None

ExportToTextFile method.

Result.FetchRemoteResult() → None

Run the FetchRemoteResult action.

Result.FetchRemoteResults() → None

Run the FetchRemoteResult action.

Result.GetAPIName(dispId: int) → str

GetAPIName method.

Result.GetAllProperties() → List[Ansys.ACT.Automation.Mechanical.AutomationPropertyWrapper]

GetAllProperties method.

Result.GetChildren(recurses: bool, children: List[ChildrenType]) → List[ChildrenType]

Gets the list of children, filtered by type.

Result.GetDetailsView() → Ansys.ACT.Automation.Mechanical.DetailsViewData

GetDetailsView method.

Result.GetEnumName(enumType: type, value: int, dispId: int) → str

Enum name bound to value

Result.GetHashCode() → int

GetHashCode method.

Result.GetIconFile() → System.Byte

GetIconFile method.

Result.GetLifetimeService() → Any

GetLifetimeService method.

Result.GetNodalValues(bodyRefId: int) → System.Collections.Generic.Dictionary[int, float]

GetNodalValues method.

Result.GetObjectData(info: System.Runtime.Serialization.SerializationInfo, context: System.Runtime.Serialization.StreamingContext) → None

GetObjectData method.

Result.GetParameter(propName: str) → Ansys.ACT.Interfaces.Mechanical.IParameter

Gets the parameter corresponding to the given property.

Result.GetPath() → str

GetPath method.

Result.GetPropertyName(dispId: int) → str

GetPropertyName method.

Result.GetPropertyValue(name: str) → Any

GetPropertyValue method.

Result.GetQuantityName(obj: Ansys.Common.Interop.DSObjectsAuto.IDSResultAuto) → str

GetQuantityName method.

Result.GetType() → type

GetType method.

Result.GetVisibleProperties() → List[System.Reflection.PropertyInfo]

GetVisibleProperties method.

Result.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

Result.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

Result.GroupSimilarObjects() → Ansys.ACT.Automation.Mechanical.TreeGroupingFolder

Run the GroupSimilarObjects action.

Result.InitializeLifetimeService() → Any

InitializeLifetimeService method.

Result.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

Result.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

Result.PromoteToNamedSelection() → Iterable[Ansys.ACT.Automation.Mechanical.NamedSelection]

Run the PromoteToNamedSelection action.

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

Result.PropertyById(dispId: int) → Ansys.ACT.Automation.Mechanical.Property

PropertyById method.

Result.PropertyByName(name: str) → Ansys.ACT.Automation.Mechanical.Property

Get a property by its unique name.

Result.RemoveParameter(propName: str) → None

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

Result.RenameBasedOnDefinition() → None

Run the RenameBasedOnDefinition action.

Result.RetrieveRemoteDPFResults() → None

RetrieveRemoteDPFResults method.

Result.RetrieveResult() → None

Evaluates the individual result without evaluating all the results in the same solution.

Result.ToString() → str

ToString method.