ReliaSoft API Reference: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 42: Line 42:


== Classes / Enums ==
== Classes / Enums ==
*'''[[ModelTypeEnum]]''' {{Template:APIComment|RSFittedModel type.}}
*[[ModelTypeEnum]]
*'''[[ModelCategoryEnum]]''' {{Template:APIComment|The Category of the RSFittedModel}}
*'''[[ModelCategoryEnum]]
*'''[[ConfBoundsSides]]''' {{Template:APIComment|Sides of confidence bounds.}}
*'''[[ConfBoundsSides]]
*'''[[ConfBoundsTypes]]''' {{Template:APIComment|Types of confidence bounds}}
*'''[[ConfBoundsTypes]]
*'''[[ConfBoundsMethods]]''' {{APIComment|Methods of confidence bound.}}
*'''[[ConfBoundsMethods]]
*'''[[ParamName]]''' {{Template:APIComment|Name}}
*'''[[ParamName]]
*'''[[ParamBoundsValues Class]]''' {{Template:APIComment|Upper and lower bounds for a model's parameter.}}
*'''[[ParamBoundsValues Class]]
*'''[[ParamValues Class]]''' {{APIComment|Model's parameter name and value.}}
*'''[[ParamValues Class]]


===== [[BoundsValues Class]] =====
===== [[BoundsValues Class]] =====
*'''[[BoundsValues Class]]''' {{Template:APIComment|Upper and lower bounds.}}
*'''[[BoundsValues Class]]
*'''[[BoundsValues.Upper]]''' {{Template:APIComment|Sets Upper bound.}}
*'''[[BoundsValues.Upper]]
*'''[[BoundsValues.Lower]]''' {{Template:APIComment|Sets Lower bound.}}
*'''[[BoundsValues.Lower]]


===== [[ParamInputInfo Class]] =====
===== [[ParamInputInfo Class]] =====
*'''[[ParamInputInfo Class]]''' {{Template:APIComment|Class used for parameters input.}}
*'''[[ParamInputInfo Class]]
*'''[[ParamInputInfo.Name]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Name}}
*'''[[ParamInputInfo.Name]]
*'''[[ParamInputInfo.Min]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Min}}
*'''[[ParamInputInfo.Min]]
*'''[[ParamInputInfo.Max]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Max}}
*'''[[ParamInputInfo.Max]]
*'''[[ParamInputInfo.CanEqualMin]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for CanEqualMin}}
*'''[[ParamInputInfo.CanEqualMin]]
*'''[[ParamInputInfo.CanEqualMax]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for CanEqualMax}}
*'''[[ParamInputInfo.CanEqualMax]]
*'''[[ParamInputInfo.Value]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Value}}
*'''[[ParamInputInfo.Value]]


== Classes / Enums ==
== Classes / Enums ==


*'''[[ResetOptionEnum]]''' {{APIComment|Can be used to assign values to ResetOption within CorrectiveTasks}}
*'''[[ResetOptionEnum]]
*'''[[TaskFrequencyEnum]]''' {{APIComment|Can be used to assign values to TaskFrequency within CorrectiveTasks}}
*'''[[TaskFrequencyEnum]]
*'''[[TaskRestorationTypeEnum]]''' {{APIComment|Can be used to assign values to TaskRestorationType within CorrectiveTasks}}
*'''[[TaskRestorationTypeEnum]]
*'''[[TaskClassEnum]]''' {{APIComment|Can be used to assign values to TaskClass within CorrectiveTasks}}
*'''[[TaskClassEnum]]


== Resource Classes==
== Resource Classes==
Line 91: Line 91:
== Classes / Enums ==
== Classes / Enums ==


*'''[[WAPlotType]]''' {{APIComment|This includes all possible plot types for Weibull / ALTA plots}}
*'''[[WAPlotType]]


