maeGetEnvOption

maeGetEnvOption(
t_testName
[ ?includeEmpty g_includeEmpty ]
[ ?option t_option ]
[ ?session t_sessionName ]
)
=> l_optionList / nil

Description

Returns a list of name-value pairs for all the environment option for the given test. By default, it returns all the environment options whose value is not nil. If the includeEmpty argument is set to t, the function returns all the environment options. If a specific option is given, it returns the value of only that option.

Arguments

t_testName	Name of the test.
?includeEmpty l_includeEmpty
	Includes or excludes the options for which no value is set.
?option t_option
	Name of the option for which the value is to be returned.
?session t_sessionName
	Name of the session If not specified, the current session is used.

Value Returned

l_optionList	A list of name-value pairs of all or the specified environment options is returned.
nil	Indicates an error.

Examples

Returns a list of name-value pairs for all the environment options in the test solutions:ampTest:2.

sess= maeOpenSetup("solutions" "ampTest" "maestro")
=> "session0"
maeGetEnvOption("solutions:ampTest:2")
=> (switchViewList ("spectre" "cmos_sch" "cmos.sch" "schematic" "veriloga" "ahdl")
stopViewList ("spectre")
controlMode "interactive"
modelFiles (("/home/user1/models/Models/allModels.scs" "FF"))
…..

)

Returns a list of name-value pairs for all the environment options in the test solutions:ampTest:2 except for the options with no value.

maeGetEnvOption("solutions:ampTest:2" ?includeEmpty t)
=> ( switchViewList ("spectre" "cmos_sch" "cmos.sch" "schematic" "veriloga" "ahdl")
stopViewList ("spectre") 
controlMode "interactive"
modelFiles (("/home/user1/models/Models/allModels.scs" "FF"))
paramRangeCheckFile ""
analysisOrder nil
stimulusFile nil
……)

Returns the name-value pair for the specified environment option switchViewList.

maeGetEnvOption("solutions:ampTest:2" ?option "switchViewList")
=> ("spectre" "cmos_sch" "cmos.sch" "schematic" "veriloga" "ahdl")

Returns the list of DSPF files used for the test mytestname.

dspf = maeGetEnvOption("mytestname" ?option "dspfFile")
(printf "dspf = %L\n" dspf)

Returns the complete list of options including the options that are currently not set for all enabled tests in ADE Assembler.

tests = maeGetSetup(?typeName "tests" ?enabled t)

(foreach test tests
    (printf "test = %s\n" test) 
    dspf = maeGetEnvOption(test ?option "dspfFile")
    (printf "dspf = %L\n" dspf)
    )

Return to top