Calculate Results from a Model - Revision history

Kate Racaza at 18:22, 3 April 2017

2017-04-03T18:22:47Z

Kate Racaza at 15:23, 7 September 2016

2016-09-07T15:23:10Z

← Older revision		Revision as of 15:23, 7 September 2016
Line 14:		Line 14:
	The following example demonstrates how to obtain calculated results from a model resource. A discussion of the example follows.		The following example demonstrates how to obtain calculated results from a model resource. A discussion of the example follows.

	A VBA version of the code sample is available [[Calculate_Results_from_a_Model/VBA\|here]].		The VBA version of the code sample is available [[Calculate_Results_from_a_Model/VBA\|here]].

	'''VB.NET'''		'''VB.NET'''

Kate Racaza at 20:56, 12 May 2016

2016-05-12T20:56:32Z

← Older revision		Revision as of 20:56, 12 May 2016
Line 126:		Line 126:
	===References===		===References===
	*[[CModel Class]]		*[[CModel Class]]
	*[[CModel.Reliability\|cModel.Reliability Method]]		**[[CModel.Reliability\|cModel.Reliability Method]]
	*[[CModel.MeanTime\|cModel.MeanTime Method]]		**[[CModel.MeanTime\|cModel.MeanTime Method]]
	*[[CModel.SetConfidenceLevel\|cModel.SetConfidenceLevel Method]]		**[[CModel.SetConfidenceLevel\|cModel.SetConfidenceLevel Method]]
	*[[CModel.Bounds_Reliability\|cModel.Bounds_Reliability Method]]		**[[CModel.Bounds_Reliability\|cModel.Bounds_Reliability Method]]
	*[[CModel.Bounds_MeanTime\|cModel.Bounds_MeanTime Method]]		**[[CModel.Bounds_MeanTime\|cModel.Bounds_MeanTime Method]]
	*[[BoundsValues Class]]		*[[BoundsValues Class]]

Kate Racaza at 18:27, 5 May 2016

2016-05-05T18:27:51Z

← Older revision		Revision as of 18:27, 5 May 2016
Line 1:		Line 1:
	{{Template:API}}{{Template:BacktoPrevPage~~\|[[API Tutorials\|<< Back to Tutorials Main Page]]~~}}		{{Template:API}}{{Template:BacktoPrevPage}}

	In Synthesis applications, models can represent the reliability of a component, the duration of a task, the expected cost of a repair and many other characteristics. In this tutorial, you'll learn how to calculate some useful metrics from models.		In Synthesis applications, models can represent the reliability of a component, the duration of a task, the expected cost of a repair and many other characteristics. In this tutorial, you'll learn how to calculate some useful metrics from models.

Kate Racaza at 16:51, 29 April 2016

2016-04-29T16:51:21Z

← Older revision		Revision as of 16:51, 29 April 2016
Line 63:		Line 63:
	{{APIPrefix\|End Sub}}		{{APIPrefix\|End Sub}}
	{{APIPrefix\|End Module}}		{{APIPrefix\|End Module}}


	==Discussion==		==Discussion==
Line 117:		Line 116:


	===Notes===		==Notes==
	For ALTA models, you can specify the use stress level to use for the calculations by using the [[CModel.SetUseStress\|cModel.SetUseStress]] method. For example, the following code returns the reliability at 100 hrs for a use stress level of 200 (the 0 ~~parameter~~ indicates that the stress value applies to the first stress in the model):		For ALTA models, you can specify the use stress level to use for the calculations by using the [[CModel.SetUseStress\|cModel.SetUseStress]] method. For example, the following code returns the reliability at 100 hrs for a use stress level of 200 (the value 0 indicates that the stress value applies to the first stress in the model):

	{{APIComment\|...}}		{{APIComment\|...}}
Line 124:		Line 123:
	AModel.SetUseStress(0, 200)		AModel.SetUseStress(0, 200)
	Result1 = AModel.Reliability(100)		Result1 = AModel.Reliability(100)


	===References===		===References===

