RATimeStatisticsCalculator

class ansys.rocky.app.ra_time_statistics.RATimeStatisticsCalculator(id: str, model_id: str | None = None)

Bases: ansys.rocky.app.api_element_item.ApiElementItem

PrePost Scripting wrapper for TimeStatisticsCalculators.

Supports getting/setting the start and stop times, and retrieving the name of the grid function generated (for use with the rest of the API).

Overview

Constructors

GetWrappedClass
GetClassName

Methods

GetGridFunctionName	Get the name of this time statistics grid function, usable on the rest of the API.
GetStartTime	Get the value of “Start Time”.
SetStartTime	Set the value of “Start Time”.
GetStopTime	Get the value of “Stop Time”.
SetStopTime	Set the value of “Stop Time”.

Import detail

from ansys.rocky.app.ra_time_statistics import RATimeStatisticsCalculator

Method detail

classmethod RATimeStatisticsCalculator.GetWrappedClass() → type[rocky30.plugins.time_statistics.time_statistics_calculation.TimeStatisticsCalculator]

classmethod RATimeStatisticsCalculator.GetClassName() → str

RATimeStatisticsCalculator.GetGridFunctionName() → str

Get the name of this time statistics grid function, usable on the rest of the API.

RATimeStatisticsCalculator.GetStartTime(unit: str | None = None) → float

Get the value of “Start Time”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RATimeStatisticsCalculator.SetStartTime(value: str | float, unit: str | None = None) → None

Set the value of “Start Time”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.

RATimeStatisticsCalculator.GetStopTime(unit: str | None = None) → float

Get the value of “Stop Time”.

Parameters:

unit – The unit for the returned value. If no unit is provided, the returned value will be in “s”.

RATimeStatisticsCalculator.SetStopTime(value: str | float, unit: str | None = None) → None

Set the value of “Stop Time”.

Parameters:

• value – The value to set. This value can be an expression with input variables or float type.

• unit – The unit for value. If no unit is provided, value is assumed to be in “s”.