ReliaSoft API Reference: Difference between revisions
Chris Kahn (talk | contribs) No edit summary |
Chris Kahn (talk | contribs) No edit summary |
||
| Line 28: | Line 28: | ||
*'''[[Global Common|Displayed Language]]''': {{Template:Global Common.Cmt}} | *'''[[Global Common|Displayed Language]]''': {{Template:Global Common.Cmt}} | ||
A complete list of all the classes and enumerations in the Synthesis API is available [[Full Synthesis API|here]]. | A complete list of all the classes and enumerations in the Synthesis API is available [[Full Synthesis API|here]].<!-- | ||
<!-- | |||
== Formatted Usage Examples == | == Formatted Usage Examples == | ||
{{APIComment|These formatted examples begin with an XML file, import it into the synthesis repository, add data, perform calculations, perform an analysis, and show results. Finally, they create a plot and display a message.}} | {{APIComment|These formatted examples begin with an XML file, import it into the synthesis repository, add data, perform calculations, perform an analysis, and show results. Finally, they create a plot and display a message.}} | ||
Revision as of 00:14, 1 March 2014
 |
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 a more customizable and automated solution to reliability engineering.
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 must match your installed version of Microsoft Office. See this support document for details.
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: Template:Repository Class.Cmt
- Weibull++ Standard Folio: Provides the functionality of a Weibull++ standard folio, including entering data in a data set, specifying analysis settings and fitting a distribution to the data set.
- ALTA Standard Folio: Provides the functionality of an ALTA standard folio, including entering data in a data set, specifying analysis settings and fitting a distribution and life-stress relationship to the data set.
- Models in Weibull++/ALTA: Build models in Weibull++/ALTA.
- Plots in Weibull++/ALTA: Generate plots from a Weibull++/ALTA standard folio.
- Resources: Use these classes to create resources, edit their properties and calculate reliability metrics from fitted models.
- Raw Reliability Data: Work with raw reliability data that can be stored in the Reliability Data Warehouse (RDW).
- Displayed Language: Set the language that will be used for the entire library.
A complete list of all the classes and enumerations in the Synthesis API is available here.