APISynthesisResourcesTutorial: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
(Redirected page to API Tutorials)
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Synthesis Resources Tutorial}}{{Template:InProgress}}{{Template:API}}
#REDIRECT [[API_Tutorials]]
<div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;">
<nowiki><<</nowiki> [[APIQuickStartGuide|Back to Quick Start Guide]]
 
'''Synthesis Resources Tutorial'''
#[[#Part1: Connecting to a Synthesis Repository and Project|Connecting to a Synthesis Repository and Project]]
#[[#Part2: Creating a New Synthesis Resource|Creating a New Synthesis Resource]]
#[[#Part3: Updating an Existing Resource|Updating an Existing Resource]]
#[[#Part 4: Calculating Results from Models|Calculating Results from Models]]
'''[[APISDWTutorial|Synthesis Data Warehouse (SDW) Tutorial]]
</div>
 
This four-part tutorial introduces you to the basic functionalities of the Synthesis API. You will learn how to use the API to create new and update existing resources in a Synthesis repository.
 
 
In the Synthesis Platform, repositories contain projects, and projects contain resources, analyses and other related items. Therefore, to read or write data to a Synthesis repository, we must begin by first connecting to a Synthesis repository and then accessing one of its projects.
 
 
 
 
 
 
 
==Part 1: Connecting to a Synthesis Repository and Project==
1. We'll start with the Repository class, which provides several methods for connecting to standard or enterprise repositories. In this example, we will use the basic <code>ConnectToRepository</code> method to create a simple application.
 
Create a new module and start with the following basic code for connecting to a standard Synthesis repository.
 
'''VBA|VB.NET'''
{{APIComment|'Declare a new instance of the Repository class.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Specify the full path to the Synthesis repository.}}
{{APIComment|'The following code assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive.}}
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
2. Next, use the <code>Project.SetCurrentProject</code> method to specify the current (or active) project using the project's ID number. In this example, we'll first use the <code>GetAllProjects</code> method to get an array of all projects in the repository, and then use the ID number of the first project in the array to set it as the current project.
 
'''VBA|VB.NET'''
{{APIComment|'Declare a new instance of the NameIDPair class.}}
  {{APIPrefix|Dim}} ListofProjects() {{APIPrefix|As}} NameIDPair
{{APIComment|'Get a list of all projects in the repository.}}
  ListOfProjects = MyRepository.Project.GetAllProjects()
{{APIComment|'Set the first available project as the current project.}}
  MyRepository.Project.SetCurrentProject(ListofProjects(0).ID)
{{APIComment|'Display the name and ID number of the current project.}}
  {{APIPrefix|Dim}} ProjectName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ProjectID {{APIPrefix|As}} Integer
 
  ProjectName = MyRepository.Project.GetCurrentProject().Name
  ProjectID = MyRepository.Project.GetCurrentProject().ID
  MsgBox ({{APIString|"You are currently connected to: "}} & ProjectName & {{APIString|", ID#"}} & ProjectID)
 
Any time you wish to switch to another project in the repository, you can always use the <code>Project.SetCurrentProject</code> method to specify a new active project.
 
However, if you wish to access projects from another repository, you’ll first need to disconnect from the current repository by using the <code>DisconnectFromRepository</code> method, and then use the <code>ConnectToRepository</code> method again to connect to the desired repository.
 
'''VBA|VB.NET'''
{{APIComment|'Disconnect from the Synthesis repository.}}
  MyRepository.DisconnectFromRepository
===Verify It Works===
Let’s verify that our connections to the repository and project work.
 
Below is the code list for this example. On the Debug menu, click '''Start''' to run the application. A message box displays the name and ID number of the current project in the repository.
 
'''VBA|VB.NET'''
 
Sub Main()
{{APIComment|'Declare a new instance of the Repository class.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
{{APIComment|'Specify the full path to the Synthesis repository.}}
{{APIComment|'The following code assumes that a standard repository called "RSRepository1.rsr10" exists in the C drive.}}
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
{{APIComment|'Declare a new instance of the NameIDPair class.}}
  {{APIPrefix|Dim}} ListofProjects() {{APIPrefix|As}} NameIDPair
{{APIComment|'Get a list of all projects in the repository.}}
  ListOfProjects = MyRepository.Project.GetAllProjects()
{{APIComment|'Set the first available project as the current project.}}
  MyRepository.Project.SetCurrentProject(ListofProjects(0).ID)
{{APIComment|'Display the name and ID number of the current project.}}
  {{APIPrefix|Dim}} ProjectName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ProjectID {{APIPrefix|As}} Integer
  ProjectName = MyRepository.Project.GetCurrentProject().Name
  ProjectID = MyRepository.Project.GetCurrentProject().ID
  MsgBox ({{APIString|"You are currently connected to: "}} & ProjectName & {{APIString|", ID#"}} & ProjectID)
{{APIComment|'Disconnect from the Synthesis repository.}}
  MyRepository.DisconnectFromRepository
End Sub
 
===Reference Links===
*[[Repository Class]]
*[[NameIdPair Class]]
*[[Repository.ConnectToRepository|Repository.ConnectToRepository Method]]
*[[Repository.DisconnectFromRepository|Repository.DisconnectFromRepository Method]]
*[[Repository.Project.GetAllProjects|Repository.Project.GetAllProjects Method]]
*[[Repository.Project.SetCurrentProject|Repository.Project.SetCurrentProject Method]]
*[[Repository.Project.GetCurrentProject|Repository.Project.GetCurrentProject Method]]
*[[Guide to Using Item IDs with the Synthesis API]]
 
 
==Part 2: Creating a New Synthesis Resource==
Now that we've learned how to connect to a repository and a project, let’s try adding a new model resource to the repository.
 
1. Create a new module and begin again by connecting to the Synthesis repository and project.
 
'''VBA|VB.NET'''
{{APIComment|'Connect to a 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. Use the cModel class to create a 2-parameter Weibull reliability model with beta 1 and eta 100. Name the model, "MyNewModel."
 
For VBA, use the <code>SetModel</code> method to define the model. For VB.NET, use the parameterized constructor to create and define the model.
 
'''VBA '''
{{APIComment|'Declare a new instance of the cModel class.}}
  {{APIPrefix|Dim}} Amodel {{APIPrefix|As New}} cModel
{{APIComment|'Define the model&#39;s properties.}}
  {{APIPrefix|Dim}} ModelType {{APIPrefix|As}} ModelTypeEnum
  {{APIPrefix|Dim}} ModelCategory {{APIPrefix|As}} ModelCategoryEnum
  {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ModelParams(1) {{APIPrefix|As}} Double
  ModelType = ModelTypeEnum_Weibull2
  ModelCategory = ModelCategoryEnum_Reliability
  ModelName = {{APIString|"MyNewModel"}}
  ModelParams(0) = 1
  ModelParams(1) = 100
  {{APIPrefix|Call}} AModel.SetModel(ModelType, ModelCategory, ModelName, ModelParams)
 
'''VB.NET'''
{{APIComment|'Declare a new instance of the cModel class. You can use an in-line parameter list to define the model.}}
  {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, 1, 100)
3. Use the <code>AddModel</code> method to save the new model to the repository.
 
'''VBA'''
{{APIComment|'Add the new model to the current project.}}
  {{APIPrefix|Call}} MyRepository.Model.AddModel(AModel)
 
'''VB.NET'''
{{APIComment|'Add the new model to the current project.}}
  MyRepository.Model.AddModel(AModel)
 
===Verify It Works===
Below are the VBA and VB.NET code lists for this example. On the Debug menu, click '''Start''' to run the application. Then in the Synthesis repository, open the project’s Resource Manager ('''Project > Synthesis> Resource Manager''') and then select the Models page. A model named "MyNewModel" should be on the list.
 
'''VBA'''
Sub Main()
 
{{APIComment|'Connect to a 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|'Declare a new instance of the cModel class.}}
  {{APIPrefix|Dim}} Amodel {{APIPrefix|As New}} cModel
{{APIComment|'Define the model&#39;s properties.}}
  {{APIPrefix|Dim}} ModelType {{APIPrefix|As}} ModelTypeEnum
  {{APIPrefix|Dim}} ModelCategory {{APIPrefix|As}} ModelCategoryEnum
  {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ModelParams(1) {{APIPrefix|As}} Double
  ModelType = ModelTypeEnum_Weibull2
  ModelCategory = ModelCategoryEnum_Reliability
  ModelName = {{APIString|"MyNewModel"}}
  ModelParams(0) = 1
  ModelParams(1) = 100
  {{APIPrefix|Call}} AModel.SetModel(ModelType, ModelCategory, ModelName, ModelParams)
{{APIComment|'Add the new model to the current project.}}
  {{APIPrefix|Call}} MyRepository.Model.AddModel(AModel)
End Sub
 
'''VB.NET'''
Sub Main()
 
{{APIComment|'Connect to a Synthesis repository and set the first available project in the repository as the active project.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
  MyRepository.Project.SetCurrentProject(1)
{{APIComment|'Declare a new instance of the cModel class. You can use an in-line parameter list to define the model.}}
  {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, 1, 100)
{{APIComment|'Add the new model to the current project.}}
  MyRepository.Model.AddModel(AModel)
End Sub
 
===Reference Links===
*[[CModel Class|cModel Class]]
*[[CModel.SetModel|cModel.SetModel Method]]
*[[CModel_Constructors|cModel Constructor (VB.NET Only)]]
*[[Repository.Model.AddModel|Repository.Model.AddModel Method]]
*[[ModelTypeEnum Enumeration]]
*[[ModelCategoryEnum Enumeration]]
 
 
 
==Part 3: Updating an Existing Resource==
In this section, we'll update the properties of the model we've created in the previous section.
 
1. Create a new module and add code to connect to the Synthesis repository and project.
 
'''VBA|VB.NET'''
{{APIComment|'Connect to a 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. Next, use <code>GetModel</code> method to the retrieve the model (called "MyNewModel") from the repository. The following code assumes that the model's ID number is 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)
 
3. For this example, let's change the model's name to "MyNewModel_Updated" and change the value of beta to 2.
 
'''VBA|VB.NET'''
{{APIComment|'Specify the new model name and new value for beta.}}
  {{APIPrefix|Dim}} ModelParams(1) {{APIPrefix|As}} Double 
 
  Amodel.Name = {{APIString|"MyNewModel_Updated"}}
  ModelParams(0) = 2
4. Use the <code>UpdateModel</code> method to apply the changes to the model.
 
'''VBA'''
{{APIComment|'Apply the changes to the model.}}
  {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)
 
'''VB.NET'''
 
{{APIComment|'Apply the changes to the model.}}
  MyRepository.Model.UpdateModel(AModel)
 
===Verify It Works===
Below are the VBA and VB.NET code lists for this example. On the Debug menu, click '''Start''' to run the application. Check the project's Resource Manager to verify the results.
 
'''VBA'''
Sub Main()
{{APIComment|'Connect to a 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 New}} cModel
  {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(21)
{{APIComment|'Specify the new model name and new value for beta.}}
  {{APIPrefix|Dim}} ModelParams(1) {{APIPrefix|As}} Double 
   
  Amodel.Name = {{APIString|"MyNewModel_Updated"}}
  ModelParams(0) = 2
 
{{APIComment|'Apply the changes to the model.}}
  {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)
End Sub
 
'''VB.NET'''
Sub Main()
 
{{APIComment|'Connect to a Synthesis repository and set the first available project in the repository as the active 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 New}} cModel
  AModel = MyRepository.Model.GetModel(21)
{{APIComment|'Specify the new model name and new value for beta.}}
  {{APIPrefix|Dim}} ModelParams(1) {{APIPrefix|As}} Double 
 
  Amodel.Name = {{APIString|"MyNewModel_Updated"}}
  ModelParams(0) = 2
{{APIComment|'Apply the changes to the model.}}
  MyRepository.Model.UpdateModel(AModel)
End Sub
 
===Reference Links===
*[[Repository.Model.GetModel|Repository.Model.GetModel Method]]
*[[Repository.Model.UpdateModel|Repository.Model.UpdateModel Method]]
 
 
==Part 4: Calculating Results from Models==
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 section, we'll learn how to obtain calculated results from models.
1. Create a new module, and then add code to retrieve the model that we've been working on in the last sections (recall that the model's name is now "MyNewModel_Update"). The following code example assumes that the model's ID number is 21.
 
'''VBA|VB.NET'''
{{APIComment|'Connect to the Synthesis repository and retrieve model ID#21.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  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.
 
'''VBA|VB.NET'''
{{APIComment|'Calculate the model's reliability at time &#61; 100 hrs and mean time.}}
  {{APIPrefix|Dim}} Result1 {{APIPrefix|As}} Double
  {{APIPrefix|Dim}} Result2 {{APIPrefix|As}} Double
  Result1 = AModel.Reliability(100)
  Result2 = AModel.MeanTime()
{{APIComment|'Display the output.}}
  MsgBox ({{APIString|"Reliability <nowiki>=</nowiki> "}} & Result1 & {{APIString|" Mean Time <nowiki>=</nowiki> "}} & Result2}})
 
3. Let's add confidence bounds calculations to the results. Use the <code>SetConfidenceLevel</code> method to specify 90% two-sided confidence bounds.
 
'''VBA|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
  {{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.}}
  BResult1 = AModel.Bounds_Reliability(100)
  BResult2 = AModel.Bounds_MeanTime()
 
