WeibullDataSet Class: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Alex Ulanov (talk | contribs) |
||
(4 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
<onlyinclude>Represents a | <onlyinclude>Represents a data set for life data analysis. </onlyinclude> | ||
==Constructor== | ==Constructor== | ||
Line 9: | Line 9: | ||
| style="width: 200px;"|WeibullDataSet||Creates an instance of the WeibullDataSet class. | | style="width: 200px;"|WeibullDataSet||Creates an instance of the WeibullDataSet class. | ||
|- | |- | ||
|[[WeibullDataSet_Constructors|WeibullDataSet()]]|| | |[[WeibullDataSet_Constructors|WeibullDataSet()]]||{{:WeibullDataSet_Constructors}} | ||
|} | |} | ||
Line 44: | Line 44: | ||
|DataSetName||Gets or sets the name of the data set. '''String'''. If no name has been specified, the default name is "Set 1." | |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. ''' | |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. | |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. ''' | |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. | |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. | |||
|} | |} | ||
==Fields== | ==Fields== | ||
Line 62: | Line 63: | ||
|- | |- | ||
|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. | |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. | ||
|} | |||
==Events== | |||
{| {{APITable}} | |||
|- | |||
| style="width: 200px;"|[[WeibullDataSet.GetDistrParameters|GetDistrParameters]]||{{:WeibullDataSet.GetDistrParameters}} | |||
|- | |||
|[[WeibullDataSet.HideCalculationProgress|HideCalculationProgress]]||{{:WeibullDataSet.HideCalculationProgress}} | |||
|- | |||
|[[WeibullDataSet.Message|Message]]||{{:WeibullDataSet.Message}} | |||
|- | |||
|[[WeibullDataSet.Question|Question]]||{{:WeibullDataSet.Question}} | |||
|- | |||
|[[WeibullDataSet.ShowCalculationProgress|ShowCalculationProgress]]||{{:WeibullDataSet.ShowCalculationProgress}} | |||
|- | |||
|[[WeibullDataSet.UpdateCalculationProgress|UpdateCalculationProgress]]||{{:WeibullDataSet.UpdateCalculationProgress}} | |||
|} | |} |
Latest revision as of 18:00, 16 January 2018
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. |