ICalculationToolScalar

class ansys.stk.core.analysis_workbench.ICalculationToolScalar

Any scalar calculation that is not constant by construction.

Overview

Methods

evaluate	Evaluate the scalar calculation at the specified time instant.
quick_evaluate	Evaluate the scalar calculation at the specified time instant and returns the results as an array with two elements, the first element being of boolean type indicating whether the computation succeeded, followed by a double-precision value representing…
evaluate_with_rate	Evaluate the scalar calculation at the specified time instant. The result is a scalar value and its rate of change.
quick_evaluate_with_rate	Evaluate the scalar calculation at the specified time instant and returns the results as an array with three elements, the first element being of boolean type indicating whether the computation succeeded, followed by two double-precision values one rep…
get_availability	Return a list of availability intervals.
quick_evaluate_array	Evaluate the scalar calculation, and rate, over an array of times, entered as strings in the Scenario date unit. It returns an array corresponding to the input times…
quick_evaluate_with_rate_array	Evaluate the scalar calculation over the array of times provided by an Event Array component. It returns an array corresponding to the input times…
quick_evaluate_time_array	Evaluate the scalar calculation, and rate, over the array of times provided by an Event Array component. It returns an array corresponding to the input times…
quick_evaluate_with_rate_event_array	Evaluate the scalar calculation, and rate, over the array of times provided by an Event Array component. It returns an array corresponding to the input times…

Properties

type	Return the scalar calculation type.
unit_of_measure	Return calc scalar’s unit of measure, i.e. ‘AngleUnit’, ‘DistanceUnit’, etc.

Import detail

from ansys.stk.core.analysis_workbench import ICalculationToolScalar

Property detail

property ICalculationToolScalar.type: CalculationScalarType

Return the scalar calculation type.

property ICalculationToolScalar.unit_of_measure: str

Return calc scalar’s unit of measure, i.e. ‘AngleUnit’, ‘DistanceUnit’, etc.

Method detail

ICalculationToolScalar.evaluate(self, epoch: Any) → CalculationToolEvaluateResult

Evaluate the scalar calculation at the specified time instant.

Parameters:

epoch : Any

Returns:

CalculationToolEvaluateResult

ICalculationToolScalar.quick_evaluate(self, epoch: Any) → list

Evaluate the scalar calculation at the specified time instant and returns the results as an array with two elements, the first element being of boolean type indicating whether the computation succeeded, followed by a double-precision value representing…

Parameters:

epoch : Any

Returns:

list

ICalculationToolScalar.evaluate_with_rate(self, epoch: Any) → CalculationToolEvaluateWithRateResult

Evaluate the scalar calculation at the specified time instant. The result is a scalar value and its rate of change.

Parameters:

epoch : Any

Returns:

CalculationToolEvaluateWithRateResult

ICalculationToolScalar.quick_evaluate_with_rate(self, epoch: Any) → list

Evaluate the scalar calculation at the specified time instant and returns the results as an array with three elements, the first element being of boolean type indicating whether the computation succeeded, followed by two double-precision values one rep…

Parameters:

epoch : Any

Returns:

list

ICalculationToolScalar.get_availability(self) → TimeToolIntervalCollection

Return a list of availability intervals.

Returns:

TimeToolIntervalCollection

ICalculationToolScalar.quick_evaluate_array(self, times: list) → list

Evaluate the scalar calculation, and rate, over an array of times, entered as strings in the Scenario date unit. It returns an array corresponding to the input times…

Parameters:

times : list

Returns:

list

ICalculationToolScalar.quick_evaluate_with_rate_array(self, times: list) → list

Evaluate the scalar calculation over the array of times provided by an Event Array component. It returns an array corresponding to the input times…

Parameters:

times : list

Returns:

list

ICalculationToolScalar.quick_evaluate_time_array(self, ref_array: ITimeToolTimeArray) → list

Evaluate the scalar calculation, and rate, over the array of times provided by an Event Array component. It returns an array corresponding to the input times…

Parameters:

ref_array : ITimeToolTimeArray

Returns:

list

ICalculationToolScalar.quick_evaluate_with_rate_event_array(self, ref_array: ITimeToolTimeArray) → list

Evaluate the scalar calculation, and rate, over the array of times provided by an Event Array component. It returns an array corresponding to the input times…

Parameters:

ref_array : ITimeToolTimeArray

Returns:

list