APISynthesisResourcesTutorial3: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:Synthesis Resources Tutorial}}{{Template:InProgress}}{{Template:API}}
{{DISPLAYTITLE:Synthesis Resources Tutorial}}{{Template:API}}
<div style="border:1px solid #AAA; background:#f9f9f9; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;">
<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]]
<nowiki><<</nowiki> [[APIQuickStartGuide|Back to Quick Start Guide]]
Line 10: Line 10:
</div>
</div>


In this section, we'll update the properties of the model we've created in the previous section.
In this section, we'll learn how to update the properties of the model we've created in the previous section.




Line 32: Line 32:
   MyRepository.Project.SetCurrentProject(1)
   MyRepository.Project.SetCurrentProject(1)


2. Next, use the <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.  
2. Next, retrieve the model from the repository so we can edit it. Use the <code>GetModel</code> method to the retrieve the model (called "MyNewModel"). The following code assumes that the model's ID number is 21.  


  '''VBA'''
  '''VBA'''
Line 46: Line 46:
   AModel = MyRepository.Model.GetModel(21)
   AModel = MyRepository.Model.GetModel(21)


3. Let's update the model's properties. Use the following code to edit the model's name, description and part number.
3. Edit the model's properties. Use the following code to edit the model's name, description and part number.


  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
Line 115: Line 115:
   
   
  End Sub
  End Sub
You can use a similar approach to update the properties of other types of Synthesis repositories. For example, to update the properties of an existing URD, you would use the <code>[[Repository.URD.GetURD]]</code> method to retrieve the URD from the repository, and then use the <code>[[Repository.URD.UpdateURD]]</code> method to apply the changes.


===References===
===References===
Line 121: Line 124:
*[[Repository.Model.GetModel|Repository.Model.GetModel Method]]
*[[Repository.Model.GetModel|Repository.Model.GetModel Method]]
*[[Repository.Model.UpdateModel|Repository.Model.UpdateModel Method]]
*[[Repository.Model.UpdateModel|Repository.Model.UpdateModel Method]]





Revision as of 16:37, 27 October 2015

APIWiki.png


<< Back to Quick Start Guide

Synthesis Resources Tutorial

  1. Connect to a Synthesis Repository and Project
  2. Create a New Synthesis Resource
  3. Update an Existing Resource
  4. Calculate Results from a Model

In this section, we'll learn how to update the properties of the model we've created in the previous section.






Part 3: Update an Existing Resource

1. Create a new module and add code to connect to the Synthesis repository and project.

VBA|VB.NET

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

2. Next, retrieve the model from the repository so we can edit it. Use the GetModel method to the retrieve the model (called "MyNewModel"). The following code assumes that the model's ID number is 21.

VBA

 'Retrieve the model with ID# 21 from the repository. 
  Dim Amodel As New cModel
  Set AModel = MyRepository.Model.GetModel(21)
VB.NET

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

3. Edit the model's properties. Use the following code to edit the model's name, description and part number.

VBA|VB.NET

  'Edit the model's name, description and part number. 
  Amodel.Name = "MyNewModel_Updated"
  Amodel.ItemDescription = "A specific type of light bulb."
  Amodel.ItemPartNumber = "PN5461"   

4. Use the UpdateModel method to apply the changes to the model.

VBA

 'Apply the changes to the model. 
  Call MyRepository.Model.UpdateModel(AModel)
VB.NET
 
 'Apply the changes to the model. 
  MyRepository.Model.UpdateModel(AModel)

Test the Code

Below are the VBA and VB.NET code lists for this example. On the Debug menu, click Start to run the application, and then check the project's Resource Manager to verify that the properties have been updated. (You may need to display the Description and Part Number columns of the Resource Manager by right-clicking a column header and choosing Select Columns.)

VBA

Sub Main()

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

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

  'Edit the model's name, description and part number. 
  Amodel.Name = "MyNewModel_Updated"
  Amodel.ItemDescription = "A specific type of light bulb."
  Amodel.ItemPartNumber = "PN5461"   
 
 'Apply the changes to the model. 
  Call MyRepository.Model.UpdateModel(AModel)

End Sub
VB.NET

Sub Main()
  
 'Connect to the Synthesis repository and set project ID#1 as the current project. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")
  MyRepository.Project.SetCurrentProject(1)
  
 'Retrieve the model with ID# 21 from the repository.  
  Dim Amodel As New cModel
  AModel = MyRepository.Model.GetModel(21)

  'Edit the model's name, description and part number. 
  Amodel.Name = "MyNewModel_Updated"
  Amodel.ItemDescription = "A specific type of light bulb."
  Amodel.ItemPartNumber = "PN5461"   

 'Apply the changes to the model. 
  MyRepository.Model.UpdateModel(AModel)

End Sub


You can use a similar approach to update the properties of other types of Synthesis repositories. For example, to update the properties of an existing URD, you would use the Repository.URD.GetURD method to retrieve the URD from the repository, and then use the Repository.URD.UpdateURD method to apply the changes.

References

To learn more, see the reference documentation for the methods discussed in this section:



Next: Calculate Results from a Model >>