ReliaSoft API Reference: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 13: Line 13:
The Synthesis API includes a rich set of classes/enumerations that allow you to work with any of the following components of the Synthesis Platform:
The Synthesis API includes a rich set of classes/enumerations that allow you to work with any of the following components of the Synthesis Platform:


 
<ul style="line-height: 2em;">
<ul>


<li>[[Repository Class|Repositories]]<br>
<li>[[Repository Class|Repositories]]<br>
This class allows an application to access and edit Synthesis repositories.<br><br></li>
This class allows an application to access and edit Synthesis repositories.</li>


<li>[[Global Weibull|Weibull++ Standard Folio]]<br>
<li>[[Global Weibull|Weibull++ Standard Folio]]<br>
These classes/enumerations are directly related to accessing the capabilities of a Weibull++ standard folio.<br><br></li>
These classes/enumerations are directly related to accessing the capabilities of a Weibull++ standard folio.</li>


<li>[[Global ALTA|ALTA Standard Folio]]<br>
<li>[[Global ALTA|ALTA Standard Folio]]<br>
These classes/enumerations are directly related to accessing the capabilities of an ALTA standard folio.<br><br></li>
These classes/enumerations are directly related to accessing the capabilities of an ALTA standard folio.</li>


<li>[[Global Model|Weibull++/ALTA Models]]<br>
<li>[[Global Model|Weibull++/ALTA Models]]<br>
These classes/enumerations are used for building models in Weibull++ or ALTA.<br><br></li>  
These classes/enumerations are used for building models in Weibull++ or ALTA.</li>  


<li>[[WAPlots Class|Weibull++/ALTA Plots]]<br>
<li>[[WAPlots Class|Weibull++/ALTA Plots]]<br>
This class is used to create plots generated from the [[WeibullDataSet Class|WeibullDataSet]] or [[ALTADataSet Class|ALTADataSet]] classes.<br><br></li>
This class is used to create plots generated from the [[WeibullDataSet Class|WeibullDataSet]] or [[ALTADataSet Class|ALTADataSet]] classes.</li>


<li>[[Global Resources|Resources]]<br>
<li>[[Global Resources|Resources]]<br>
These classes/enumerations are used to create resources and assign values to them.<br><br></li>
These classes/enumerations are used to create resources and assign values to them.</li>


<li>[[Global Raw Data|Raw Data]]<br>
<li>[[Global Raw Data|Raw Data]]<br>
These classes are used to represent data that are stored in the Reliability Data Warehouse (RDW).<br><br></li>
These classes are used to represent data that are stored in the Reliability Data Warehouse (RDW).</li>


</ul>
</ul>


A complete listing of all the classes and enumerations in the Synthesis API is available [[SynAPIRef.DetailedList|here]].
A complete listing of all the classes and enumerations in the Synthesis API is available [[SynAPIRef.DetailedList|here]].

Revision as of 22:37, 3 February 2014

APIWiki.png



Synthesis API can be used to accomplish the exact same tasks as within Synthesis, but through a programmers own custom-developed code. This allows for a more customizable and automated solution to reliability engineering. 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 programmer is familiar with programming in that environment.


In order to use this library in a project, a reference to the 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


The Synthesis API includes a rich set of classes/enumerations that allow you to work with any of the following components of the Synthesis Platform:

  • Repositories
    This class allows an application to access and edit Synthesis repositories.
  • Weibull++ Standard Folio
    These classes/enumerations are directly related to accessing the capabilities of a Weibull++ standard folio.
  • ALTA Standard Folio
    These classes/enumerations are directly related to accessing the capabilities of an ALTA standard folio.
  • Weibull++/ALTA Models
    These classes/enumerations are used for building models in Weibull++ or ALTA.
  • Weibull++/ALTA Plots
    This class is used to create plots generated from the WeibullDataSet or ALTADataSet classes.
  • Resources
    These classes/enumerations are used to create resources and assign values to them.
  • Raw Data
    These classes are used to represent data that are stored in the Reliability Data Warehouse (RDW).

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