RAInputVariables

class RAInputVariables

Rocky PrePost Scripting wrapper for the list of parametric input variables.

The input variables correspond to the Variables list on the Input tab of a project’s Expressions/Variables dock. This wrapper can be used to create, remove and list a project’s input variables.

Retrieve the RAInputVariables through the corresponding RAProject. Example usage:

project = app.GetProject()
input_variables = project.GetInputVariables()

input_variables.CreateVariable('a', value=1)
input_variables.CreateVariable('b', value=2)

input_variables.RemoveVariable('a')

for variable in input_variables:
    variable.SetValue(3)

b = input_variables.GetVariableByName('b')
b.SetValue(4)

Methods:

CreateVariable(name: str, value: float = 0.0)

Create a new input variable. Returns the new variable.

• Parameters:
  • name – The variable’s name.
  • value – The initial value for the variable.

GetVariableByName(name: str)

Get an existing input variable via its name.

• Parameters: name – The input variable’s name.

RemoveVariable(variable: Union[RAParametricVar, str])

Remove an input variable.

• Parameters: variable – Either an instance of RAParametricVar or the name of the variable to remove.