CalculationToolParameterSetFactory

class ansys.stk.core.analysis_workbench.CalculationToolParameterSetFactory

The factory is used to create instances of available parameter set types.

Overview

Methods

create	Create and registers a parameter set using specified name and description.
create_attitude	Create a parameter set defined by identifying one set of axes in reference to another.
create_ground_trajectory	Create a parameter set defined by identifying location in reference central body.
create_trajectory	Create a parameter set defined by identifying location in reference coordinate system.
create_orbit	Create a parameter set defined by identifying orbiting point and its central body.
create_vector	Create a parameter set defined by identifying vector in reference axes.
is_type_supported	Return whether the specified type is supported.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolParameterSetFactory

Method detail

CalculationToolParameterSetFactory.create(self, name: str, description: str, type: ParameterSetType) → ICalculationToolParameterSet

Create and registers a parameter set using specified name and description.

Parameters:

name : str

description : str

type : ParameterSetType

Returns:

ICalculationToolParameterSet

CalculationToolParameterSetFactory.create_attitude(self, name: str, description: str) → ICalculationToolParameterSet

Create a parameter set defined by identifying one set of axes in reference to another.

Parameters:

name : str

description : str

Returns:

ICalculationToolParameterSet

CalculationToolParameterSetFactory.create_ground_trajectory(self, name: str, description: str) → ICalculationToolParameterSet

Create a parameter set defined by identifying location in reference central body.

Parameters:

name : str

description : str

Returns:

ICalculationToolParameterSet

CalculationToolParameterSetFactory.create_trajectory(self, name: str, description: str) → ICalculationToolParameterSet

Create a parameter set defined by identifying location in reference coordinate system.

Parameters:

name : str

description : str

Returns:

ICalculationToolParameterSet

CalculationToolParameterSetFactory.create_orbit(self, name: str, description: str) → ICalculationToolParameterSet

Create a parameter set defined by identifying orbiting point and its central body.

Parameters:

name : str

description : str

Returns:

ICalculationToolParameterSet

CalculationToolParameterSetFactory.create_vector(self, name: str, description: str) → ICalculationToolParameterSet

Create a parameter set defined by identifying vector in reference axes.

Parameters:

name : str

description : str

Returns:

ICalculationToolParameterSet

CalculationToolParameterSetFactory.is_type_supported(self, type: ParameterSetType) → bool

Return whether the specified type is supported.

Parameters:

type : ParameterSetType

Returns:

bool