===== [[WAPlotSettings Class|WAPlotSettings]] =====
===== [[WAPlotSettings Class|WAPlotSettings]] =====
*'''[[WAPlotSettings Class|WAPlotSettings]]''' {{APIComment|Settings used in Weibull / ALTA plots.}}
*'''[[WAPlotSettings Class|WAPlotSettings]]
*'''[[WAPlotSettings.UserName]]''' {{APIComment|User name that appears on the plot.}}
*'''[[WAPlotSettings.UserName]]
*'''[[WAPlotSettings.UserCompany]]''' {{APIComment|Company name that appears on the plot.}}
*'''[[WAPlotSettings.UserCompany]]
*'''[[WAPlotSettings.AutoscaleX]]''' {{APIComment|Whether the X-scale is calculated automatically.}}
*'''[[WAPlotSettings.AutoscaleX]]
*'''[[WAPlotSettings.AutoscaleY]]''' {{APIComment|Whether the Y-scale is calculated automatically.}}
*'''[[WAPlotSettings.AutoscaleY]]
*'''[[WAPlotSettings.Xmin]]''' {{APIComment|X-scale start. Only used if AutoscaleX is false.}}
*'''[[WAPlotSettings.Xmin]]
*'''[[WAPlotSettings.Xmax]]''' {{APIComment|X-scale end. Only used if AutoscaleX is false.}}
*'''[[WAPlotSettings.Xmax]]
*'''[[WAPlotSettings.Ymin]]''' {{APIComment|Y-scale start. Only used if AutoscaleY is false.}}
*'''[[WAPlotSettings.Ymin]]
*'''[[WAPlotSettings.Ymax]]''' {{APIComment|Y-scale end. Only used if AutoscaleY is false.}}
*'''[[WAPlotSettings.Ymax]]
*'''[[WAPlotSettings.ShowParameterBar]]''' {{APIComment|Whether to show the parameter bars as probability plot.}}
*'''[[WAPlotSettings.ShowParameterBar]]
*'''[[WAPlotSettings.ShowParameterScales]]''' {{APIComment|Whether to show the parameter scales as probability plot.}}
*'''[[WAPlotSettings.ShowParameterScales]]
*'''[[WAPlotSettings.ShowTargetReliability]]''' {{APIComment|Whether to show the target reliability line.}}
*'''[[WAPlotSettings.ShowTargetReliability]]
*'''[[WAPlotSettings.ShowTargetTime]]''' {{APIComment|Whether to show the target time line.}}
*'''[[WAPlotSettings.ShowTargetTime]]
*'''[[WAPlotSettings.ShowTargetMarker]]''' {{APIComment|Whether to show the a marker on the intersection of target reliability and time lines.}}
*'''[[WAPlotSettings.ShowTargetMarker]]
*'''[[WAPlotSettings.TargetReliability]]''' {{APIComment|The value of target reliability.}}
*'''[[WAPlotSettings.TargetReliability]]
*'''[[WAPlotSettings.TargetTime]]''' {{APIComment|The value of target time.}}
*'''[[WAPlotSettings.TargetTime]]
*'''[[WAPlotSettings.ShowSuspensionPoints]]''' {{APIComment|Whether to show suspension points on X-axis.}}
*'''[[WAPlotSettings.ShowSuspensionPoints]]
*'''[[WAPlotSettings.ShowLeftCensoredPoints]]''' {{APIComment|Whether to show left censored points on X-axis.}}
*'''[[WAPlotSettings.ShowLeftCensoredPoints]]
*'''[[WAPlotSettings.ShowLinesAroundInterval]]''' {{APIComment|Whether to show vertical lines around an interval line.}}
*'''[[WAPlotSettings.ShowLinesAroundInterval]]
*'''[[WAPlotSettings.AdjustMLEPoints]]''' {{APIComment|Whether to adjust MLE points.}}
*'''[[WAPlotSettings.AdjustMLEPoints]]
*'''[[WAPlotSettings.StraightenGammaLine]]''' {{APIComment|Whether to streighten the probability line for Gamma and G-Gamma distributions.}}
*'''[[WAPlotSettings.StraightenGammaLine]]
*'''[[WAPlotSettings.ShowNumberInGroup]]''' {{APIComment|Whether to show the number of points in the group for grouped data.}}
*'''[[WAPlotSettings.ShowNumberInGroup]]
*'''[[WAPlotSettings.PlotXPrecision]]''' {{APIComment|Precision for labels on X-axis.}}
*'''[[WAPlotSettings.PlotXPrecision]]
*'''[[WAPlotSettings.PlotYPrecision]]''' {{APIComment|Precision for labels on Y-axis.}}
*'''[[WAPlotSettings.PlotYPrecision]]
*'''[[WAPlotSettings.PlotXTolerance]]''' {{APIComment|Tolerance for labels on X-axis.}}
*'''[[WAPlotSettings.PlotXTolerance]]
*'''[[WAPlotSettings.PlotYTolerance]]''' {{APIComment|Tolerance for labels on Y-axis.}}
*'''[[WAPlotSettings.PlotYTolerance]]
*'''[[WAPlotSettings.ConfBounds_SideSelected]]''' {{APIComment|Sides of the confidence bounds.}}
*'''[[WAPlotSettings.ConfBounds_SideSelected]]
*'''[[WAPlotSettings.ConfBounds_TypesSelected]]''' {{APIComment|Type of the confidence bounds.}}
*'''[[WAPlotSettings.ConfBounds_TypesSelected]]
*'''[[WAPlotSettings.ConfidenceLevel]]''' {{APIComment|Confidence level.}}
*'''[[WAPlotSettings.ConfidenceLevel]]
*'''[[WAPlotSettings.ContourConfLevel]]''' {{APIComment|Confidence level for contour line plot.}}
*'''[[WAPlotSettings.ContourConfLevel]]
*'''[[WAPlotSettings.HistogramInterval]]''' {{APIComment|Interval in histogram plots. Set it to 0 to use the automatically calculated interval.}}
*'''[[WAPlotSettings.HistogramInterval]]
== Classes / Enums ==
== Classes / Enums ==


*'''[[WeibullSolverDistribution]]''' {{Template:APIComment|Available Weibull solver distributions. This includes Weibull, Normal, Exponential, Lognormal, G_Gamma, Logistic, Loglogistic, Gumbel, Gamma, and Bayesian distribution.}}
*'''[[WeibullSolverDistribution]]
*'''[[WeibullSolverNumParameters]]''' {{Template:APIComment|Available Weibull solver distribution parameters. This includes MS_1Parameter, MS_2Parameter, MS_3Parameter, and MS_Mixed.}}
*'''[[WeibullSolverNumParameters]]
*'''[[WeibullSolverMethod]]''' {{Template:APIComment|Available Weibull solver analysis methods. This includes RRX, RRY, and MLE.}}
*'''[[WeibullSolverMethod]]
*'''[[WeibullSolverRankMethod]]''' {{Template:APIComment|Available Weibull solver ranking methods. This includes Median, kaplanMeir, and Actuarial. }}
*'''[[WeibullSolverRankMethod]]
*'''[[WeibullSolverCBMethod]]''' {{Template:APIComment|Available Weibull solver confidence bounds methods. This includes FisherMatrix, LikeihoodRatio, BetaBinomial, and KTO.}}
*'''[[WeibullSolverCBMethod]]
*'''[[WeibullBayesianPriorDistribution]]''' {{Template:APIComment|Available Weibull-Bayesian distributions. This includes Normal, Lognormal, Exponential, and Uniform distributions.}}
*'''[[WeibullBayesianPriorDistribution]]
*'''[[WeibullBayesianResultsOption]]''' {{Template:APIComment|Available Bayesian Weibull-Bayesian result options. This includes Median and Mean.}}
*'''[[WeibullBayesianResultsOption]]


