slaGetSimulationSetupRunOptionValue

slaGetSimulationSetupRunOptionValue(
t_setupName
t_optionName
)
=> t_optionValue / nil

Description

Retrieves the value of the run option for the specified simulation setup of the setup library view that is opened using the slaOpenOrCreateView function.

Arguments

t_setupName	Specifies the name of the simulation setup.
t_optionName	Specifies the name of the run option whose value is required.

Value Returned

t_optionValue	Value of the run option for the specified simulation setup.
nil	The simulation setup with the specified name does not exist, or the command failed.

Examples

Opens a setup library view and retrieves the value of the run option for the specified simulation setup.

slaOpenOrCreateView("bertlink" "osc13" "setupLib") 
=> t
slaGetSimulationSetupRunOptionValue("SimpleMC_10Points" "mcnumpoints") 
=> "10"

Returns an error message if the specified simulation setup does not exist.

slaGetSimulationSetupRunOptionValue("XXX" "mcnumpoints")
ERROR (ADE-11414): Cannot run the function because the simulation setup 'XXX' is invalid. Specify a valid simulation setup name and rerun the function.
=> nil

Related Topics

slaGetSimulationSetupRunOptions

slaGetSimulationSetups

Setup Library Assistant Functions

Return to top