RATimeStatisticsCalculator

class ansys.rocky.app.ra_time_statistics.RATimeStatisticsCalculator(base_subject)

Bases: ansys.rocky.app.ra_base_subject_element.BaseSubjectApiElement

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

Methods

GetStartTime	Get the start time of this time statistics grid function.
SetStartTime	Set the start time of this time statistics grid function.
GetStopTime	Get the stop time of this time statistics grid function.
SetStopTime	Get the stop time of this time statistics grid function.
GetGridFunctionName	Get the name of this time statistics grid function, usable on the rest of the API.

Import detail

from ansys.rocky.app.ra_time_statistics import RATimeStatisticsCalculator

Method detail

RATimeStatisticsCalculator.GetStartTime()

Get the start time of this time statistics grid function.

Return type:

Scalar

RATimeStatisticsCalculator.SetStartTime(time_value) → None

Set the start time of this time statistics grid function.

RATimeStatisticsCalculator.GetStopTime()

Get the stop time of this time statistics grid function.

Return type:

Scalar

RATimeStatisticsCalculator.SetStopTime(time_value) → None

Get the stop time of this time statistics grid function.

RATimeStatisticsCalculator.GetGridFunctionName()

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

Return type:

unicode