PythonResult

class ansys.mechanical.stubs.v242.Ansys.ACT.Automation.Mechanical.Results.ScriptableResults.PythonResult(internalObject: Any)

Bases: object

Defines a PythonResult.

Overview

Methods

Activate	Activate the current object.
AddComment	Creates a new child Comment.
AddFigure	Creates a new child Figure.
AddImage	Creates a new child Image.
ClearGeneratedData	ClearGeneratedData method.
Connect	Register the python code.
CopyTo	Copies all visible properties from this object to another.
CreateObjRef	CreateObjRef method.
CreateParameter	Creates a new parameter for a Property.
Delete	Run the Delete action.
Duplicate	Duplicate method.
Equals	Equals method.
Evaluate	Evaluate method.
EvaluateAllResults	Evaluate all results.
ExportAnimation	Run the ExportAnimation action.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetChildren	Gets the list of children, filtered by type.
GetCustomPropertyByPath	GetCustomPropertyByPath method.
GetEnumName	Enum name bound to value
GetHashCode	GetHashCode method.
GetIconFile	GetIconFile method.
GetLifetimeService	GetLifetimeService method.
GetObjectData	GetObjectData method.
GetParameter	Gets the parameter corresponding to the given property.
GetPath	GetPath method.
GetPropertyName	GetPropertyName method.
GetPropertyValue	GetPropertyValue 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.
PropertyByAPIName	Get a property by its API name.
PropertyById	PropertyById method.
PropertyByName	Get a property by its unique name.
ReloadProperties	Reload properties to update properties provided by the provider.
RemoveParameter	Removes the parameter from the parameter set corresponding to the given property.
ToString	ToString method.

Properties

AllowRecursion	Gets or Sets whether the PythonCode allows recursion.
By	Gets or sets the By.
Children	Gets the list of children.
Comments	Gets the list of associated comments.
Connected	Gets whether the callbacks are currently connected.
DataModelObjectCategory	Gets the current DataModelObject's category.
DisplayTime	Gets or sets the DisplayTime.
Figures	Gets the list of associated figures.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
Images	Gets the list of associated images.
InternalObject	Gets the internal object. For advanced usage only.
IsEventBased	Gets the IsEventBased.
Location	Gets or sets the Location.
Mode	Gets or sets the Mode.
Name	Name property.
ObjectId	ObjectId property.
ObjectState	ObjectState property.
ObjectTags	ObjectTags property.
Parent	Parent property.
Properties	Gets the list of properties for this object.
PropertyProvider	Gets or sets the propperty provider instance associated with this python code object.
PropertyProviderText	Gets or sets the text in the property provider tab for the Python Code object.
ScriptExecutionScope	The scope identifier in which the code execution will take place.
State	State property.
Text	Gets or sets the text in the script tab for the Python Code object.
VisibleProperties	Gets the list of properties that are visible for this object.
WorkflowId	WorkflowId property.

Property detail

property PythonResult.AllowRecursion: bool | None

Gets or Sets whether the PythonCode allows recursion.

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

Gets or sets the By.

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

Gets the list of children.

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

Gets the list of associated comments.

property PythonResult.Connected: bool | None

Gets whether the callbacks are currently connected.

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

Gets the current DataModelObject's category.

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

Gets or sets the DisplayTime.

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

Gets the list of associated figures.

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

GroupingFolder property.

property PythonResult.IconName: str | None

IconName property.

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

Gets the list of associated images.

property PythonResult.InternalObject: Ansys.Common.Interop.DSObjectsAuto.IDSScriptDefinedResultAuto | None

Gets the internal object. For advanced usage only.

property PythonResult.IsEventBased: bool | None

Gets the IsEventBased.

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

Gets or sets the Location.

property PythonResult.Mode: int | None

Gets or sets the Mode.

property PythonResult.Name: str | None

Name property.

property PythonResult.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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

Gets the list of properties for this object.

property PythonResult.PropertyProvider: Ansys.ACT.Interfaces.Mechanical.IPropertyProvider | None

Gets or sets the propperty provider instance associated with this python code object.

property PythonResult.PropertyProviderText: str | None

Gets or sets the text in the property provider tab for the Python Code object.

property PythonResult.ScriptExecutionScope: str | None

The scope identifier in which the code execution will take place.

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

State property.

property PythonResult.Text: str | None

Gets or sets the text in the script tab for the Python Code object.

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

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

property PythonResult.WorkflowId: int | None

WorkflowId property.

Method detail

PythonResult.Activate() → None

Activate the current object.

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

Creates a new child Comment.

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

Creates a new child Figure.

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

PythonResult.ClearGeneratedData() → None

ClearGeneratedData method.

PythonResult.Connect() → None

Register the python code.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

PythonResult.Delete() → None

Run the Delete action.

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

Duplicate method.

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

Equals method.

PythonResult.Evaluate() → None

Evaluate method.

PythonResult.EvaluateAllResults() → None

Evaluate all results.

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

Run the ExportAnimation action.

PythonResult.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

Gets the list of children, filtered by type.

PythonResult.GetCustomPropertyByPath(propertyPath: str) → Ansys.ACT.Mechanical.AdditionalProperties.CustomProperty

GetCustomPropertyByPath method.

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

Enum name bound to value

PythonResult.GetHashCode() → int

GetHashCode method.

PythonResult.GetIconFile() → System.Byte

GetIconFile method.

PythonResult.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

PythonResult.GetPath() → str

GetPath method.

PythonResult.GetPropertyName(dispId: int) → str

GetPropertyName method.

PythonResult.GetPropertyValue(name: str) → Any

GetPropertyValue method.

PythonResult.GetType() → type

GetType method.

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

GetVisibleProperties method.

PythonResult.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

PythonResult.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

PythonResult.InitializeLifetimeService() → Any

InitializeLifetimeService method.

PythonResult.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

PythonResult.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

PythonResult.ReloadProperties() → None

Reload properties to update properties provided by the provider.

PythonResult.RemoveParameter(propName: str) → None

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

PythonResult.ToString() → str

ToString method.