WeibullDataSet Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
 
(108 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_Weibull|Global Weibull}}  
{{Template:API}}{{Template:APIBreadcrumb}}
{{Template:WeibullDataSet Class.Cmt}}


== Constructors ==
This section contains information on how to create a new Weibull++ folio.
*'''[[New WeibullDataSet]]''' {{APIComment|{{Template:New WeibullDataSet.Cmt}}}}<br>


== Methods ==
<onlyinclude>Represents a data set for life data analysis. </onlyinclude>
This section contains the methods that a user might use to manipulate their Weibull++ data set. A user may use these methods to add failures, suspensions, failure intervals, suspension intervals, free forms, calculate the data set, or clear the data set. This section should be configured after the data set has been created.


*'''[[WeibullDataSet.AddFailure|AddFailure]]''' {{APIComment|{{Template:WeibullDataSet.AddFailure.Cmt}}}}
==Constructor==
*'''[[WeibullDataSet.AddFailureInterval|AddFailureInterval]]''' {{APIComment|{{Template:WeibullDataSet.AddFailureInterval.Cmt}}}}
{| {{APITable}}
*'''[[WeibullDataSet.AddFreeForm|AddFreeForm]]''' {{APIComment|{{Template:WeibullDataSet.AddFreeForm.Cmt}}}}
|-
*'''[[WeibullDataSet.AddSuspension|AddSuspension]]''' {{APIComment|{{Template:WeibullDataSet.AddSuspension.Cmt}}}}
| style="width: 200px;"|WeibullDataSet||Creates an instance of the WeibullDataSet class.
*'''[[WeibullDataSet.AddSuspensionInterval|AddSuspensionInterval]]''' {{APIComment|{{Template:WeibullDataSet.AddSuspensionInterval.Cmt}}}}
|-
*'''[[WeibullDataSet.Calculate|Calculate]]''' {{APIComment|{{Template:WeibullDataSet.Calculate.Cmt}}}}
|[[WeibullDataSet_Constructors|WeibullDataSet()]]||{{:WeibullDataSet_Constructors}}
*'''[[WeibullDataSet.CalculateBestFit|CalculateBestFit]]''' {{APIComment|{{Template:WeibullDataSet.CalculateBestFit.Cmt}}}}
|}
*'''[[WeibullDataSet.ClearDataSet|ClearDataSet]]''' {{APIComment|{{Template:WeibullDataSet.ClearDataSet.Cmt}}}}


== Properties  ==
This section contains properties that a user may use to analyse the data set. The user may choose to have a data set name, have a count of failures, and more.


*'''[[WeibullDataSet.AnalysisResults|AnalysisResults]]''' {{APIComment|{{Template:WeibullDataSet.AnalysisResults.Cmt}}}}
== Methods==
*'''[[WeibullDataSet.AnalysisSettings|AnalysisSettings]]''' {{APIComment|{{Template:WeibullDataSet.AnalysisSettings.Cmt}}}}
{| {{APITable}}
*'''[[WeibullDataSet.BestFitSettings|BestFitSettings]]''' {{APIComment|{{Template:WeibullDataSet.BestFitSettings.Cmt}}}}
|-
*'''[[WeibullDataSet.DatasetName|DatasetName]]''' {{APIComment|{{Template:WeibullDataSet.DatasetName.Cmt}}}}
|style="width: 200px;"|[[WeibullDataSet.AddFailure|AddFailure]]||{{:WeibullDataSet.AddFailure}}
*'''[[WeibullDataSet.FailureCount|FailureCount]]''' {{APIComment|{{Template:WeibullDataSet.FailureCount.Cmt}}}}
|-
*'''[[WeibullDataSet.FittedModel|FittedModel]]''' {{APIComment|{{Template:WeibullDataSet.FittedModel.Cmt}}}}
|[[WeibullDataSet.AddFailureInterval|AddFailureInterval]]||{{:WeibullDataSet.AddFailureInterval}}
*'''[[WeibullDataSet.GeneralSettings|GeneralSettings]]''' {{APIComment|{{Template:WeibullDataSet.GeneralSettings.Cmt}}}}
|-
*'''[[WeibullDataSet.SuspensionCount|SuspensionCount]]''' {{APIComment|{{Template:WeibullDataSet.SuspensionCount.Cmt}}}}<br>
|[[WeibullDataSet.AddFreeForm|AddFreeForm]]||{{:WeibullDataSet.AddFreeForm}}
|-
|[[WeibullDataSet.AddSuspension|AddSuspension]]||{{:WeibullDataSet.AddSuspension}}
|-
|[[WeibullDataSet.AddSuspensionInterval|AddSuspensionInterval]]||{{:WeibullDataSet.AddSuspensionInterval}}
|-
|[[WeibullDataSet.Calculate|Calculate]]||{{:WeibullDataSet.Calculate}}
|-
|[[WeibullDataSet.CalculateBestFit|CalculateBestFit]]||{{:WeibullDataSet.CalculateBestFit}}
|-
|[[WeibullDataSet.ClearDataSet|ClearDataSet]]||{{:WeibullDataSet.ClearDataSet}}
|-
|}


