WeibullDataSet.GetDistrParameters: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 22: Line 22:
{{APIName|List(}}
{{APIName|List(}}
{{APIPrefix|Of}}
{{APIPrefix|Of}}
{{APIName|ParamInputInfo),}}
{{APIName|[[ParamInputInfo Class|ParamInputInfo]]),}}
{{APIPrefix|ByRef}}
{{APIPrefix|ByRef}}
{{APIName|Cancel}}
{{APIName|Cancel}}

Revision as of 00:57, 25 September 2013



Displays a prompt for customized parameters.

Method Syntax

GetDistrParameters( ByVal sender As WeibullDataSet, ByVal sMsg As String , ByVal GetOnlyOneParameter As Boolean , ByVal Params As List( Of ParamInputInfo), ByRef Cancel As Boolean )
Called by ‘sender’ when additional input is required.

Parameters

sender An WeibullDataSet object

sMsg The main display label.

GetOnlyOneParameter Prompt for only one parameter

Params A list of Parameter input information classes, ParamInputInfo, that would be updated by this prompt.

         ParamInputInfo Class
              Public Name As String
              Public Min As Double
              Public Max As Double
              Public CanEqualMin As Boolean
              Public CanEqualMax As Boolean
              Public Value As Double
         ParamInputInfo Declaration
              New(ByVal Name As String, ByVal Min As Double, ByVal Max As Double, ByVal CanEqualMin As Boolean, ByVal CanEqualMax As Boolean)
         ParamInputInfo Usage
              After processing with GetDistrParameters, the Value of each parameter will be updated. 

Cancel If the prompt was closed by any means other than clicking the "Okay", this value would be set to True.

Usage Example

Declare the WeibullEvents.
Declare the WeibullDataSet.
Note: The WeibullDataSet constructor already creates a new WeibullEvents, which could be used in place of WEvents in the example below.

       Dim WEvents As New WeibullEvents
       Dim WDS As New WeibullDataSet 

Creates a new list of ParamInputInfo. Populate the list.

       Dim Params As New List(Of ParamInputInfo)
       Params.Add(New ParamInputInfo("Param1", 0, 10, False, True))
       Params.Add(New ParamInputInfo("Param2", 0, Double.MaxValue, False, True))

Prompt user to input the parameters.

       WEvents.GetDistrParameters(WDS, "Message1", True, Params, True)

The new Parameter values are in their respective ParamInputInfo.Value variables.

       Dim NewParameter1value As Double = Params(0).Value
       Dim NewParameter2value As Double = Params(1).Value