RATimeRangeFilter

class RATimeRangeFilter

Rocky PrePost Scripting wrapper to manipulate Time Range Filter.

Methods:

Name	Description
GetDomainRange()	Get the value of "Domain Range".
GetFinal([unit])	Get the value of "Final".
GetInitial([unit])	Get the value of "Initial".
GetValidDomainRangeValues()	Get a list of all possible values for "Domain Range".
SetDomainRange(value)	Set the value of "Domain Range".
SetFinal(value[, unit])	Set the value of "Final".
SetInitial(value[, unit])	Set the value of "Initial".

GetDomainRange()

Get the value of “Domain Range”.

GetFinal(unit: str | None = None)

Get the value of “Final”.

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

GetInitial(unit: str | None = None)

Get the value of “Initial”.

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

GetValidDomainRangeValues()

Get a list of all possible values for “Domain Range”.

• Returns: The returned list is [‘Application Time Filter’, ‘All’, ‘Last Output’, ‘Time Range’, ‘Specific Time’, ‘After Time’, ‘Time Range Relative to Simulation End’].

SetDomainRange(value: str)

Set the value of “Domain Range”.

• Parameters: value – The value to set.

SetFinal(value: str | float, unit: str | None = None)

Set the value of “Final”.

• 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”.

SetInitial(value: str | float, unit: str | None = None)

Set the value of “Initial”.

• 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”.