STKDesktopApplication

class ansys.stk.core.stkdesktop.STKDesktopApplication

UiApplication

Interact with an STK Desktop application.

Use STKDesktop.StartApplication() or STKDesktop.AttachToApplication() to obtain an initialized STKDesktopApplication object.

Overview

Methods

new_object_model_context	Create a new object model context for the STK Desktop application.
set_grpc_options	Set advanced-usage options for the gRPC client. Available options include: { “collection iteration batch size” : int }. Number of items to preload while iterating through a collection object. Default is 100. Use 0 to indicate no limit (load entire collection). { “disable batching” : bool }. Disable all batching operations. { “release batch size” : int }. Number of interfaces to be garbage collected before sending the entire batch to STK to be released. Default value is 12.
new_grpc_call_batcher	Construct a GrpcCallBatcher linked to this gRPC client that may be used to improve API performance. If gRPC is not active, the batcher will be disabled. max_batch is the maximum number of calls to batch together. Set disable_batching=True to disable batching operations for this batcher. See grpcutilities module for more information.
shutdown	Close this STK Desktop instance (or detach if the instance was obtained through STKDesktop.AttachToApplication()).

Properties

root	Get the object model root associated with this instance of STK Desktop application.

Import detail

from ansys.stk.core.stkdesktop import STKDesktopApplication

Property detail

property STKDesktopApplication.root: STKObjectRoot

Get the object model root associated with this instance of STK Desktop application.

Method detail

STKDesktopApplication.new_object_model_context(self) → STKObjectModelContext

Create a new object model context for the STK Desktop application.

Returns:

STKObjectModelContext

STKDesktopApplication.set_grpc_options(self, options: dict) → None

Set advanced-usage options for the gRPC client.

Available options include: { “collection iteration batch size” : int }. Number of items to preload while iterating through a collection object. Default is 100. Use 0 to indicate no limit (load entire collection). { “disable batching” : bool }. Disable all batching operations. { “release batch size” : int }. Number of interfaces to be garbage collected before sending the entire batch to STK to be released. Default value is 12.

Parameters:

options : dict

Returns:

None

STKDesktopApplication.new_grpc_call_batcher(self, max_batch: int = None, disable_batching: bool = False) → GrpcCallBatcher

Construct a GrpcCallBatcher linked to this gRPC client that may be used to improve API performance.

If gRPC is not active, the batcher will be disabled. max_batch is the maximum number of calls to batch together. Set disable_batching=True to disable batching operations for this batcher. See grpcutilities module for more information.

Parameters:

max_batch : int

disable_batching : bool

Returns:

GrpcCallBatcher

STKDesktopApplication.shutdown(self) → None

Close this STK Desktop instance (or detach if the instance was obtained through STKDesktop.AttachToApplication()).

Returns:

None