== Events ==
This section allows the user to display events.


*'''[[WeibullEvents Class|Events]]''' {{APIComment|{{Template:WeibullEvents Class.Cmt}}}}<br>
==Properties==
{| {{APITable}}
|-
|style="width: 200px;"|AnalysisResults||Gets the '''[[WeibullAnalysisResults Class|WeibullAnalysisResults]]''' object that represents the correlation coefficient, likelihood ratio and PNZ values from the life data analysis.
|-
|Calculated||Indicates whether the data set has been analyzed. '''Boolean'''. Read only.
|-
|DataSetName||Gets or sets the name of the data set. '''String'''. If no name has been specified, the default name is "Set 1."
|-
|FailureCount||Gets the total number of failures in the data set. '''Double'''
|-
|FittedModel||References the '''[[cModel Class|cModel]]''' object that represents the fitted model of the life data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.
|-
|SuspensionCount||Gets the total number of suspensions in the data set. '''Double'''
|-
|UseCalculationProgress||Indicates whether to display the progress bar while analyzing the data set. '''Boolean'''. Default value = True.
|-
|UseEvents||Indicates whether to enable user-defined event procedures for the <code>WeibullDataSet</code> object. '''Boolean'''. Default value = False.
|}


== Formatted Usage Example ==
==Fields==
{| {{APITable}}
|-
|style="width: 200px;"|AnalysisSettings||References the '''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]]''' object, which represents the analysis settings for the <code>Calculate</code> method. Read-Only.
|-
|BestFitSettings||References the '''[[WeibullBestFitOptions Class|WeibullBestFitOptions]]''' object, which represents the analysis settings for the <code>CalculateBestFit</code> method. Read-Only.
|-
|GeneralSettings||References the '''[[WeibullGeneralOptions Class|WeibullGeneralOptions]]''' object, which represents the calculation settings for both the <code>Calculate</code> and <code>CalculateBestFit</code> methods.  Read-Only.
|}


{{APIComment|Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
        Dim WDS as New WeibullDataSet


{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]] for additional details.}}
==Events==
        WDS.AddFailure(1, 1)
{| {{APITable}}
        WDS.AddFailure(2, 1)
|-
        WDS.AddFailure(3, 1)
| style="width: 200px;"|[[WeibullDataSet.GetDistrParameters|GetDistrParameters]]||{{:WeibullDataSet.GetDistrParameters}}
 
|-
{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddSuspension|AddSuspension]] for additional details.}}
|[[WeibullDataSet.HideCalculationProgress|HideCalculationProgress]]||{{:WeibullDataSet.HideCalculationProgress}}
        WDS.AddSuspension(1, 1)
|-
        WDS.AddSuspension(2, 1)
|[[WeibullDataSet.Message|Message]]||{{:WeibullDataSet.Message}}
        WDS.AddSuspension(3, 1)
|-
 
|[[WeibullDataSet.Question|Question]]||{{:WeibullDataSet.Question}}
{{APIComment|Calculate the WeibullDataSet. See [[WeibullDataSet.Calculate|Calculate]] for additional details.}}
|-
        WDS.Calculate
