ReliaSoft API Reference: Difference between revisions

Revision as of 22:55, 8 October 2013

The Synthesis API provides a library of classes that can be used to accomplish the exact same tasks as within Synthesis, but instead though Microsoft Visual Studio allowing for a more customizable an automatable solution to reliability engineering.

The Synthesis API can be used in any development environment that supports ActiveX controls, such as Microsoft’s Visual Basic, Visual C, C#, Access or Excel. 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 user is familiar with programming in that environment.

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

Below is the list of classes and their methods contained in the library.

WeibullDataSet Class

ALTADataSet Class

WAPlots Class

Repository Class

Common Class

RawData Class

RawDataSet Class

Below is a list of classes and enumerations.

Classes / Enums

ModelTypeEnum RSFittedModel type.
ModelCategoryEnum The Category of the RSFittedModel
ConfBoundsSides Sides of confidence bounds.
ConfBoundsTypes Types of confidence bounds
ConfBoundsMethods Methods of confidence bound.
ParamName Name
ParamBoundsValues Class Upper and lower bounds for a model's parameter.
ParamValues Class Model's parameter name and value.

BoundsValues Class

BoundsValues Class Upper and lower bounds.
BoundsValues.Upper Sets Upper bound.
BoundsValues.Lower Sets Lower bound.

ParamInputInfo Class

ParamInputInfo Class Class used for parameters input.
ParamInputInfo.Name Parameter input in ParamInputInfo Class for Name
ParamInputInfo.Min Parameter input in ParamInputInfo Class for Min
ParamInputInfo.Max Parameter input in ParamInputInfo Class for Max
ParamInputInfo.CanEqualMin Parameter input in ParamInputInfo Class for CanEqualMin
ParamInputInfo.CanEqualMax Parameter input in ParamInputInfo Class for CanEqualMax
ParamInputInfo.Value Parameter input in ParamInputInfo Class for Value

=Old Stuff

Global_ALTA

Global_Model

Global_Resources

Global_WAPlots

Global_Weibull

@@ Line 31: / Line 31: @@
 *[[RawDataSet Class]]
-==Below is a list of Global Resource folders containing classes and enumerations.==
+==Below is a list of classes and enumerations.==
 *'''[[ALTAStressProfile Class]]
 *'''[[ALTASolverModel]]
@@ Line 40: / Line 40: @@
 *'''[[ALTAAnalysisOptions Class]]
 *'''[[ALTAEvents Class|ALTAEvents]]
+== Classes / Enums ==
+*'''[[ModelTypeEnum]]''' {{Template:APIComment|RSFittedModel type.}}
+*'''[[ModelCategoryEnum]]''' {{Template:APIComment|The Category of the RSFittedModel}}
+*'''[[ConfBoundsSides]]''' {{Template:APIComment|Sides of confidence bounds.}}
+*'''[[ConfBoundsTypes]]''' {{Template:APIComment|Types of confidence bounds}}
+*'''[[ConfBoundsMethods]]''' {{APIComment|Methods of confidence bound.}}
+*'''[[ParamName]]''' {{Template:APIComment|Name}}
+*'''[[ParamBoundsValues Class]]''' {{Template:APIComment|Upper and lower bounds for a model's parameter.}}
+*'''[[ParamValues Class]]''' {{APIComment|Model's parameter name and value.}}
+===== [[BoundsValues Class]] =====
+*'''[[BoundsValues Class]]''' {{Template:APIComment|Upper and lower bounds.}}
+*'''[[BoundsValues.Upper]]''' {{Template:APIComment|Sets Upper bound.}}
+*'''[[BoundsValues.Lower]]''' {{Template:APIComment|Sets Lower bound.}}
+===== [[ParamInputInfo Class]] =====
+*'''[[ParamInputInfo Class]]''' {{Template:APIComment|Class used for parameters input.}}
+*'''[[ParamInputInfo.Name]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Name}}
+*'''[[ParamInputInfo.Min]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Min}}
+*'''[[ParamInputInfo.Max]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Max}}
+*'''[[ParamInputInfo.CanEqualMin]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for CanEqualMin}}
+*'''[[ParamInputInfo.CanEqualMax]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for CanEqualMax}}
+*'''[[ParamInputInfo.Value]]''' {{Template:APIComment|Parameter input in ParamInputInfo Class for Value}}
+===Old Stuff==
 *[[Global_ALTA]]