AnalysisWorkbenchRoot#

class ansys.stk.core.analysis_workbench.AnalysisWorkbenchRoot#

Represents a VGT root.

Overview#

get_template_provider

Return a template provider. The method takes a class name (i.e. Satellite, Facility, etc.).

get_provider

Return an instance provider. The method takes a short instance path to an STK object or a central body.(i.e. Satellite/Satellite1, CentralBody/Earth, etc.).

well_known_systems

Return the most commonly used systems (e.g. Sun Fixed, Earth Fixed, etc.).

well_known_axes

Return the most commonly used axes (e.g. Sun ICRF, Earth Inertial, etc.).

Import detail#

from ansys.stk.core.analysis_workbench import AnalysisWorkbenchRoot

Property detail#

property AnalysisWorkbenchRoot.well_known_systems: VectorGeometryToolWellKnownSystems#

Return the most commonly used systems (e.g. Sun Fixed, Earth Fixed, etc.).

property AnalysisWorkbenchRoot.well_known_axes: VectorGeometryToolWellKnownAxes#

Return the most commonly used axes (e.g. Sun ICRF, Earth Inertial, etc.).

Method detail#

AnalysisWorkbenchRoot.get_template_provider(self, class_name: str) AnalysisWorkbenchComponentProvider#

Return a template provider. The method takes a class name (i.e. Satellite, Facility, etc.).

Parameters:

class_name : str

Returns:

AnalysisWorkbenchComponentProvider

AnalysisWorkbenchRoot.get_provider(self, inst_path: str) AnalysisWorkbenchComponentProvider#

Return an instance provider. The method takes a short instance path to an STK object or a central body.(i.e. Satellite/Satellite1, CentralBody/Earth, etc.).

Parameters:

inst_path : str

Returns:

AnalysisWorkbenchComponentProvider