Talk:Synthesis API Reference/Notes

DRAFT for 10.1.3

Replace the Object Library section of the page with the following draft:

Object Library

Below is a summary of the core objects in the Synthesis API library. For an alphabetical listing of all classes and enumerations in the object library, see API Reference Documentation.

• The Repository object represents the Synthesis repository. All other objects use the functions in this class to read or write data to the repository. This class also contains the functions for importing/exporting XML files.

• The following objects represent the Synthesis resources. Instances of each class can be used to store data for an existing or new resource.
  • cAction
  • cCorrectiveTask
  • cScheduledTask
  • cCrew
  • cModel
  • cPool
  • cURD
  • cVariable
  • cXfmeaControl

• The following objects build data collections for the Synthesis Data Warehouse (SDW).
  • RawData represents a single data point.
  • RawDataSet serves as the data container for the RawData objects.

• The XfmeaItem object represents a system hierarchy item. Instances of this class can be used to store data for a system or assembly, as well as build a multi-level system configuration.

• The following objects represent the FMEA records. Instances of each class can be used to store data for an existing or new FMEA analysis.
  • XfmeaFunction
  • XfmeaCause
  • XfmeaEffect
  • XfmeaFailure

• The WeibullDataSet object represents a Weibull++ standard folio data sheet. Instances of this class are used define a data set and fit a statistical distribution to the data.

• The ALTADataSet object represents an ALTA standard folio data sheet. Instances of this class are used to define a data set, and fit a distribution and life-stress relationship to the data.

• The WAPlots object represents a plot based on the fitted model of a WeibullDataSet or ALTADataSet object. Instances of this class are used to display a plot of the analysis results.