ParametricTestBenchJob Constructors

Overloads
ParametricTestBenchJob(string, IEnumerable, IEnumerable, bool, string, bool, IEnumerable, IProgress)	Creates a parameter study from matching sequences of parameter values and transient jobs.
ParametricTestBenchJob(string, List, bool, string, bool, HashSet, IProgress)	Creates a parameter study from fully labelled runs.

ParametricTestBenchJob(string, IEnumerable\<double>, IEnumerable\<TransientAnalysisJob>, bool, string, bool, IEnumerable\<string>, IProgress\<AnalysisProgress>) Constructor

Creates a parameter study from matching sequences of parameter values and transient jobs.

ParametricTestBenchJob(name, parameterValues, jobs, saveAllSignals, parameterName, lastValueVsParameterValue, includedSignalNames=None, progress=None)

Parameters

name System.String

parameterValues System.Collections.Generic.IEnumerable<System.Double >

jobs System.Collections.Generic.IEnumerable<TransientAnalysisJob >

saveAllSignals System.Boolean

parameterName System.String

lastValueVsParameterValue System.Boolean

includedSignalNames System.Collections.Generic.IEnumerable<System.String >

progress System.IProgress<AnalysisProgress >

Exceptions

System.ArgumentException
Thrown when the two input sequences do not have the same number of items.

Remarks

The input sequences are copied when the job is created. This overload avoids exposing value tuples and hash sets to callers that use sequence-oriented APIs.

ParametricTestBenchJob(string, List\<ParametricTestBenchRun>, bool, string, bool, HashSet\<string>, IProgress\<AnalysisProgress>) Constructor

Creates a parameter study from fully labelled runs.

ParametricTestBenchJob(name, jobs, saveAllSignals, parameterName, lastValueVsParameterValue, includedSignalNames=None, progress=None)

Parameters

name System.String

Display name of the study.

jobs System.Collections.Generic.List<ParametricTestBenchRun>

Transient jobs to execute in sequence.

saveAllSignals System.Boolean

Whether to retain every selected signal from every run.

parameterName System.String

Name used for the result X axis and labels.

lastValueVsParameterValue System.Boolean

Whether to create final-value-versus-parameter result signals.

includedSignalNames System.Collections.Generic.HashSet<System.String >

Optional names of signals to retain.

progress System.IProgress<AnalysisProgress >

Optional receiver for aggregate progress.