STKEngineApplication

class ansys.stk.core.stkengine.STKEngineApplication

STKXApplication

Interact with STK Engine.

Use STKEngine.StartApplication() to obtain an initialized STKEngineApplication object.

Overview

Methods

new_object_root	Create a new object model root for the STK Engine application.
new_object_model_context	Create a new object model context for the STK Engine application.
set_grpc_options	Grpc is not available with STK Engine. Provided for parity with STK Runtime and Desktop. Available options include: { “raise exceptions with STK Engine” : bool }. Set to false to suppress exceptions when using SetGrpcOptions and NewGrpcCallBatcher with STK Engine.
new_grpc_call_batcher	Grpc is not available with STK Engine. Provided for parity with STK Runtime and Desktop.
shutdown	Shut down the STK Engine application.

Import detail

from ansys.stk.core.stkengine import STKEngineApplication

Method detail

STKEngineApplication.new_object_root(self) → STKObjectRoot

Create a new object model root for the STK Engine application.

Returns:

STKObjectRoot

STKEngineApplication.new_object_model_context(self) → STKObjectModelContext

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

Returns:

STKObjectModelContext

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

Grpc is not available with STK Engine. Provided for parity with STK Runtime and Desktop.

Available options include: { “raise exceptions with STK Engine” : bool }. Set to false to suppress exceptions when using SetGrpcOptions and NewGrpcCallBatcher with STK Engine.

Parameters:

options : dict

Returns:

None

STKEngineApplication.new_grpc_call_batcher(self, max_batch: int = None, disable_batching: bool = True) → GrpcCallBatcher

Grpc is not available with STK Engine. Provided for parity with STK Runtime and Desktop.

Parameters:

max_batch : int

disable_batching : bool

Returns:

GrpcCallBatcher

STKEngineApplication.shutdown(self) → None

Shut down the STK Engine application.

Returns:

None