EvaluationGroup
Create an evaluation group for grouping related evaluation nodes and presenting the result in an evaluation group table.
Syntax
model.result().evaluationGroup().create(<egtag>,<eglabel>);
model.result().evaluationGroup(<egtag>).getRowHeaders()
model.result().evaluationGroup(<egtag>).set(property,<value>);
model.result().evaluationGroup(<egtag>).run();
Description
model.result().evaluationGroup().create(<egtag>,<egname>) creates an evaluation group named <egtag> with a label <eglabel>. An evaluation group is a group of evaluation nodes (derived values) that are evaluated and displayed in an evaluation group table. Use model.result().evaluationGroup(<egtag>).getRowHeaders() to retrieve the row headers from an evaluation group.
The following properties are available for evaluation groups:
Table 7-41: Valid Properties for Evaluation groups.
name
Value
Default
Description
config
configuration name
 
The configuration to use for the solution times or parameters, if solutionparams is set to configuration.
concatenation
horizontal | vertical
horizontal
Concatenate contributions from evaluation features horizontally or vertically.
data
none | dataset name
First compatible dataset
The dataset this feature refers to. This is the default dataset for all plots in the group.
generalexpr
String
 
A general expression for transformation of evaluations (using the tags of the evaluation subfeatures). Active when method is set to general.
includeparameters
auto | true | false
auto
Include the parameter value columns from the first evaluation feature (auto), all parameter value columns (true), or no parameter value column (false).
innerinput
all | first | last | manual | manualindices | interp
all
How to input the solution to use. manual indicates that solnum is used. manualindices indicates that solnumindices is used. interp indicates that t is used.
interp
double row matrix
Empty on all levels
The times to use, for transient levels. Available when data is not none and the underlying data is transient.
keepchildnodes
Boolean
false
Keep the evaluation of the child nodes when type is not set to none.
looplevel
integer row matrix
All solutions on all levels
The solutions to use, per level.
looplevelindices
integer row matrix
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when looplevelinput is manualindices on a level.
looplevelinput
String array with all | first | last | manual | manualindices | interp on each level
all on all levels
How to input the solution to use, per level. manual on a level indicates that looplevel is used on that level. manualindices on a level indicates that looplevelindices is used on that level. interp on a level indicates that interp is used on that level.
outerinput
all | first | last | manual | manualindices
all
How to input the outer solutions to use. Applicable only for parametric sweep models. manual indicates that outersolnum is used. manualindices indicates that outersolnumindices is used.
outersolnum
nonnegative integer array
1
The index of the outer solutions to use. Applicable only for parametric sweep models. Since the various outer solutions can have different number of solnum, the solnum property is not used.
outersolnumindices
String or integer array
Empty
An alternative way to specify the outer solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when outerinput is manualindices.
solnum
Integer array
All solutions
The solutions to plot. Available when the underlying data has multiple solutions.
solnumindices
String or integer array
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
solutionparams
manual | configuration
manual
Specify solution parameters directly (manual) or from a configuration.
storetable
inmodel | inmodelandonfile | onfile
inmodel
Controls whether evaluation group table is stored in model (inmodel), on file (onfile), or both (inmodelandonfile).
tablebuffersize
positive integer
Taken from buffer size preference. The default of which is 10000.
The size of the in-memory buffer size where the evaluation group table is stored, used when storetable is set to inmodel or inmodelandonfile. In the second case only the last tablebuffersize rows are kept in the model; the rest is read from file when necessary.
transpose
true | false
false
Transpose the table data in the evaluation group so that the presentation contains row headers instead of column headers.
type
none | sum | average | difference | general
none
Transformation type for the evaluations: No transformation, sum, average, difference, or a general expression (the generalexpr property)
See Also
AvVolume, AvSurface, AvLine, EvalAberration, EvalGlobal, Eval, EvalPoint, MaxVolume, MaxSurface, MaxLine, MinVolume, MinSurface, MinLine, PlotGroup1D, PlotGroup2D, PlotGroup3D