`IMechanicalExtAPI`#

class ansys.mechanical.stubs.v261.Ansys.ACT.Interfaces.Mechanical.IMechanicalExtAPI#

Bases: object

Exposes the main entry point of all ATC APIs.

Overview#

Methods

`CloseResultReader`	Close the result readers for a given result file
`ExecuteCommand`	ExecuteCommand method.
`LockPrePostLicense`	Locks the license used by the PRE/POST application.
`UnlockPrePostLicense`	R

Properties

`ActResultReaderUsingMeshDataFromRst`	Gets or sets a value indicating whether the mesh data are read inside the .rst file or not.
`Application`	Application property.
`Context`	Context property.
`DataModel`	DataModel property.
`ExtensionManager`	ExtensionManager property.
`ExtensionMgr`	ExtensionMgr property.
`Graphics`	Graphics property.
`GraphicsAddin`	Gets the Mechanical Graphics Addin instance for providing custom graphics
`Log`	Log property.
`ResultReaderAllowsMultiServers`	If true then allow to create many readers by result file else create only one reader by result file.
`ResultReaderConnectionType`	Gets or sets the type of connection to use for the ACT Result Reader : “PIPE” or “TCP”
`ResultReaderPort`	Gets or sets the port used for the connection to the result reader
`SelectionManager`	SelectionManager property.
`Tools`	Tools property.
`UserInterface`	UserInterface property.
`UsesStandaloneActResultReaderImplementation`	Gets or sets a value indicating which implementation to use when post processing results.
`UsesStandaloneResultReaderImplementation`	Gets or sets a value indicating which implementation to use when post processing results.

Property detail#

property IMechanicalExtAPI.ActResultReaderUsingMeshDataFromRst: bool | None#: Gets or sets a value indicating whether the mesh data are read inside the .rst file or not.

property IMechanicalExtAPI.Application: Ansys.ACT.Interfaces.Mechanical.IMechanicalApplication | None#: Application property.

property IMechanicalExtAPI.Context: str | None#: Context property.

property IMechanicalExtAPI.DataModel: Ansys.ACT.Mechanical.MechanicalDataModel | None#: DataModel property.

property IMechanicalExtAPI.ExtensionManager: Ansys.ACT.Interfaces.Common.IExtensionManager | None#: ExtensionManager property.

property IMechanicalExtAPI.ExtensionMgr: Ansys.ACT.Interfaces.Common.IExtensionManager | None#: ExtensionMgr property.

property IMechanicalExtAPI.Graphics: Ansys.ACT.Common.Graphics.MechanicalGraphicsWrapper | None#: Graphics property.

property IMechanicalExtAPI.GraphicsAddin: Ansys.Mechanical.Graphics.MechanicalGraphicsAddin | None#: Gets the Mechanical Graphics Addin instance for providing custom graphics

property IMechanicalExtAPI.Log: Ansys.ACT.Interfaces.Common.ILog | None#: Log property.

property IMechanicalExtAPI.ResultReaderAllowsMultiServers: bool | None#: If true then allow to create many readers by result file else create only one reader by result file.

property IMechanicalExtAPI.ResultReaderConnectionType: str | None#: Gets or sets the type of connection to use for the ACT Result Reader : “PIPE” or “TCP”

property IMechanicalExtAPI.ResultReaderPort: int | None#: Gets or sets the port used for the connection to the result reader

property IMechanicalExtAPI.SelectionManager: Ansys.ACT.Interfaces.Common.ISelectionManager | None#: SelectionManager property.

property IMechanicalExtAPI.Tools: Ansys.ACT.Interfaces.Common.ITools | None#: Tools property.

property IMechanicalExtAPI.UserInterface: Ansys.ACT.Interfaces.UserInterface.IUserInterface | None#: UserInterface property.

property IMechanicalExtAPI.UsesStandaloneActResultReaderImplementation: bool | None#: Gets or sets a value indicating which implementation to use when post processing results.

property IMechanicalExtAPI.UsesStandaloneResultReaderImplementation: bool | None#: Gets or sets a value indicating which implementation to use when post processing results.

Method detail#

IMechanicalExtAPI.CloseResultReader(filename: str) → None#: Close the result readers for a given result file

IMechanicalExtAPI.ExecuteCommand(cmd: str, args: System.Collections.Generic.Dictionary[str, Any], vars: str) → System.Collections.Generic.Dictionary[str, Any]#: ExecuteCommand method.

IMechanicalExtAPI.LockPrePostLicense() → None#: Locks the license used by the PRE/POST application.

IMechanicalExtAPI.UnlockPrePostLicense() → None#

R
    Unlocks the license used by the PRE/POST application. This is required if you want to manually launch the Ansys solver.
    You must relock the license after its use. If you don't relock the license, the PRE/POST application will be in read-only mode.