===== [[WeibullGeneralOptions Class|WeibullGeneralOptions]] =====
===== [[WeibullGeneralOptions Class|WeibullGeneralOptions]] =====
*'''[[WeibullGeneralOptions Class|WeibullGeneralOptions]]''' {{Template:APIComment|Weibull solver general options}}
*'''[[WeibullGeneralOptions Class|WeibullGeneralOptions]]
*'''[[WeibullGeneralOptions.WarnNegLocation|WarnNegLocation]]''' {{Template:APIComment|Whether to generate a warning if location parameter is negative.}}
*'''[[WeibullGeneralOptions.WarnNegLocation|WarnNegLocation]]
*'''[[WeibullGeneralOptions.DiscardNegLocation]]''' {{APIComment|For rank regression, resets location parameter to 0. For MLE finds the maximum in the possible domain.}}
*'''[[WeibullGeneralOptions.DiscardNegLocation]]
*'''[[WeibullGeneralOptions.ResetExpLocation]]''' {{Template:APIComment|For exponential distribution with rank regression, if the location parameter is greater than the first time-to-failure (T1), it is reset to T1.}}
*'''[[WeibullGeneralOptions.ResetExpLocation]]
*'''[[WeibullGeneralOptions.Use3PTrueMLE]]''' {{APIComment|Whether to use a full MLE solution on 3-parameter Weibull.}}
*'''[[WeibullGeneralOptions.Use3PTrueMLE]]
*'''[[WeibullGeneralOptions.UseExtendedGGamma]]''' {{APIComment|If set to true, allows the Lambda parameter in the Generalized Gamma distribution to be negative.}}
*'''[[WeibullGeneralOptions.UseExtendedGGamma]]
*'''[[WeibullGeneralOptions.AllowBiasingNormal]]''' {{Template:APIComment|If set to true and using normal distribution (complete data only), corrects the MLE Std (sigma) for biasedness.}}
*'''[[WeibullGeneralOptions.AllowBiasingNormal]]
*'''[[WeibullGeneralOptions.UsePlottedYPoints]]''' {{Template:APIComment|If set to true, uses computed plot points in obtaining D for Kolmogorov-Smirnov test.}}
*'''[[WeibullGeneralOptions.UsePlottedYPoints]]


