ReliaSoft API Reference: Difference between revisions
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
Line 42: | Line 42: | ||
== Classes / Enums == | == Classes / Enums == | ||
* | *[[ModelTypeEnum]] | ||
*'''[[ModelCategoryEnum]] | *'''[[ModelCategoryEnum]] | ||
*'''[[ConfBoundsSides]] | *'''[[ConfBoundsSides]] | ||
*'''[[ConfBoundsTypes]] | *'''[[ConfBoundsTypes]] | ||
*'''[[ConfBoundsMethods]] | *'''[[ConfBoundsMethods]] | ||
*'''[[ParamName]] | *'''[[ParamName]] | ||
*'''[[ParamBoundsValues Class]] | *'''[[ParamBoundsValues Class]] | ||
*'''[[ParamValues Class]] | *'''[[ParamValues Class]] | ||
===== [[BoundsValues Class]] ===== | ===== [[BoundsValues Class]] ===== | ||
*'''[[BoundsValues Class]] | *'''[[BoundsValues Class]] | ||
*'''[[BoundsValues.Upper]] | *'''[[BoundsValues.Upper]] | ||
*'''[[BoundsValues.Lower]] | *'''[[BoundsValues.Lower]] | ||
===== [[ParamInputInfo Class]] ===== | ===== [[ParamInputInfo Class]] ===== | ||
*'''[[ParamInputInfo Class]] | *'''[[ParamInputInfo Class]] | ||
*'''[[ParamInputInfo.Name]] | *'''[[ParamInputInfo.Name]] | ||
*'''[[ParamInputInfo.Min]] | *'''[[ParamInputInfo.Min]] | ||
*'''[[ParamInputInfo.Max]] | *'''[[ParamInputInfo.Max]] | ||
*'''[[ParamInputInfo.CanEqualMin]] | *'''[[ParamInputInfo.CanEqualMin]] | ||
*'''[[ParamInputInfo.CanEqualMax]] | *'''[[ParamInputInfo.CanEqualMax]] | ||
*'''[[ParamInputInfo.Value]] | *'''[[ParamInputInfo.Value]] | ||
== Classes / Enums == | == Classes / Enums == | ||
*'''[[ResetOptionEnum]] | *'''[[ResetOptionEnum]] | ||
*'''[[TaskFrequencyEnum]] | *'''[[TaskFrequencyEnum]] | ||
*'''[[TaskRestorationTypeEnum]] | *'''[[TaskRestorationTypeEnum]] | ||
*'''[[TaskClassEnum]] | *'''[[TaskClassEnum]] | ||
== Resource Classes== | == Resource Classes== | ||
Line 91: | Line 91: | ||
== Classes / Enums == | == Classes / Enums == | ||
*'''[[WAPlotType]] | *'''[[WAPlotType]] | ||
===== [[WAPlotSettings Class|WAPlotSettings]] ===== | ===== [[WAPlotSettings Class|WAPlotSettings]] ===== | ||
*'''[[WAPlotSettings Class|WAPlotSettings]] | *'''[[WAPlotSettings Class|WAPlotSettings]] | ||
*'''[[WAPlotSettings.UserName]] | *'''[[WAPlotSettings.UserName]] | ||
*'''[[WAPlotSettings.UserCompany]] | *'''[[WAPlotSettings.UserCompany]] | ||
*'''[[WAPlotSettings.AutoscaleX]] | *'''[[WAPlotSettings.AutoscaleX]] | ||
*'''[[WAPlotSettings.AutoscaleY]] | *'''[[WAPlotSettings.AutoscaleY]] | ||
*'''[[WAPlotSettings.Xmin]] | *'''[[WAPlotSettings.Xmin]] | ||
*'''[[WAPlotSettings.Xmax]] | *'''[[WAPlotSettings.Xmax]] | ||
*'''[[WAPlotSettings.Ymin]] | *'''[[WAPlotSettings.Ymin]] | ||
*'''[[WAPlotSettings.Ymax]] | *'''[[WAPlotSettings.Ymax]] | ||
*'''[[WAPlotSettings.ShowParameterBar]] | *'''[[WAPlotSettings.ShowParameterBar]] | ||
*'''[[WAPlotSettings.ShowParameterScales]] | *'''[[WAPlotSettings.ShowParameterScales]] | ||
*'''[[WAPlotSettings.ShowTargetReliability]] | *'''[[WAPlotSettings.ShowTargetReliability]] | ||
*'''[[WAPlotSettings.ShowTargetTime]] | *'''[[WAPlotSettings.ShowTargetTime]] | ||
*'''[[WAPlotSettings.ShowTargetMarker]] | *'''[[WAPlotSettings.ShowTargetMarker]] | ||
*'''[[WAPlotSettings.TargetReliability]] | *'''[[WAPlotSettings.TargetReliability]] | ||
*'''[[WAPlotSettings.TargetTime]] | *'''[[WAPlotSettings.TargetTime]] | ||
*'''[[WAPlotSettings.ShowSuspensionPoints]] | *'''[[WAPlotSettings.ShowSuspensionPoints]] | ||
*'''[[WAPlotSettings.ShowLeftCensoredPoints]] | *'''[[WAPlotSettings.ShowLeftCensoredPoints]] | ||
*'''[[WAPlotSettings.ShowLinesAroundInterval]] | *'''[[WAPlotSettings.ShowLinesAroundInterval]] | ||
*'''[[WAPlotSettings.AdjustMLEPoints]] | *'''[[WAPlotSettings.AdjustMLEPoints]] | ||
*'''[[WAPlotSettings.StraightenGammaLine]] | *'''[[WAPlotSettings.StraightenGammaLine]] | ||
*'''[[WAPlotSettings.ShowNumberInGroup]] | *'''[[WAPlotSettings.ShowNumberInGroup]] | ||
*'''[[WAPlotSettings.PlotXPrecision]] | *'''[[WAPlotSettings.PlotXPrecision]] | ||
*'''[[WAPlotSettings.PlotYPrecision]] | *'''[[WAPlotSettings.PlotYPrecision]] | ||
*'''[[WAPlotSettings.PlotXTolerance]] | *'''[[WAPlotSettings.PlotXTolerance]] | ||
*'''[[WAPlotSettings.PlotYTolerance]] | *'''[[WAPlotSettings.PlotYTolerance]] | ||
*'''[[WAPlotSettings.ConfBounds_SideSelected]] | *'''[[WAPlotSettings.ConfBounds_SideSelected]] | ||
*'''[[WAPlotSettings.ConfBounds_TypesSelected]] | *'''[[WAPlotSettings.ConfBounds_TypesSelected]] | ||
*'''[[WAPlotSettings.ConfidenceLevel]] | *'''[[WAPlotSettings.ConfidenceLevel]] | ||
*'''[[WAPlotSettings.ContourConfLevel]] | *'''[[WAPlotSettings.ContourConfLevel]] | ||
*'''[[WAPlotSettings.HistogramInterval]] | *'''[[WAPlotSettings.HistogramInterval]] | ||
== Classes / Enums == | == Classes / Enums == | ||
*'''[[WeibullSolverDistribution]] | *'''[[WeibullSolverDistribution]] | ||
*'''[[WeibullSolverNumParameters]] | *'''[[WeibullSolverNumParameters]] | ||
*'''[[WeibullSolverMethod]] | *'''[[WeibullSolverMethod]] | ||
*'''[[WeibullSolverRankMethod]] | *'''[[WeibullSolverRankMethod]] | ||
*'''[[WeibullSolverCBMethod]] | *'''[[WeibullSolverCBMethod]] | ||
*'''[[WeibullBayesianPriorDistribution]] | *'''[[WeibullBayesianPriorDistribution]] | ||
*'''[[WeibullBayesianResultsOption]] | *'''[[WeibullBayesianResultsOption]] | ||
===== [[WeibullGeneralOptions Class|WeibullGeneralOptions]] ===== | ===== [[WeibullGeneralOptions Class|WeibullGeneralOptions]] ===== | ||
*'''[[WeibullGeneralOptions Class|WeibullGeneralOptions]] | *'''[[WeibullGeneralOptions Class|WeibullGeneralOptions]] | ||
*'''[[WeibullGeneralOptions.WarnNegLocation|WarnNegLocation]] | *'''[[WeibullGeneralOptions.WarnNegLocation|WarnNegLocation]] | ||
*'''[[WeibullGeneralOptions.DiscardNegLocation]] | *'''[[WeibullGeneralOptions.DiscardNegLocation]] | ||
*'''[[WeibullGeneralOptions.ResetExpLocation]] | *'''[[WeibullGeneralOptions.ResetExpLocation]] | ||
*'''[[WeibullGeneralOptions.Use3PTrueMLE]] | *'''[[WeibullGeneralOptions.Use3PTrueMLE]] | ||
*'''[[WeibullGeneralOptions.UseExtendedGGamma]] | *'''[[WeibullGeneralOptions.UseExtendedGGamma]] | ||
*'''[[WeibullGeneralOptions.AllowBiasingNormal]] | *'''[[WeibullGeneralOptions.AllowBiasingNormal]] | ||
*'''[[WeibullGeneralOptions.UsePlottedYPoints]] | *'''[[WeibullGeneralOptions.UsePlottedYPoints]] | ||
===== [[WeibullAnalysisOptions Class|WeibullAnalysisOptions]] ===== | ===== [[WeibullAnalysisOptions Class|WeibullAnalysisOptions]] ===== | ||
*'''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]] | *'''[[WeibullAnalysisOptions Class|WeibullAnalysisOptions]] | ||
*'''[[WeibullAnalysisOptions.Distribution]] | *'''[[WeibullAnalysisOptions.Distribution]] | ||
*'''[[WeibullAnalysisOptions.Parameters]] | *'''[[WeibullAnalysisOptions.Parameters]] | ||
*'''[[WeibullAnalysisOptions.Analysis]] | *'''[[WeibullAnalysisOptions.Analysis]] | ||
*'''[[WeibullAnalysisOptions.RankingMethod]] | *'''[[WeibullAnalysisOptions.RankingMethod]] | ||
*'''[[WeibullAnalysisOptions.UseRSRegression]] | *'''[[WeibullAnalysisOptions.UseRSRegression]] | ||
*'''[[WeibullAnalysisOptions.ConfBounds]] | *'''[[WeibullAnalysisOptions.ConfBounds]] | ||
*'''[[WeibullAnalysisOptions.UngroupGroupedData]] | *'''[[WeibullAnalysisOptions.UngroupGroupedData]] | ||
*'''[[WeibullAnalysisOptions.Subpopulations]] | *'''[[WeibullAnalysisOptions.Subpopulations]] | ||
*'''[[WeibullAnalysisOptions.Weibull_UnbiasParameters]] | *'''[[WeibullAnalysisOptions.Weibull_UnbiasParameters]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]] | *'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_Mean]] | *'''[[WeibullAnalysisOptions.Bayesian_Mean]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_Std]] | *'''[[WeibullAnalysisOptions.Bayesian_Std]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_Lambda]] | *'''[[WeibullAnalysisOptions.Bayesian_Lambda]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_MinBeta]] | *'''[[WeibullAnalysisOptions.Bayesian_MinBeta]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_MaxBeta]] | *'''[[WeibullAnalysisOptions.Bayesian_MaxBeta]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_Results]] | *'''[[WeibullAnalysisOptions.Bayesian_Results]] | ||
*'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]] | *'''[[WeibullAnalysisOptions.Bayesian_PriorDistribution]] | ||
*'''[[WeibullAnalysisOptions.SortBeforeCalculations]] | *'''[[WeibullAnalysisOptions.SortBeforeCalculations]] | ||
*'''[[WeibullAnalysisOptions.UseSpecialSort]] | *'''[[WeibullAnalysisOptions.UseSpecialSort]] | ||
===== [[WeibullBestFitOptions Class|WeibullBestFitOptions]] ===== | ===== [[WeibullBestFitOptions Class|WeibullBestFitOptions]] ===== | ||
*'''[[WeibullBestFitOptions Class|WeibullBestFitOptions]] | *'''[[WeibullBestFitOptions Class|WeibullBestFitOptions]] | ||
*'''[[WeibullBestFitOptions.AllowExponential1 ]] | *'''[[WeibullBestFitOptions.AllowExponential1 ]] | ||
*'''[[WeibullBestFitOptions.AllowExponential2 ]] | *'''[[WeibullBestFitOptions.AllowExponential2 ]] | ||
*'''[[WeibullBestFitOptions.AllowNormal ]] | *'''[[WeibullBestFitOptions.AllowNormal ]] | ||
*'''[[WeibullBestFitOptions.AllowLognormal ]] | *'''[[WeibullBestFitOptions.AllowLognormal ]] | ||
*'''[[WeibullBestFitOptions.AllowWeibull2 ]] | *'''[[WeibullBestFitOptions.AllowWeibull2 ]] | ||
*'''[[WeibullBestFitOptions.AllowWeibull3 ]] | *'''[[WeibullBestFitOptions.AllowWeibull3 ]] | ||
*'''[[WeibullBestFitOptions.AllowGamma ]] | *'''[[WeibullBestFitOptions.AllowGamma ]] | ||
*'''[[WeibullBestFitOptions.AllowGenGamma ]] | *'''[[WeibullBestFitOptions.AllowGenGamma ]] | ||
*'''[[WeibullBestFitOptions.AllowLogistic ]] | *'''[[WeibullBestFitOptions.AllowLogistic ]] | ||
*'''[[WeibullBestFitOptions.AllowLoglogistic ]] | *'''[[WeibullBestFitOptions.AllowLoglogistic ]] | ||
*'''[[WeibullBestFitOptions.AllowGumbel ]] | *'''[[WeibullBestFitOptions.AllowGumbel ]] | ||
*'''[[WeibullBestFitOptions.Analysis ]] | *'''[[WeibullBestFitOptions.Analysis ]] | ||
*'''[[WeibullBestFitOptions.RankingMethod ]] | *'''[[WeibullBestFitOptions.RankingMethod ]] | ||
*'''[[WeibullBestFitOptions.UseRSRegression ]] | *'''[[WeibullBestFitOptions.UseRSRegression ]] | ||
*'''[[WeibullBestFitOptions.ConfBounds ]] | *'''[[WeibullBestFitOptions.ConfBounds ]] | ||
*'''[[WeibullBestFitOptions.UngroupGroupedData ]] | *'''[[WeibullBestFitOptions.UngroupGroupedData ]] | ||
*'''[[WeibullBestFitOptions.SortBeforeCalculations ]] | *'''[[WeibullBestFitOptions.SortBeforeCalculations ]] | ||
*'''[[WeibullBestFitOptions.UseSpecialSort ]] | *'''[[WeibullBestFitOptions.UseSpecialSort ]] | ||
===== [[WeibullAnalysisResults Class|WeibullAnalysisResults]] ===== | ===== [[WeibullAnalysisResults Class|WeibullAnalysisResults]] ===== | ||
*'''[[WeibullAnalysisResults.CorrelationCoefficient]] | *'''[[WeibullAnalysisResults.CorrelationCoefficient]] | ||
*'''[[WeibullAnalysisResults.LikelihoodValue]] | *'''[[WeibullAnalysisResults.LikelihoodValue]] | ||
*'''[[WeibullAnalysisResults.PercentNonZero]] | *'''[[WeibullAnalysisResults.PercentNonZero]] | ||
===== [[WeibullEvents Class|WeibullEvents]] ===== | ===== [[WeibullEvents Class|WeibullEvents]] ===== | ||
*'''[[WeibullEvents Class|WeibullEvents]] | *'''[[WeibullEvents Class|WeibullEvents]] | ||
*'''[[WeibullEvents.Message]] | *'''[[WeibullEvents.Message]] | ||
*'''[[WeibullEvents.Question]] | *'''[[WeibullEvents.Question]] | ||
*'''[[WeibullEvents.GetDistrParameters]] | *'''[[WeibullEvents.GetDistrParameters]] | ||
*'''[[WeibullEvents.UpdateCalculationProgress]] | *'''[[WeibullEvents.UpdateCalculationProgress]] | ||
*'''[[WeibullEvents.ShowCalculationProgress]] | *'''[[WeibullEvents.ShowCalculationProgress]] | ||
*'''[[WeibullEvents.HideCalculationProgress]] | *'''[[WeibullEvents.HideCalculationProgress]] |
Revision as of 23:06, 8 October 2013
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.
- ALTAStressProfile Class
- ALTASolverModel
- ALTASolverDistribution
- ALTASolverMethod
- ALTASolverLSR
- ALTAGeneralOptions Class
- ALTAAnalysisOptions Class
- ALTAEvents
Classes / Enums
- ModelTypeEnum
- ModelCategoryEnum
- ConfBoundsSides
- ConfBoundsTypes
- ConfBoundsMethods
- ParamName
- ParamBoundsValues Class
- ParamValues Class
BoundsValues Class
ParamInputInfo Class
- ParamInputInfo Class
- ParamInputInfo.Name
- ParamInputInfo.Min
- ParamInputInfo.Max
- ParamInputInfo.CanEqualMin
- ParamInputInfo.CanEqualMax
- ParamInputInfo.Value
Classes / Enums
Resource Classes
Classes / Enums
WAPlotSettings
- WAPlotSettings
- WAPlotSettings.UserName
- WAPlotSettings.UserCompany
- WAPlotSettings.AutoscaleX
- WAPlotSettings.AutoscaleY
- WAPlotSettings.Xmin
- WAPlotSettings.Xmax
- WAPlotSettings.Ymin
- WAPlotSettings.Ymax
- WAPlotSettings.ShowParameterBar
- WAPlotSettings.ShowParameterScales
- WAPlotSettings.ShowTargetReliability
- WAPlotSettings.ShowTargetTime
- WAPlotSettings.ShowTargetMarker
- WAPlotSettings.TargetReliability
- WAPlotSettings.TargetTime
- WAPlotSettings.ShowSuspensionPoints
- WAPlotSettings.ShowLeftCensoredPoints
- WAPlotSettings.ShowLinesAroundInterval
- WAPlotSettings.AdjustMLEPoints
- WAPlotSettings.StraightenGammaLine
- WAPlotSettings.ShowNumberInGroup
- WAPlotSettings.PlotXPrecision
- WAPlotSettings.PlotYPrecision
- WAPlotSettings.PlotXTolerance
- WAPlotSettings.PlotYTolerance
- WAPlotSettings.ConfBounds_SideSelected
- WAPlotSettings.ConfBounds_TypesSelected
- WAPlotSettings.ConfidenceLevel
- WAPlotSettings.ContourConfLevel
- WAPlotSettings.HistogramInterval
Classes / Enums
- WeibullSolverDistribution
- WeibullSolverNumParameters
- WeibullSolverMethod
- WeibullSolverRankMethod
- WeibullSolverCBMethod
- WeibullBayesianPriorDistribution
- WeibullBayesianResultsOption
WeibullGeneralOptions
- WeibullGeneralOptions
- WarnNegLocation
- WeibullGeneralOptions.DiscardNegLocation
- WeibullGeneralOptions.ResetExpLocation
- WeibullGeneralOptions.Use3PTrueMLE
- WeibullGeneralOptions.UseExtendedGGamma
- WeibullGeneralOptions.AllowBiasingNormal
- WeibullGeneralOptions.UsePlottedYPoints
WeibullAnalysisOptions
- WeibullAnalysisOptions
- WeibullAnalysisOptions.Distribution
- WeibullAnalysisOptions.Parameters
- WeibullAnalysisOptions.Analysis
- WeibullAnalysisOptions.RankingMethod
- WeibullAnalysisOptions.UseRSRegression
- WeibullAnalysisOptions.ConfBounds
- WeibullAnalysisOptions.UngroupGroupedData
- WeibullAnalysisOptions.Subpopulations
- WeibullAnalysisOptions.Weibull_UnbiasParameters
- WeibullAnalysisOptions.Bayesian_PriorDistribution
- WeibullAnalysisOptions.Bayesian_Mean
- WeibullAnalysisOptions.Bayesian_Std
- WeibullAnalysisOptions.Bayesian_Lambda
- WeibullAnalysisOptions.Bayesian_MinBeta
- WeibullAnalysisOptions.Bayesian_MaxBeta
- WeibullAnalysisOptions.Bayesian_Results
- WeibullAnalysisOptions.Bayesian_PriorDistribution
- WeibullAnalysisOptions.SortBeforeCalculations
- WeibullAnalysisOptions.UseSpecialSort
WeibullBestFitOptions
- WeibullBestFitOptions
- WeibullBestFitOptions.AllowExponential1
- WeibullBestFitOptions.AllowExponential2
- WeibullBestFitOptions.AllowNormal
- WeibullBestFitOptions.AllowLognormal
- WeibullBestFitOptions.AllowWeibull2
- WeibullBestFitOptions.AllowWeibull3
- WeibullBestFitOptions.AllowGamma
- WeibullBestFitOptions.AllowGenGamma
- WeibullBestFitOptions.AllowLogistic
- WeibullBestFitOptions.AllowLoglogistic
- WeibullBestFitOptions.AllowGumbel
- WeibullBestFitOptions.Analysis
- WeibullBestFitOptions.RankingMethod
- WeibullBestFitOptions.UseRSRegression
- WeibullBestFitOptions.ConfBounds
- WeibullBestFitOptions.UngroupGroupedData
- WeibullBestFitOptions.SortBeforeCalculations
- WeibullBestFitOptions.UseSpecialSort
WeibullAnalysisResults
- WeibullAnalysisResults.CorrelationCoefficient
- WeibullAnalysisResults.LikelihoodValue
- WeibullAnalysisResults.PercentNonZero