ReliaSoft API Reference

The Synthesis API can be used to accomplish many of the same tasks as within Synthesis applications, and it also enables seamless integration of the Synthesis Platform with other systems within your organization - all through a programmer's own custom-developed code. This gives you access to more customizable and automated solution to reliability engineering problems.

This reference describes all of the programming elements in the API. The sample code and documentation have been prepared for the Microsoft Visual Studio 2010 (Visual Basic and .NET) development environment, and it is assumed that the reader is familiar with programming in that environment.

Requirements
Before using the Synthesis API, note the following requirements:


 * Your code must include a reference to the ReliaSoft Synthesis API Library. The library is located in the folder where ReliaSoft Synthesis is installed. By default, this folder is "C:\Program Files\ReliaSoft\Synthesis 9."
 * .NET developers – use the SynthesisAPI.dll library
 * VB6 / VBA developers – use the SynthesisAPI.tlb library


 * The version of the Synthesis Platform that you've installed (32- vs. 64-bit) must match your installed version of Microsoft Office. If they do not match, you may see an error related to ActiveX controls.

API Elements
The Synthesis API includes a rich set of programming elements that allow you to work with any of the following components of the Synthesis Platform:


 * Repositories:
 * Weibull++ Standard Folio:
 * ALTA Standard Folio:


 * Plots in Weibull++/ALTA:
 * Resources:
 * Displayed Language:

A complete list of all the classes and enumerations in the Synthesis API is available here.

Application Examples
Excel Files

Use the following links to download Excel files (*.xlm) with macros that call the Synthesis API. Note that to run/view the underlying code, the Developer tab must be enabled in Excel so you can enter the Visual Basic for Applications (VBA) environment by choosing Developer > View Code. Also, you must have macros enabled to run the example files. If Excel displays a warning regarding macros in these files, select to enable them. <!--
 * Life Data Analysis in Microsoft Excel (Code explanation)
 * Accelerated Life Testing Analysis (ALTA) in Microsoft Excel (Code explanation)
 * Transfer Data from Excel to the Synthesis Reliability Data Warehouse (RDW)
 * Excel to Standard Repository
 * Excel to Enterprise SQL Repository (Requires reference to a SQL repository)

Formatted Usage Examples
First we will show the importation of a file into BlockSim.

Private WithEvents MyRepository As New Repository

Dim Success As Boolean = False Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")

Dim SuccessImportXML As Boolean SuccessImportXML = MyRepository.ImportXFRACASXMLFile("XMLFilePath")

The file has been imported. Now we will demonstrate the use of Synthesis API in Weibull.

Dim WDS as New WeibullDataSet

WDS.AddFailure(1, 1) WDS.AddFailure(2, 1) WDS.AddFailure(3, 1)

WDS.AddSuspension(1, 1) WDS.AddSuspension(2, 1) WDS.AddSuspension(3, 1)

WDS.Calculate

Dim NumberOfFailures as Integer NumberOfFailures = WDS.FailureCount

WDS.CalculateBestFit

Dim WDSFittedModel as cModel WDSFittedModel = WDS.FittedModel

WDS.ClearDataSet

Dim NumberOfFailures as Integer NumberOfFailures = WDS.FailureCount

The below demonstrates that plots may also be utilized.

Dim WeibullALTAPlot As New WAPlots

Dim WDS As New WeibullDataSet

WDS.AddFailure(1, 1) WDS.AddFailure(2, 1) WDS.AddFailure(3, 1)

WeibullALTAPlot.AddDataset(WDS)

Dim FinalPlot As Bitmap = WeibullALTAPlot.CreatePlot(WAPlotType.Probability)

Dim ErrorString as String If WeibullALTAPlot.ErrorHappened Then ErrorString = WeibullALTAPlot.ErrorMessage End If -->