===== [[WeibullAnalysisOptions Class|WeibullAnalysisOptions]] =====
===== [[WeibullAnalysisOptions Class|WeibullAnalysisOptions]] =====
*'''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]]''' {{Template:APIComment|Weibull solver analysis options}}
*'''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]]
*'''[[WeibullAnalysisOptions.Distribution]]''' {{Template:APIComment|Called by ‘sender’ when a message should be displayed.}}
*'''[[WeibullAnalysisOptions.Distribution]]
*'''[[WeibullAnalysisOptions.Parameters]]''' {{Template:APIComment|Returns an array containing model parameters and their values.}}
*'''[[WeibullAnalysisOptions.Parameters]]
*'''[[WeibullAnalysisOptions.Analysis]]''' {{Template:APIComment|Sets ALTA solver model to MLE}}
*'''[[WeibullAnalysisOptions.Analysis]]
*'''[[WeibullAnalysisOptions.RankingMethod]]''' {{Template:APIComment|Sets ranking method}}
*'''[[WeibullAnalysisOptions.RankingMethod]]
*'''[[WeibullAnalysisOptions.UseRSRegression]]''' {{Template:APIComment|Whether or not to use RSRegression}}
*'''[[WeibullAnalysisOptions.UseRSRegression]]
*'''[[WeibullAnalysisOptions.ConfBounds]]''' {{Template:APIComment|Sets Confidence Bounds}}
*'''[[WeibullAnalysisOptions.ConfBounds]]
*'''[[WeibullAnalysisOptions.UngroupGroupedData]]''' {{Template:APIComment|Whether or not data is ungrouped data}}
*'''[[WeibullAnalysisOptions.UngroupGroupedData]]
*'''[[WeibullAnalysisOptions.Subpopulations]]''' {{Template:APIComment|Mixed Weibull}}
*'''[[WeibullAnalysisOptions.Subpopulations]]
*'''[[WeibullAnalysisOptions.Weibull_UnbiasParameters]]''' {{Template:APIComment|Whether or not to use Weibull Unbias Parameters -Weibull-2 MLE.}}
*'''[[WeibullAnalysisOptions.Weibull_UnbiasParameters]]
*'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]]''' {{Template:APIComment|Bayesian Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]]
*'''[[WeibullAnalysisOptions.Bayesian_Mean]]''' {{Template:APIComment|Sets Bayesian Mean Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_Mean]]
*'''[[WeibullAnalysisOptions.Bayesian_Std]]''' {{Template:APIComment|Sets Bayesian StdDistribution}}
*'''[[WeibullAnalysisOptions.Bayesian_Std]]
*'''[[WeibullAnalysisOptions.Bayesian_Lambda]]''' {{Template:APIComment|Sets Bayesian Lambda Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_Lambda]]
*'''[[WeibullAnalysisOptions.Bayesian_MinBeta]]''' {{Template:APIComment|Sets Bayesian Minimum Beta Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_MinBeta]]
*'''[[WeibullAnalysisOptions.Bayesian_MaxBeta]]''' {{Template:APIComment|Sets Bayesian Maximum Beta Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_MaxBeta]]
*'''[[WeibullAnalysisOptions.Bayesian_Results]]''' {{Template:APIComment|Sets Bayesian Results Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_Results]]
*'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]]''' {{Template:APIComment|Bayesian Distribution}}
*'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]]
*'''[[WeibullAnalysisOptions.SortBeforeCalculations]]''' {{Template:APIComment|Whether or not data is sorted before calculations.}}
*'''[[WeibullAnalysisOptions.SortBeforeCalculations]]
*'''[[WeibullAnalysisOptions.UseSpecialSort]]''' {{Template:APIComment|Whether or not to sort.}}
*'''[[WeibullAnalysisOptions.UseSpecialSort]]


