PythonCodeEventBased
Last update: 14.01.2025
PythonCodeEventBased
class Ansys.ACT.Automation.Mechanical.PythonCodeEventBased
Bases: object
Defines a PythonCodeEventBased.
Overview
Methods
Name | Description |
---|---|
Activate |
Activate the current object. |
Connect |
Register the python code. |
CopyTo |
Copies all visible properties from this object to another. |
CreateParameter |
Creates a new parameter for a Property. |
Delete |
Run the Delete action. |
Duplicate |
Duplicate method. |
GetParameter |
Gets the parameter corresponding to the given property. |
GroupAllSimilarChildren |
Run the GroupAllSimilarChildren action. |
GroupSimilarObjects |
Run the GroupSimilarObjects action. |
PropertyByAPIName |
Get a property by its API name. |
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. |
Properties
Name | Description |
---|---|
AllowRecursion |
Gets or Sets whether the PythonCode allows recursion. |
Connected |
Gets whether the callbacks are currently connected. |
DataModelObjectCategory |
Gets the current DataModelObject’s category. |
InternalObject |
Gets the internal object. For advanced usage only. |
InvalidateSolution |
Gets or sets the InvalidateSolution. |
Properties |
Gets the list of properties for this object. |
PropertyProvider |
Gets or sets the propperty provider instance associated with this python code object. |
ScriptExecutionScope |
The scope identifier in which the code execution will take place. |
SolverTarget |
Gets the SolverTarget. |
Suppressed |
Gets or sets the Suppressed. |
TargetCallback |
Gets or sets the TargetCallback. |
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. |
Property detail
property PythonCodeEventBased.AllowRecursion : bool | None
Gets or Sets whether the PythonCode allows recursion.
property PythonCodeEventBased.Connected : bool | None
Gets whether the callbacks are currently connected.
property PythonCodeEventBased.DataModelObjectCategory : Ansys.Mechanical.DataModel.Enums.DataModelObjectCategory | None
Gets the current DataModelObject’s category.
property PythonCodeEventBased.InternalObject : Ansys.Common.Interop.DSObjectsAuto.IDSPythonCodeEventBasedAuto | None
Gets the internal object. For advanced usage only.
property PythonCodeEventBased.InvalidateSolution : bool | None
Gets or sets the InvalidateSolution.
property PythonCodeEventBased.Properties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties for this object.
property PythonCodeEventBased.PropertyProvider : Ansys.ACT.Interfaces.Mechanical.IPropertyProvider | None
Gets or sets the propperty provider instance associated with this python code object.
property PythonCodeEventBased.ScriptExecutionScope : str | None
The scope identifier in which the code execution will take place.
property PythonCodeEventBased.SolverTarget : Ansys.Mechanical.DataModel.Enums.CommandEditorTarget | None
Gets the SolverTarget.
property PythonCodeEventBased.Suppressed : bool | None
Gets or sets the Suppressed.
property PythonCodeEventBased.TargetCallback : Ansys.Mechanical.DataModel.Enums.PythonCodeTargetCallback | None
Gets or sets the TargetCallback.
property PythonCodeEventBased.Text : str | None
Gets or sets the text in the script tab for the Python Code object.
property PythonCodeEventBased.VisibleProperties : tuple[Ansys.ACT.Automation.Mechanical.Property] | None
Gets the list of properties that are visible for this object.
Method detail
PythonCodeEventBased.Activate()
Activate the current object.
PythonCodeEventBased.Connect()
Register the python code.
PythonCodeEventBased.CopyTo(other: Ansys.ACT.Automation.Mechanical.DataModelObject)
Copies all visible properties from this object to another.
PythonCodeEventBased.CreateParameter(propName: str)
Creates a new parameter for a Property.
PythonCodeEventBased.Delete()
Run the Delete action.
PythonCodeEventBased.Duplicate()
Duplicate method.
PythonCodeEventBased.GetParameter(propName: str)
Gets the parameter corresponding to the given property.
PythonCodeEventBased.GroupAllSimilarChildren()
Run the GroupAllSimilarChildren action.
PythonCodeEventBased.GroupSimilarObjects()
Run the GroupSimilarObjects action.
PythonCodeEventBased.PropertyByAPIName(name: str)
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.
PythonCodeEventBased.PropertyByName(name: str)
Get a property by its unique name.
PythonCodeEventBased.ReloadProperties()
Reload properties to update properties provided by the provider.
PythonCodeEventBased.RemoveParameter(propName: str)
Removes the parameter from the parameter set corresponding to the given property.