{{APIComment|'Display the results for the upper and lower confidence bounds.}}
  MsgBox ({{APIString|" Reliability: Upper bound: "}} & BResult1.Upper & {{APIString|", Lower bound: "}} & BResult1.Lower)
  MsgBox ({{APIString|" Mean Time: Upper bound: "}} & BResult2.Upper & {{APIString|", Lower bound: "}} & BResult2.Lower)
 
===Verify It Works===
Below are the VBA and VB.NET code lists for this example. You can experiment with the code by retrieving published models from the repository and then comparing the results obtained by the API from the results obtained by the Quick Calculation Pad (QCP).
 
'''VBA|VB.NET'''
 
Sub Main()
 
{{APIComment|'Connect to the Synthesis repository and retrieve model ID#21.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Model.GetModel(21)
 
{{APIComment|'Calculate the model's reliability at time &#61; 100 hrs and mean time.}}
  {{APIPrefix|Dim}} Result1 {{APIPrefix|As}} Double
  {{APIPrefix|Dim}} Result2 {{APIPrefix|As}} Double
  Result1 = AModel.Reliability(100)
  Result2 = AModel.MeanTime()
{{APIComment|'Display the output.}}
  MsgBox ({{APIString|"Reliability <nowiki>=</nowiki> "}} & Result1 & {{APIString|" Mean Time <nowiki>=</nowiki> "}} & Result2}})
{{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.}}
  BResult1 = AModel.Bounds_Reliability(100)
  BResult2 = AModel.Bounds_MeanTime()
 
{{APIComment|'Display the results for the upper and lower confidence bounds.}}
  MsgBox ({{APIString|" Reliability: Upper bound: "}} & BResult1.Upper & {{APIString|", Lower bound: "}} & BResult1.Lower)
  MsgBox ({{APIString|" Mean Time: Upper bound: "}} & BResult2.Upper & {{APIString|", Lower bound: "}} & BResult2.Lower)
End Sub
 
===Reference Links===
*[[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]]

Latest revision as of 22:14, 9 February 2016

Redirect to:

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