asiChangeAnalysis
asiChangeAnalysis(
o_tool
[ ?name s_analysisName ]
[ ?prompt t_prompt ]
[ ?fieldList l_analysisFields ]
[ ?optionList l_analysisOptions ]
[ ?formType s_formType ]
)
=> o_analysis / nil
Description
Changes an existing analysis.
Arguments
|
o_tool
|
Simulation tool object.
|
|
?name s_analysisName
|
|
|
Name of the analysis you want to change.
|
|
?prompt t_prompt
|
Prompt for the analysis on the form.
|
|
?fieldList l_analysisFields
|
|
|
List of analysis fields.
|
|
?optionList l_analysisOptions
|
|
|
List of analysis options.
|
|
?formType s_formType
|
|
|
Specifies how the form is displayed.
Valid Values:
-
’oneD–Specifies a sequential display of fields in one column. -
’twoD–Specifies a two dimensional display of fields based on row and column positions. The row and column positions are specified with asiAddAnalysisField, asiChangeAnalysisField, or asiCreateAnalysisField. -
’custom–Lets you specify exact coordinate locations for each field. The coordinate locations are specified with asiAddAnalysisField, asiChangeAnalysisField, or asiCreateAnalysisField.
Default Value: ’oneD
|
Value Returned
|
o_analysis
|
The analysis object.
|
|
nil
|
Unsuccessful operation.
|
Examples
The following example changes the form prompt for the AC analysis and adds two fields:
asiChangeAnalysis( tool
?name ’ac
?prompt "Modified AC Analysis"
?fieldList list(
asiCreateAnalysisField(
?name ’model
?prompt "Model Name"
?row 4
?column 1
)
asiCreateAnalysisField(
?name ’modelParam
?prompt "Model Parameter"
?row 4
?column 2
)
)
)
Related Topics
asiDisplayAnalysis
Return to top