|[[WeibullDataSet.ShowCalculationProgress|ShowCalculationProgress]]||{{:WeibullDataSet.ShowCalculationProgress}}
 
|-
{{APIComment|Get the number of failures. In this example, NumberOfFailures will be 3.}}
|[[WeibullDataSet.UpdateCalculationProgress|UpdateCalculationProgress]]||{{:WeibullDataSet.UpdateCalculationProgress}}
        Dim NumberOfFailures as Integer
|}
        NumberOfFailures = WDS.FailureCount
 
{{APIComment|Calculate the Fitted Model using the raw data.}}
        WDS.CalculateBestFit
 
{{APIComment|Use the Fitted Model using the raw data.}}
        Dim WDSFittedModel as cModel
        WDSFittedModel = WDS.FittedModel
 
{{APIComment|Use ClearDataSet to clear data and fitted model.}}
        '''WDS.ClearDataSet'''
 
{{APIComment|Get the number of failures. In this example, NumberOfFailures will be 0.}}
        Dim NumberOfFailures as Integer
        NumberOfFailures = WDS.FailureCount

Latest revision as of 18:00, 16 January 2018

APIWiki.png


Member of: SynthesisAPI


Represents a data set for life data analysis.

Constructor

Name Description
WeibullDataSet Creates an instance of the WeibullDataSet class.
WeibullDataSet() A parameterized constructor for the WeibullDataSet class. (.NET only)


Methods

Name Description
AddFailure Adds a failure time to the data set.
AddFailureInterval Adds interval censored failures to the data set.
AddFreeForm Adds a free-form data point to the data set.
AddSuspension Adds suspensions to the data set.
AddSuspensionInterval Adds interval censored suspensions to the data set.
Calculate Fits a life distribution to the current data set and creates a cModel object that represents the fitted model.
CalculateBestFit Determines which of the selected life distributions best fits the data set (similar to the Distribution Wizard feature in Weibull++) and creates a cModel object that represents the fitted model of the recommended distribution.
ClearDataSet Clears all data in the data set and removes the fitted model, if any.


Properties

Name Description
AnalysisResults Gets the WeibullAnalysisResults object that represents the correlation coefficient, likelihood ratio and PNZ values from the life data analysis.
Calculated Indicates whether the data set has been analyzed. Boolean. Read only.
DataSetName Gets or sets the name of the data set. String. If no name has been specified, the default name is "Set 1."
FailureCount Gets the total number of failures in the data set. Double
FittedModel References the cModel object that represents the fitted model of the life data analysis. From the cModel object, you can obtain results such as the reliability, mean time, failure rate, etc.
SuspensionCount Gets the total number of suspensions in the data set. Double
UseCalculationProgress Indicates whether to display the progress bar while analyzing the data set. Boolean. Default value = True.
UseEvents Indicates whether to enable user-defined event procedures for the WeibullDataSet object. Boolean. Default value = False.

Fields

Name Description
AnalysisSettings References the WeibullAnalysisOptions object, which represents the analysis settings for the Calculate method. Read-Only.
BestFitSettings References the WeibullBestFitOptions object, which represents the analysis settings for the CalculateBestFit method. Read-Only.
GeneralSettings References the WeibullGeneralOptions object, which represents the calculation settings for both the Calculate and CalculateBestFit methods. Read-Only.


Events

Name Description
GetDistrParameters Occurs when there is insufficient data to fit a model. Displays a prompt for entering the parameters of the distribution.
HideCalculationProgress Occurs when the calculation process is running. Hides the progress bar.
Message Occurs when an error is produced. Displays an error message.
Question Occurs when an answer to a question is required. Displays a message box with yes and no options.
ShowCalculationProgress Occurs when the calculation process is running. Displays a progress bar.
UpdateCalculationProgress Occurs when the calculation process is running. Displays messages regarding the progress of the calculations.
Retrieved from "https://www.reliawiki.com/index.php?title=WeibullDataSet_Class&oldid=65290"