ReliaSoft API Reference

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.

• WeibullDataSet Class

• ALTADataSet Class

• WAPlots Class

• Repository Class

• Common Class

• RawData Class

• RawDataSet Class

Below is a list of classes and enumerations.

• ALTAStressProfile Class
• ALTASolverModel
• ALTASolverDistribution
• ALTASolverMethod
• ALTASolverLSR
• ALTAGeneralOptions Class
• ALTAAnalysisOptions Class
• ALTAEvents

Classes / Enums

• ModelTypeEnum RSFittedModel type.
• ModelCategoryEnum The Category of the RSFittedModel
• ConfBoundsSides Sides of confidence bounds.
• ConfBoundsTypes Types of confidence bounds
• ConfBoundsMethods Methods of confidence bound.
• ParamName Name
• ParamBoundsValues Class Upper and lower bounds for a model's parameter.
• ParamValues Class Model's parameter name and value.

BoundsValues Class

• BoundsValues Class Upper and lower bounds.
• BoundsValues.Upper Sets Upper bound.
• BoundsValues.Lower Sets Lower bound.

ParamInputInfo Class

• ParamInputInfo Class Class used for parameters input.
• ParamInputInfo.Name Parameter input in ParamInputInfo Class for Name
• ParamInputInfo.Min Parameter input in ParamInputInfo Class for Min
• ParamInputInfo.Max Parameter input in ParamInputInfo Class for Max
• ParamInputInfo.CanEqualMin Parameter input in ParamInputInfo Class for CanEqualMin
• ParamInputInfo.CanEqualMax Parameter input in ParamInputInfo Class for CanEqualMax
• ParamInputInfo.Value Parameter input in ParamInputInfo Class for Value

Classes / Enums

• ResetOptionEnum Can be used to assign values to ResetOption within CorrectiveTasks
• TaskFrequencyEnum Can be used to assign values to TaskFrequency within CorrectiveTasks
• TaskRestorationTypeEnum Can be used to assign values to TaskRestorationType within CorrectiveTasks
• TaskClassEnum Can be used to assign values to TaskClass within CorrectiveTasks

Resource Classes

• cModel Class

• cAction Class

• cURD Class

• cVariable Class

• cCrew Class

• cPool Class

• cCorrectiveTask Class

• cScheduledTask Class

Classes / Enums

• WAPlotType This includes all possible plot types for Weibull / ALTA plots

WAPlotSettings

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

Classes / Enums

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

WeibullGeneralOptions

• WeibullGeneralOptions Weibull solver general options
• WarnNegLocation Whether to generate a warning if location parameter is negative.
• WeibullGeneralOptions.DiscardNegLocation For rank regression, resets location parameter to 0. For MLE finds the maximum in the possible domain.
• WeibullGeneralOptions.ResetExpLocation 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.Use3PTrueMLE Whether to use a full MLE solution on 3-parameter Weibull.
• WeibullGeneralOptions.UseExtendedGGamma If set to true, allows the Lambda parameter in the Generalized Gamma distribution to be negative.
• WeibullGeneralOptions.AllowBiasingNormal If set to true and using normal distribution (complete data only), corrects the MLE Std (sigma) for biasedness.
• WeibullGeneralOptions.UsePlottedYPoints If set to true, uses computed plot points in obtaining D for Kolmogorov-Smirnov test.

WeibullAnalysisOptions

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

WeibullBestFitOptions

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

WeibullAnalysisResults

• WeibullAnalysisResults.CorrelationCoefficient The Correlation Coefficient value
• WeibullAnalysisResults.LikelihoodValue The LikelihoodValue
• WeibullAnalysisResults.PercentNonZero The PercentNonZero value

WeibullEvents

• WeibullEvents 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.Message Called by ‘sender’ when a message should be displayed.
• WeibullEvents.Question Called by ‘sender’ when an answer to the question is required.
• WeibullEvents.GetDistrParameters Called by ‘sender’ when additional input is required.
• WeibullEvents.UpdateCalculationProgress Called by ‘sender’ when calculation progress should be updated.
• WeibullEvents.ShowCalculationProgress Called by ‘sender’ when calculation progress should be shown.
• WeibullEvents.HideCalculationProgress Called by ‘sender’ when calculation progress should be hidden.