===== [[WeibullBestFitOptions Class|WeibullBestFitOptions]] =====
===== [[WeibullBestFitOptions Class|WeibullBestFitOptions]] =====
*'''[[WeibullBestFitOptions Class|WeibullBestFitOptions]]''' {{Template:APIComment|Whether each weibull distribution is the best fit}}
*'''[[WeibullBestFitOptions Class|WeibullBestFitOptions]]
*'''[[WeibullBestFitOptions.AllowExponential1 ]]''' {{Template:APIComment|Whether Exponential1 is the best fit option}}
*'''[[WeibullBestFitOptions.AllowExponential1 ]]
*'''[[WeibullBestFitOptions.AllowExponential2 ]]''' {{Template:APIComment|Whether Exponential2 is the best fit option}}
*'''[[WeibullBestFitOptions.AllowExponential2 ]]
*'''[[WeibullBestFitOptions.AllowNormal ]]''' {{Template:APIComment|Whether Normal is the best fit option}}
*'''[[WeibullBestFitOptions.AllowNormal ]]
*'''[[WeibullBestFitOptions.AllowLognormal ]]''' {{Template:APIComment|Whether Lognormal is the best fit option}}
*'''[[WeibullBestFitOptions.AllowLognormal ]]
*'''[[WeibullBestFitOptions.AllowWeibull2 ]]''' {{Template:APIComment|Whether Weibull2 is the best fit option}}
*'''[[WeibullBestFitOptions.AllowWeibull2 ]]
*'''[[WeibullBestFitOptions.AllowWeibull3 ]]''' {{Template:APIComment|Whether Weibull3 is the best fit option}}
*'''[[WeibullBestFitOptions.AllowWeibull3 ]]
*'''[[WeibullBestFitOptions.AllowGamma ]]''' {{Template:APIComment|Whether Gamma is the best fit option}}
*'''[[WeibullBestFitOptions.AllowGamma ]]
*'''[[WeibullBestFitOptions.AllowGenGamma ]]''' {{Template:APIComment|Whether GenGamma is the best fit option}}
*'''[[WeibullBestFitOptions.AllowGenGamma ]]
*'''[[WeibullBestFitOptions.AllowLogistic ]]''' {{Template:APIComment|Whether Logistic is the best fit option}}
*'''[[WeibullBestFitOptions.AllowLogistic ]]
*'''[[WeibullBestFitOptions.AllowLoglogistic ]]''' {{Template:APIComment|Whether Loglogistic is the best fit option}}
*'''[[WeibullBestFitOptions.AllowLoglogistic ]]
*'''[[WeibullBestFitOptions.AllowGumbel ]]''' {{Template:APIComment|Whether Gumbel is the best fit option}}
*'''[[WeibullBestFitOptions.AllowGumbel ]]
*'''[[WeibullBestFitOptions.Analysis ]]''' {{Template:APIComment|WSets ALTA solver model to MLE}}
*'''[[WeibullBestFitOptions.Analysis ]]
*'''[[WeibullBestFitOptions.RankingMethod ]]''' {{Template:APIComment|Sets ranking method}}
*'''[[WeibullBestFitOptions.RankingMethod ]]
*'''[[WeibullBestFitOptions.UseRSRegression ]]''' {{Template:APIComment|Whether or not to use RSRegression}}
*'''[[WeibullBestFitOptions.UseRSRegression ]]
*'''[[WeibullBestFitOptions.ConfBounds ]]''' {{Template:APIComment|Sets Confidence Bounds}}
*'''[[WeibullBestFitOptions.ConfBounds ]]
*'''[[WeibullBestFitOptions.UngroupGroupedData ]]''' {{APIComment|Whether or not data is ungrouped data}}
*'''[[WeibullBestFitOptions.UngroupGroupedData ]]
*'''[[WeibullBestFitOptions.SortBeforeCalculations ]]''' {{Template:APIComment|Whether or not data is sorted before calculations.}}
*'''[[WeibullBestFitOptions.SortBeforeCalculations ]]
*'''[[WeibullBestFitOptions.UseSpecialSort ]]''' {{Template:APIComment|Whether or not to sort.}}
*'''[[WeibullBestFitOptions.UseSpecialSort ]]


===== [[WeibullAnalysisResults Class|WeibullAnalysisResults]] =====
===== [[WeibullAnalysisResults Class|WeibullAnalysisResults]] =====
*'''[[WeibullAnalysisResults.CorrelationCoefficient]]''' {{Template:APIComment|The Correlation Coefficient value}}
*'''[[WeibullAnalysisResults.CorrelationCoefficient]]
*'''[[WeibullAnalysisResults.LikelihoodValue]]''' {{Template:APIComment|The LikelihoodValue}}
*'''[[WeibullAnalysisResults.LikelihoodValue]]
*'''[[WeibullAnalysisResults.PercentNonZero]]''' {{Template:APIComment|The PercentNonZero value}}
*'''[[WeibullAnalysisResults.PercentNonZero]]


