asiAddAnalysis
asiAddAnalysis(
o_tool
[ ?name s_analysisName ]
[ ?prompt t_prompt ]
[ ?fieldList l_analysisFields ]
[ ?optionList l_analysisOptions ]
[ ?formType s_formType ]
[ ?enable s_enable ]
)
=> o_analysis / nil
Description
Adds a new analysis.
Arguments
|
o_tool
|
Simulation tool object.
|
|
?name s_analysisName
|
|
|
Name of the analysis.
|
|
?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
|
|
?enable s_enable
|
Boolean flag that specifies whether the analysis is enabled by default.
Valid Values: t specifies that the analysis is enabled by default, nil specifies that the analysis is not enabled by default.
Default Value: nil
|
Value Returned
|
o_analysis
|
Returns the new analysis object if successful.
|
|
nil
|
Unsuccessful operation.
|
Examples
The following example adds a new analysis called XYZanalysis, which has a from, to
,
and by field, and XYZ1 and XYZ2 analysis options.
tool = asiGetTool('spectre)
defclass( spectre_XYZ_analysis (analysis) nil)
anaObj = asiAddAnalysis( tool
?name 'XYZ
?prompt "XYZ"
?fieldList list(
asiCreateAnalysisField(
?name ’from
?prompt "from"
?value "0"
?row 1
?column 1
)
asiCreateAnalysisField(
?name ’to
?prompt "to"
?row 1
?column 2
)
asiCreateAnalysisField(
?name ’by
?prompt "by"
?row 1
?column 3
)
)
?optionList list(
asiCreateAnalysisOption(
?name ’XYZ1
?value "1e-4"
)
asiCreateAnalysisOption(
?name ’XYZ2
?value "1e-6"
)
)
)
Related Topics
asiDisplayAnalysis
Return to top
