Search Framework:
ParameterList
Namespace: WealthLab.Core
Parent:
List<Parameter>
The ParameterList class descends from List, and contains Parameter instances. Various classes in the WL8 code base expose a ParameterList as their Parameters property, including IndicatorBase, OptimizerBase, DrawingObjectBase, and many of the data provider base classes.
Members
AssignValues
public void AssignValues(List<double> values)
Assigns the Values of the contained Parameters based on the double values in the specified values parameter. Since Parameter instances are strongly-types, this method takes care to convert any values for Parameter instances that are ParameterType.Int32 to int before assigning them to the Value property.
Clone
public ParameterList Clone()
Returns a copy of the current ParameterList instance.
Description
public string Description
Can contain a description that is passed along and displayed in the parameter editor dialog for certain items (such as Optimizers and PositionSizers).
FindByOptParamName
public Parameter FindByOptParamName(string name)
In WL8, Parameter instances can be marked as "optimizable". When this occurs, the user can assign the Parameter a descriptive name. This method finds the Parameter instance whose OptParamName matches the specified name, or null if such a Parameter could not be found.
FindName
public Parameter FindName(string name)
Returns the Parameter with the specified name, or null if such a Parameter could not be found.
FixOptimizationValues
public void FixOptimizationValues()
For each of the contained Parameter instances, checks to ensure that its Value is one of the values that is within the sequence of the Parameter's MinValue, MaxValue, StepValue. If not, it assigns the Parameter Value to its MinValue.
GetValues
public List<double> GetValues
Converts the Values of the contained Parameters to double and returns them in a List.
IsAtDefaultState
public bool IsAtDefaultState
Returns true if all of the contained Parameter instances have their Values equal to their DefaultValues.
ReturnToDefaultState
public void ResetToDefaultState()
Resets the Value of each of the contained Parameter instances to its DefaultValue.
TotalPermutations
public int TotalPermutations
Each Parameter in the contained list has MinValue, MaxValue and StepValue properties that determine the permutations it can go through during an optimization. This property multiplies all of the Parameter permutation values into an aggregate value, representing the total number of permutation of all of the ParameterList's Parameters.
ValueOf
public object ValueOf(string name)
Returns the Value of the Parameter with the specified name, or null if such a Parameter could not be found.