Adding Internal Variables

[JonathonMcMullan]

Is there an equivalent method to "create_input_slot" for internal variables in pyoptiSLang? I have a simple test case with just a CalculatorSet node but as far as I can tell, I haven't found a way to add the required internal variables to make the node work without having to write a native optiSLang script and execute it. I tried forcing the "register_as_internal_variable" to take an expression but I couldn't find the right syntax to trick it into making what I wanted.

Thanks

[rfahlberg]

Hi @JonathonMcMullan Yes there is corresponding API functionality available. You can use the register_location_as_internal_variable method. Unfortunately, the functionality for registering internal variables is still pretty raw and inconvenient via pyoptislang, you need to know exactly in what format you need to provide the location definition. We plan to improve this in the future.

Here is a snippet on how you can achieve this:

# Print the currently registered internal variables (maybe first create some via optiSLang GUI)
calculator_node=osl.application.project.root_system.find_nodes_by_name("Calculator")[0]
internal_vars=calculator_node.get_internal_variables()
print(internal_vars[0]["location"])

# Output should be something like this:
# {'settings': {'expression': '12', 'id': 'variable_1'}, 'type': 'derived_location'}

# The 'settings' object is the actual interal location format

# So in order to register an internal variable for the calculator node, you need to do the following
my_calculator_location={
    "expression": "X1+X2",
    "id": "my_internal_var"
}

calculator_node.register_location_as_internal_variable (
    name="my_internal_var",
    location=my_calculator_location,
    reference_value=0.1,
)

# In case you want to use the internal variable as a response or output slot, you can also directly register it as such (without needing to call register_location_as_internal_variable before):
calculator_node.register_location_as_response (
    location=my_calculator_location,
    name="my_internal_var",
    reference_value=0.1,
)

[JonathonMcMullan]

Hi @rfahlberg, this is perfect, thanks very much for your help