ReliaSoft API Reference: Difference between revisions

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


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





Revision as of 22:57, 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

  • 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

Classes / Enums

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


=Old Stuff