PythonCodeEventBased

class ansys.mechanical.stubs.v252.Ansys.ACT.Automation.Mechanical.PythonCodeEventBased(internalObject: Any)

Bases: object

Defines a PythonCodeEventBased.

Overview

Methods

Activate	Activate the current object.
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.
GetAPIName	Property name bound to dispId.
GetAllProperties	GetAllProperties method.
GetCustomPropertyByPath	GetCustomPropertyByPath method.
GetDetailsView	GetDetailsView 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.
AttachedRefs	AttachedRefs property.
ClsId	ClsId property.
Connected	Gets whether the callbacks are currently connected.
DataModelObjectCategory	Gets the current DataModelObject's category.
GroupingFolder	GroupingFolder property.
IconName	IconName property.
InternalObject	Gets the internal object. For advanced usage only.
InvalidateSolution	Gets or sets the InvalidateSolution.
IsEventBased	Gets the IsEventBased.
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.
SolverTarget	Gets the SolverTarget.
State	State property.
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.AttachedRefs: List[int] | None

AttachedRefs property.

property PythonCodeEventBased.ClsId: int | None

ClsId property.

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.GroupingFolder: Ansys.Mechanical.DataModel.Interfaces.IDataModelObject | None

GroupingFolder property.

property PythonCodeEventBased.IconName: str | None

IconName property.

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.IsEventBased: bool | None

Gets the IsEventBased.

property PythonCodeEventBased.Name: str | None

Name property.

property PythonCodeEventBased.ObjectId: int | None

ObjectId property.

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

ObjectState property.

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

ObjectTags property.

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

Parent property.

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.PropertyProviderText: str | None

Gets or sets the text in the property provider tab for the 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.State: Ansys.Mechanical.DataModel.Enums.Legacy.State | None

State property.

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() → None

Activate the current object.

PythonCodeEventBased.Connect() → None

Register the python code.

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

Copies all visible properties from this object to another.

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

CreateObjRef method.

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

Creates a new parameter for a Property.

PythonCodeEventBased.Delete() → None

Run the Delete action.

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

Duplicate method.

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

Equals method.

PythonCodeEventBased.GetAPIName(dispId: int) → str

Property name bound to dispId.

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

GetAllProperties method.

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

GetCustomPropertyByPath method.

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

GetDetailsView method.

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

Enum name bound to value

PythonCodeEventBased.GetHashCode() → int

GetHashCode method.

PythonCodeEventBased.GetIconFile() → System.Byte

GetIconFile method.

PythonCodeEventBased.GetLifetimeService() → Any

GetLifetimeService method.

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

GetObjectData method.

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

Gets the parameter corresponding to the given property.

PythonCodeEventBased.GetPath() → str

GetPath method.

PythonCodeEventBased.GetPropertyName(dispId: int) → str

GetPropertyName method.

PythonCodeEventBased.GetPropertyValue(name: str) → Any

GetPropertyValue method.

PythonCodeEventBased.GetType() → type

GetType method.

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

GetVisibleProperties method.

PythonCodeEventBased.GetVisiblePropertyNames() → List[str]

GetVisiblePropertyNames method.

PythonCodeEventBased.GroupAllSimilarChildren() → None

Run the GroupAllSimilarChildren action.

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

Run the GroupSimilarObjects action.

PythonCodeEventBased.InitializeLifetimeService() → Any

InitializeLifetimeService method.

PythonCodeEventBased.IsPropertyEditable(dispId: int) → bool

IsPropertyEditable method.

PythonCodeEventBased.IsPropertyVisible(dispId: int) → bool

IsPropertyVisible method.

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

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

PropertyById method.

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

Get a property by its unique name.

PythonCodeEventBased.ReloadProperties() → None

Reload properties to update properties provided by the provider.

PythonCodeEventBased.RemoveParameter(propName: str) → None

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

PythonCodeEventBased.ToString() → str

ToString method.