ReliaSoft API Reference: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 39: Line 39:
** [http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Standard.xlsm Excel to Standard Repository (2.64MB)]
** [http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Standard.xlsm Excel to Standard Repository (2.64MB)]
** [http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Enterprise.xlsm Excel to Enterprise SQL Repository (2.65MB)] ''Requires code modification to reference a SQL repository.''
** [http://www.reliasoft.com/synthesis/api/examples/RDW_Example_Enterprise.xlsm Excel to Enterprise SQL Repository (2.65MB)] ''Requires code modification to reference a SQL repository.''
<!--
== Usage Example ==
{{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.}}
First we will show the importation of a file into BlockSim.
{{APIComment|Declare a new repository connection class.}}
      Private WithEvents MyRepository As New Repository
{{APIComment|Connect to the Synthesis repository.}}
      Dim Success As Boolean = False
      Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")
{{APIComment|Import the XML File to the Synthesis repository.}}
      Dim SuccessImportXML As Boolean
      SuccessImportXML = MyRepository.ImportXFRACASXMLFile("XMLFilePath")
The file has been imported. Now we will demonstrate the use of Synthesis API in Weibull++.
{{APIComment|Declare the WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
        Dim WDS as New WeibullDataSet
{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]] for additional details.}}
        WDS.AddFailure(1, 1)
        WDS.AddFailure(2, 1)
        WDS.AddFailure(3, 1)
{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddSuspension|AddSuspension]] for additional details.}}
        WDS.AddSuspension(1, 1)
        WDS.AddSuspension(2, 1)
        WDS.AddSuspension(3, 1)
{{APIComment|Calculate the WeibullDataSet. See [[WeibullDataSet.Calculate|Calculate]] for additional details.}}
        WDS.Calculate
{{APIComment|Get the number of failures. In this example, NumberOfFailures will be 3. See [[WeibullDataSet.FailureCount|FailureCount]] for additional details.}}
        Dim NumberOfFailures as Integer
        NumberOfFailures = WDS.FailureCount
{{APIComment|Calculate the Fitted Model using the raw data. See [[WeibullDataSet.CalculateBestFit|CalculateBestFit]] for additional details.}}
        WDS.CalculateBestFit
{{APIComment|Use the Fitted Model using the raw data. See [[WeibullDataSet.FittedModel|FittedModel]] for additional details.}}
        Dim WDSFittedModel as cModel
        WDSFittedModel = WDS.FittedModel
{{APIComment|Use ClearDataSet to clear data and fitted model. See [[WeibullDataSet.ClearDataSet|ClearDataSet]] for additional details.}}
        '''WDS.ClearDataSet'''
{{APIComment|Get the number of failures. In this example, NumberOfFailures will be 0. See [[WeibullDataSet.FailureCount|FailureCount]] for additional details.}}
        Dim NumberOfFailures as Integer
        NumberOfFailures = WDS.FailureCount
The below demonstrates that plots may also be utilized.
{{APIComment|Create a new Weibull/ALTA Plot instance.}}
        Dim WeibullALTAPlot As New WAPlots
{{APIComment|Declare a WeibullDataSet. See [[New WeibullDataSet]] for additional details.}}
        Dim WDS As New WeibullDataSet
{{APIComment|Add values to the raw data. See [[WeibullDataSet.AddFailure|AddFailure]] for additional details.}}
        WDS.AddFailure(1, 1)
        WDS.AddFailure(2, 1)
        WDS.AddFailure(3, 1)
{{APIComment|Add the WeibullDataSet to the WAPlots.}}
        WeibullALTAPlot.AddDataset(WDS)
{{APIComment|Create the WAPlot.  In this example, it will create a Probability plot.}}
        Dim FinalPlot As Bitmap = WeibullALTAPlot.CreatePlot(WAPlotType.Probability)
{{APIComment|If there were any issues creating the plot, [[WAPlots.ErrorHappened|ErrorHappened]] would be True, and ErrorString will display the reason.}}
        Dim ErrorString as String
        If WeibullALTAPlot.[[WAPlots.ErrorHappened|ErrorHappened]] Then
            ErrorString = '''WeibullALTAPlot.ErrorMessage'''
        End If
-->

Revision as of 22:25, 27 May 2014

APIWiki.png



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 allows you to create customizable and automated solutions to reliability engineering problems by integrating Synthesis functionality into other applications.

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

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:

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

Application Examples

Excel VBA Samples

Use the following links to download macro-enabled Excel files (*.xlsm) that utilize 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.

Retrieved from "https://www.reliawiki.com/index.php?title=ReliaSoft_API_Reference&oldid=54622"