Kate Racaza at 17:32, 28 April 2016

2016-04-28T17:32:15Z

← Older revision		Revision as of 17:32, 28 April 2016
Line 6:		Line 6:
	Before you begin:		Before you begin:

	*Create a ~~test~~ repository (can use [http://weibull.reliasoft.com/ Weibull++] or [http://alta.reliasoft.com/ ALTA])~~. Perform a simple analysis~~ and then publish a model of the analysis. You'll want to use a published model with this tutorial so you can perform confidence bounds calculations.		*Create a Synthesis repository for testing purposes. Perform a simple analysis (can use [http://weibull.reliasoft.com/ Weibull++] or [http://alta.reliasoft.com/ ALTA]) and then publish a model of the analysis. You'll want to use a published model with this tutorial so you can perform confidence bounds calculations.

	*Note the published model's object ID number. You will use the ID# to retrieve the model from the database. (To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.)		*Note the published model's object ID number. You will use the ID# to retrieve the model from the database. (To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.)

Kate Racaza at 17:14, 28 April 2016

2016-04-28T17:14:24Z

Show changes

Kate Racaza: /* Notes */

2016-02-17T16:33:59Z

Notes

← Older revision		Revision as of 16:33, 17 February 2016
Line 197:		Line 197:

	===Notes===		===Notes===
	See <code>[[CModel Class\|cModel]]</code> class for a list of all ~~possible~~ calculation methods for models.		See <code>[[CModel Class\|cModel]]</code> class for a list of all available calculation methods for models.

	===References===		===References===

Kate Racaza: /* References */

2016-02-17T16:33:38Z

References

← Older revision		Revision as of 16:33, 17 February 2016
Line 200:		Line 200:

	===References===		===References===
	To learn more, see the reference documentation for the class and methods discussed in this ~~section~~:		To learn more, see the reference documentation for the class and methods discussed in this tutorial:

	*[[CModel.Reliability\|cModel.Reliability Method]]		*[[CModel.Reliability\|cModel.Reliability Method]]

Kate Racaza: Created page with '{{Template:API}}
<< [[API …'

2016-02-09T23:42:11Z

Created page with '{{Template:API}} <div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;"> <nowiki><<</nowiki> [[API …'

New page

{{Template:API}}
<div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;">
<nowiki><<</nowiki> [[API Tutorials|Back to API Tutorials]]

'''Basics'''
#[[Connect or Disconnect from a Synthesis Repository]]
#[[Add New Synthesis Resources to a Repository]]
#[[Edit Existing Synthesis Resources]]
#[[Calculate Results from a Model]]
</div>

Models are used by other Synthesis resources to represent the reliability of a task, the duration of a task, the expected cost of a repair, and many other characteristics. In this tutorial, you'll learn how to obtain calculated results from models.

Before you begin, publish a model from the repository and note the model's object ID number (see [[Using Object IDs]]). You will use the object ID number to retrieve the model, so you can compare the results returned by the API with the results obtained from the Quick Calculation Pad (QCP).

==Calculate Results from a Model==

1. Create a new module and begin by connecting to a Synthesis repository and project. The following code assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive.

{{APIComment|'Connect to the Synthesis repository and set project ID#1 as the current project.}}
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
MyRepository.Project.SetCurrentProject(1)

2. Retrieve a model from the repository. The following code assumes that the repository contains a model with ID number 21.

'''VBA'''

{{APIComment|'Retrieve the model with ID# 21 from the repository.}}
{{APIPrefix|Dim}} Amodel {{APIPrefix|As New}} cModel
{{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(21)

'''VB.NET'''

{{APIComment|'Retrieve the model with ID# 21 from the repository.}}
{{APIPrefix|Dim}} Amodel {{APIPrefix|As New}} cModel
AModel = MyRepository.Model.GetModel(21)

2. Use the <code>Reliability</code> method to calculate for the reliability at 100 hrs and the <code>MeanTime</code> method to return the mean time to failure.

{{APIComment|'Declare variables.}}
{{APIPrefix|Dim}} Result1 {{APIPrefix|As}} Double
{{APIPrefix|Dim}} Result2 {{APIPrefix|As}} Double

{{APIComment|'Calculate the model's reliability at time = 100 hrs and mean time.}}
Result1 = AModel.Reliability(100)
Result2 = AModel.MeanTime

3. Let's add confidence bounds calculations to the results. Use the <code>SetConfidenceLevel</code> method to specify 90% two-sided confidence bounds.

'''VBA'''

{{APIComment|'Set the confidence level to 90% two-sided bounds.}}
{{APIComment|'Declare a string variable for any errors found during this method.}}
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
{{APIPrefix|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)

{{APIComment|'Initiate new instances of the BoundsValues class.}}
{{APIPrefix|Dim}} BResult1 {{APIPrefix|As}} BoundsValues
{{APIPrefix|Dim}} BResult2 {{APIPrefix|As}} BoundsValues

{{APIComment|'Calculate bounds for the reliability at 100 hrs and the mean time.}}
{{APIPrefix|Set}} BResult1 = AModel.Bounds_Reliability(100)
{{APIPrefix|Set}} BResult2 = AModel.Bounds_MeanTime

{{APIComment|'Display the output.}}
MsgBox ({{APIString|"Reliability <nowiki>=</nowiki> "}} & Result1 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult1.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult1.lower & vbNewLine)
MsgBox ({{APIString|"Mean Time <nowiki>=</nowiki> "}} & Result2 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult2.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult2.lower & vbNewLine)

'''VB.NET'''

{{APIComment|'Set the confidence level to 90% two-sided bounds.}}
{{APIComment|'Declare a string variable for any errors found during this method.}}
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)

{{APIComment|'Initiate new instances of the BoundsValues class.}}
{{APIPrefix|Dim}} BResult1 {{APIPrefix|As}} BoundsValues
{{APIPrefix|Dim}} BResult2 {{APIPrefix|As}} BoundsValues

{{APIComment|'Calculate bounds for the reliability at 100 hrs and the mean time.}}
BResult1 = AModel.Bounds_Reliability(100)
BResult2 = AModel.Bounds_MeanTime

{{APIComment|'Display the output.}}
MsgBox ({{APIString|"Reliability <nowiki>=</nowiki> "}} & Result1 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult1.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult1.lower & vbNewLine)
MsgBox ({{APIString|"Mean Time <nowiki>=</nowiki> "}} & Result2 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult2.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult2.lower & vbNewLine)

===Test the Code===
Below are the complete code lists for this example. To test them, run the application by clicking '''Start''' on the Debug menu. Compare the results returned by the API with the results obtained from the Quick Calculation Pad (QCP).

'''VBA'''

Sub Main()

{{APIComment|'Connect to the Synthesis repository and set project ID#1 as the current project.}}
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
MyRepository.Project.SetCurrentProject(1)

{{APIComment|'Retrieve the model with ID# 21 from the repository.}}
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
{{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(21)

{{APIComment|'Declare variables.}}
{{APIPrefix|Dim}} Result1 {{APIPrefix|As}} Double
{{APIPrefix|Dim}} Result2 {{APIPrefix|As}} Double

{{APIComment|'Calculate the model's reliability at time = 100 hrs and mean time.}}
Result1 = AModel.Reliability(100)
Result2 = AModel.MeanTime

{{APIComment|'Set the confidence level to 90% two-sided bounds.}}
{{APIComment|'Declare a string variable for any errors found during this method.}}
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
{{APIPrefix|Call}} AModel.SetConfidenceLevel(0.9, ConfBoundsSides_TwoSidedBoth, False, ErrorMsg)

{{APIComment|'Initiate new instances of the BoundsValues class.}}
{{APIPrefix|Dim}} BResult1 {{APIPrefix|As}} BoundsValues
{{APIPrefix|Dim}} BResult2 {{APIPrefix|As}} BoundsValues

{{APIComment|'Calculate bounds for the reliability at 100 hrs and the mean time.}}
{{APIPrefix|Set}} BResult1 = AModel.Bounds_Reliability(100)
{{APIPrefix|Set}} BResult2 = AModel.Bounds_MeanTime

{{APIComment|'Display the output.}}
MsgBox ({{APIString|"Reliability <nowiki>=</nowiki> "}} & Result1 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult1.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult1.lower & vbNewLine)
MsgBox ({{APIString|"Mean Time <nowiki>=</nowiki> "}} & Result2 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult2.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult2.lower & vbNewLine)

End Sub

'''VB.NET'''

{{APIPrefix|Imports}} SynthesisAPI

{{APIPrefix|Public Class}} Form1
{{APIPrefix|Private Sub}} Button1_Click(sender {{APIPrefix|As}} System.Object, e {{APIPrefix|As}} System.EventArgs) {{APIPrefix|Handles}} Button1.Click

{{APIComment|'Connect to the Synthesis repository and set project ID#1 as the current project.}}
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
MyRepository.Project.SetCurrentProject(1)

{{APIComment|'Retrieve the model with ID# 21 from the repository.}}
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
AModel = MyRepository.Model.GetModel(21)

{{APIComment|'Declare variables.}}
{{APIPrefix|Dim}} Result1 {{APIPrefix|As}} Double
{{APIPrefix|Dim}} Result2 {{APIPrefix|As}} Double

{{APIComment|'Calculate the model's reliability at time = 100 hrs and mean time.}}
Result1 = AModel.Reliability(100)
Result2 = AModel.MeanTime

{{APIComment|'Set the confidence level to 90% two-sided bounds.}}
{{APIComment|'Declare a string variable for any errors found during this method.}}
{{APIPrefix|Dim}} ErrorMsg {{APIPrefix|As}} String
AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)

{{APIComment|'Initiate new instances of the BoundsValues class.}}
{{APIPrefix|Dim}} BResult1 {{APIPrefix|As}} BoundsValues
{{APIPrefix|Dim}} BResult2 {{APIPrefix|As}} BoundsValues

{{APIComment|'Calculate bounds for the reliability at 100 hrs and the mean time.}}
BResult1 = AModel.Bounds_Reliability(100)
BResult2 = AModel.Bounds_MeanTime

{{APIComment|'Display the output.}}
MsgBox ({{APIString|"Reliability <nowiki>=</nowiki> "}} & Result1 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult1.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult1.lower & vbNewLine)
MsgBox ({{APIString|"Mean Time <nowiki>=</nowiki> "}} & Result2 & vbNewLine & _
{{APIString|"Upper Bound <nowiki>=</nowiki> "}} & BResult2.upper & vbNewLine & _
{{APIString|"Lower Bound <nowiki>=</nowiki> "}} & BResult2.lower & vbNewLine)

{{APIPrefix|End Sub}}
{{APIPrefix|End Class}}

===Notes===
See <code>[[CModel Class|cModel]]</code> class for a list of all possible calculation methods for models.

===References===
To learn more, see the reference documentation for the class and methods discussed in this section:

*[[CModel.Reliability|cModel.Reliability Method]]
*[[CModel.MeanTime|cModel.MeanTime Method]]
*[[CModel.SetConfidenceLevel|cModel.SetConfidenceLevel Method]]
*[[CModel.Bounds_Reliability|cModel.Bounds_Reliability Method]]
*[[CModel.Bounds_MeanTime|cModel.Bounds_MeanTime Method]]
*[[BoundsValues Class]]

← Older revision		Revision as of 18:22, 3 April 2017
Line 8:		Line 8:
	*Create a Synthesis repository for testing purposes. Perform a simple analysis (can use [http://weibull.reliasoft.com/ Weibull++] or [http://alta.reliasoft.com/ ALTA]) and then publish a model of the analysis. You'll want to use a published model with this tutorial so you can perform confidence bounds calculations.		*Create a Synthesis repository for testing purposes. Perform a simple analysis (can use [http://weibull.reliasoft.com/ Weibull++] or [http://alta.reliasoft.com/ ALTA]) and then publish a model of the analysis. You'll want to use a published model with this tutorial so you can perform confidence bounds calculations.

	*Note the published model's object ID ~~number~~. You will use the ID# to retrieve the model from the database. (To display the object IDs, choose '''File > Application Setup''', then click '''Other''' under the Synthesis Settings heading in the navigation panel. Select the '''Display Object IDs''' check box. The object ID of the model is displayed in the Resource Manager.)		*Note the published model's [[Synthesis_API_Object_IDs\|object ID]]. You will use the object ID to retrieve the model from the database.


Line 25:		Line 25:
	{{APIComment\|'Connect to a Synthesis repository and project.}}		{{APIComment\|'Connect to a Synthesis repository and project.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.~~rsr10~~"}}){{APIComment\|'Replace with name and path to test repository.}}		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr11"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

Line 69:		Line 69:
	{{APIComment\|'Connect to a Synthesis repository and project.}}		{{APIComment\|'Connect to a Synthesis repository and project.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.~~rsr10~~"}}){{APIComment\|'Replace with name and path to test repository.}}		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr11"}}){{APIComment\|'Replace with name and path to test repository.}}
	MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}		MyRepository.Project.SetCurrentProject(1){{APIComment\|'Replace with the object ID of test project.}}

Line 78:		Line 78:
	AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}		AModel = MyRepository.Model.GetModel(21){{APIComment\|'Replace with the object ID of test model.}}

	We can now obtain some metrics from the model. The [[CModel Class\|cModel Class]] reference ~~doc~~ lists all available methods for performing calculations on models~~, but for~~ this example, we'll limit it to the [[CModel.Reliability\|Reliability]] and [[CModel.MeanTime\|MeanTime]] methods.		We can now obtain some metrics from the model. The [[CModel Class\|cModel Class]] reference documentation lists all available methods for performing calculations on models. For this example, we'll limit it to the [[CModel.Reliability\|Reliability]] and [[CModel.MeanTime\|MeanTime]] methods.

	{{APIComment\|'Declare some variables to store the results.}}		{{APIComment\|'Declare some variables to store the results.}}
Line 88:		Line 88:
	Result2 = AModel.MeanTime		Result2 = AModel.MeanTime

	To calculate the confidence bounds, use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify 90% two-sided confidence bounds.		To calculate the confidence bounds, first use the [[CModel.SetConfidenceLevel\|SetConfidenceLevel]] method to specify 90% two-sided confidence bounds.

	{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}		{{APIComment\|'Set the confidence level to 90% two-sided bounds.}}
Line 95:		Line 95:
	AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)		AModel.SetConfidenceLevel(0.9, ConfBoundsSides.TwoSidedBoth, False, ErrorMsg)

	And then use any of the bounds ~~calculation~~ methods in the class to perform the ~~commands~~. Here, we limit the example to the [[CModel.Bounds_Reliability\|Bounds_Reliability]] and [[CModel.Bounds_MeanTime\|Bounds_MeanTime]] methods.		And then use any of the bounds methods in the class to perform the calculations. Here, we limit the example to the [[CModel.Bounds_Reliability\|Bounds_Reliability]] and [[CModel.Bounds_MeanTime\|Bounds_MeanTime]] methods.

	{{APIComment\|'Declare new BoundsValues objects to store the confidence bounds results.}}		{{APIComment\|'Declare new BoundsValues objects to store the confidence bounds results.}}