===== [[WeibullEvents Class|WeibullEvents]] =====
===== [[WeibullEvents Class|WeibullEvents]] =====
*'''[[WeibullEvents Class|WeibullEvents]]''' {{Template:APIComment|Inherit the class, override its methods and assign its instance to the Events property of a Weibull data set to be able to handle its events.}}
*'''[[WeibullEvents Class|WeibullEvents]]
*'''[[WeibullEvents.Message]]''' {{Template:APIComment|Called by ‘sender’ when a message should be displayed.}}
*'''[[WeibullEvents.Message]]
*'''[[WeibullEvents.Question]]''' {{Template:APIComment|Called by ‘sender’ when an answer to the question is required.}}
*'''[[WeibullEvents.Question]]
*'''[[WeibullEvents.GetDistrParameters]]''' {{Template:APIComment|Called by ‘sender’ when additional input is required.}}
*'''[[WeibullEvents.GetDistrParameters]]
*'''[[WeibullEvents.UpdateCalculationProgress]]''' {{Template:APIComment|Called by ‘sender’ when calculation progress should be updated.}}
*'''[[WeibullEvents.UpdateCalculationProgress]]
*'''[[WeibullEvents.ShowCalculationProgress]]''' {{Template:APIComment|Called by ‘sender’ when calculation progress should be shown.}}
*'''[[WeibullEvents.ShowCalculationProgress]]
*'''[[WeibullEvents.HideCalculationProgress]]''' {{Template:APIComment|Called by ‘sender’ when calculation progress should be hidden.}}
*'''[[WeibullEvents.HideCalculationProgress]]

Revision as of 23:06, 8 October 2013

APIWiki.png



The Synthesis API provides a library of classes that can be used to accomplish the exact same tasks as within Synthesis, but instead though Microsoft Visual Studio allowing for a more customizable an automatable solution to reliability engineering.


The Synthesis API can be used in any development environment that supports ActiveX controls, such as Microsoft’s Visual Basic, Visual C, C#, Access or Excel. The sample code and documentation in this manual have been prepared for the Microsoft Visual Studio 2010 (Visual Basic and .Net) development environment and we assume that the user is familiar with programming in that environment.


In order to use this library in a project a reference to ReliaSoft Synthesis API Library is required. It’s located in the folder where ReliaSoft Synthesis is installed. By default it is “C:\Program Files\ReliaSoft\Synthesis 9”.

  • .NET developers – use SynthesisAPI.dll
  • VB6 / VBA developers – use SynthesisAPI.tlb


Below is the list of classes and their methods contained in the library.

Below is a list of classes and enumerations.

Classes / Enums

BoundsValues Class
ParamInputInfo Class

Classes / Enums

Resource Classes

Classes / Enums

WAPlotSettings

Classes / Enums

WeibullGeneralOptions
WeibullAnalysisOptions
WeibullBestFitOptions
WeibullAnalysisResults
WeibullEvents