CalculationToolScalarFactory

class ansys.stk.core.analysis_workbench.CalculationToolScalarFactory

The factory creates scalar calculation components.

Overview

Methods

create	Create and registers a scalar calculation using specified name, description, and type.
create_angle	Create a scalar calculation equal to angular displacement obtained from any angle in VGT.
create_fixed_at_time_instant	Create a scalar calculation defined by evaluating the input scalar calculation at the specified reference time instant.
create_constant	Create a scalar calculation of constant value of the specified dimension.
create_data_element	Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.
create_data_element_within_group	Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.
create_derivative	Create a scalar calculation that is the derivative of an input scalar calculation.
create_elapsed_time	Create a scalar calculation that is the time elapsed since a reference time instant.
create_from_file	Create scalar calculation specified by external data file.
create_function	Create a scalar calculation that is defined by performing the specified function on the input scalar or time instant.
create_integral	Create a scalar calculation that is the integral of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
create_function_of_2_variables	Create a scalar calculation that is defined by performing a function(x,y) on two scalar arguments.
create_vector_magnitude	Create a scalar calculation equal to the magnitude of a specified vector.
create_plugin_from_display_name	Create a scalar calculation based on a COM plugin. For information how to implement and register VGT plugins, see <topic name=’Engine Plugins: COM-based Engine Plugin Components’>COM-based Engine Plugins.</topic>.
is_type_supported	Return whether the specified type is supported.
create_from_custom_script	Create a calc scalar calculation that uses scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.
create_surface_distance_between_points	Create a calc scalar calculation that is surface distance along the specified central body ellipsoid between two points (or their respective projections if specified at altitude).
create_dot_product	Create a scalar calculation that is defined by a dot product between two vectors.
create_vector_component	Create a scalar calculation that is defined by a specified component of a vector when resolved in specified axes.
create_average	Create a scalar calculation that is the average of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
create_standard_deviation	Create a scalar calculation that is the standard deviation of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.
create_calculation_along_trajectory	Create a scalar calculation along trajectory.
create_custom_inline_script	Create a custom inline script scalar.

Properties

available_plugin_display_names

An array of display names associated with available scalar calculation plugins. The elements of the array are strings. Display names are used to create Calc scalars based on COM plugins using CreateCalcScalarPluginFromDisplayName method.

Import detail

from ansys.stk.core.analysis_workbench import CalculationToolScalarFactory

Property detail

property CalculationToolScalarFactory.available_plugin_display_names: list

An array of display names associated with available scalar calculation plugins. The elements of the array are strings. Display names are used to create Calc scalars based on COM plugins using CreateCalcScalarPluginFromDisplayName method.

Method detail

CalculationToolScalarFactory.create(self, name: str, description: str, type: CalculationScalarType) → ICalculationToolScalar

Create and registers a scalar calculation using specified name, description, and type.

Parameters:

name : str

description : str

type : CalculationScalarType

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_angle(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation equal to angular displacement obtained from any angle in VGT.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_fixed_at_time_instant(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation defined by evaluating the input scalar calculation at the specified reference time instant.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_constant(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation of constant value of the specified dimension.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_data_element(self, name: str, description: str, data_provider: str, element_name: str) → ICalculationToolScalar

Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.

Parameters:

name : str

description : str

data_provider : str

element_name : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_data_element_within_group(self, name: str, description: str, data_provider: str, group_name: str, element_name: str) → ICalculationToolScalar

Create a scalar calculation defined from a time-dependent data element from STK data providers available for parent STK object.

Parameters:

name : str

description : str

data_provider : str

group_name : str

element_name : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_derivative(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is the derivative of an input scalar calculation.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_elapsed_time(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is the time elapsed since a reference time instant.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_from_file(self, name: str, description: str, filepath: str) → ICalculationToolScalar

Create scalar calculation specified by external data file.

Parameters:

name : str

description : str

filepath : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_function(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is defined by performing the specified function on the input scalar or time instant.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_integral(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is the integral of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_function_of_2_variables(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is defined by performing a function(x,y) on two scalar arguments.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_vector_magnitude(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation equal to the magnitude of a specified vector.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_plugin_from_display_name(self, name: str, description: str, display_name: str) → ICalculationToolScalar

Create a scalar calculation based on a COM plugin. For information how to implement and register VGT plugins, see <topic name=’Engine Plugins: COM-based Engine Plugin Components’>COM-based Engine Plugins.</topic>.

Parameters:

name : str

description : str

display_name : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.is_type_supported(self, type: CalculationScalarType) → bool

Return whether the specified type is supported.

Parameters:

type : CalculationScalarType

Returns:

bool

CalculationToolScalarFactory.create_from_custom_script(self, name: str, description: str, filepath: str) → ICalculationToolScalar

Create a calc scalar calculation that uses scripted algorithm in MATLAB (.m or .dll), Perl or VBScript to define its value and rate.

Parameters:

name : str

description : str

filepath : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_surface_distance_between_points(self, name: str, description: str) → ICalculationToolScalar

Create a calc scalar calculation that is surface distance along the specified central body ellipsoid between two points (or their respective projections if specified at altitude).

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_dot_product(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is defined by a dot product between two vectors.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_vector_component(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is defined by a specified component of a vector when resolved in specified axes.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_average(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is the average of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_standard_deviation(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation that is the standard deviation of an input scalar computed with respect to time using one of the specified numerical methods and using one of the specified accumulation types.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_calculation_along_trajectory(self, name: str, description: str) → ICalculationToolScalar

Create a scalar calculation along trajectory.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar

CalculationToolScalarFactory.create_custom_inline_script(self, name: str, description: str) → ICalculationToolScalar

Create a custom inline script scalar.

Parameters:

name : str

description : str

Returns:

ICalculationToolScalar