asiGetFormattedVal

asiGetFormattedVal( 
o_anaField | o_anaOption | o_simOption 
) 
=> t_formattedVal / nil

Description

Gets the string value of an analysis field object, an analysis option object, or a simulator option object. The format of the string values are based on the object types which are specified with functions such as asiCreateAnalysisField, asiCreateAnalysisOption, asiAddSimOption. A number of examples can be found in the example section.

Arguments

o_anaField	The analysis field object.
o_anaOption	The analysis option object.
o_simOption	The simulator option object.

Value Returned

t_formattedVal	The formatted simulator value.
nil	An object should not be printed in the control statement file.

Examples

option = asiGetSimOptionList(session)
value = asiGetFormattedVal(option)

For example, if a simulator option of the type 'literalString' is defined by :

asiAddSimOption( tool

 ?name 'option

 ?type 'literalString

 ?value "value1"

)

asiGetFormattedVal() for this option returns

"\"value1\""

When the simulator option is defined by:,

asiAddSimOption( tool

 ?name 'option

 ?type 'literalString

 ?value "value1"

 ?literalStartMarker "'"

 ?literalEndMarker  "'"

)

asiGetFormattedVal() for this option returns

"'value1'"

The following is an example of printing out a list:

asiAddSimOption( tool

 ?name 'option

 ?type 'list

 ?value '( 1 2 3 )

 ?startMarker "["

 ?endMarker  "]" )

asiGetFormattedVal() for this option returns

[ 1 2 3 ]

The following example illustrate the numericString type formatting in relation to the Value Returned of asiNeedSuffixEvaluation method.

Given that a simulator option is defined by:

asiAddSimOption( tool

 ?name 'option1

 ?type 'numericString

 ?value "1M"

)

When asiNeedSuffixEvaluation method for xyz tool returns t then

asiGetFormattedVal() for this option returns "1e6".

Whan asiNeedSuffixEvaluation method for xyz tool returns nil then

asiGetFormattedVal(0 for this option returns "1M".

Return to top