APISynthesisResourcesTutorial3 - Revision history

Kate Racaza: Redirected page to API Tutorials

2016-02-09T23:48:18Z

Kate Racaza: Undo revision 61205 by Kate Racaza (Talk)

2015-10-30T18:31:01Z

Undo revision 61205 by Kate Racaza (Talk)

← Older revision		Revision as of 18:31, 30 October 2015
Line 10:		Line 10:
	</div>		</div>

	In this section, we'll learn how to update the properties of the model we've created in the previous section. ~~We will be using ''object IDs'' to help us test responses from the API. If you are not familiar with object IDs, please read [[Using Object IDs\|this short topic]] on object IDs before you begin.~~		In this section, we'll learn how to update the properties of the model we've created in the previous section.




Line 126:		Line 128:
	*[[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]]


	~~Related Pages:~~

	*[[Using Object IDs]]

Kate Racaza at 18:29, 30 October 2015

2015-10-30T18:29:01Z

← Older revision		Revision as of 18:29, 30 October 2015
Line 10:		Line 10:
	</div>		</div>

	In this section, we'll learn how to 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. We will be using ''object IDs'' to help us test responses from the API. If you are not familiar with object IDs, please read [[Using Object IDs\|this short topic]] on object IDs before you begin.




Line 128:		Line 126:
	*[[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]]


			Related Pages:

			*[[Using Object IDs]]

Kate Racaza at 18:17, 28 October 2015

2015-10-28T18:17:40Z

Kate Racaza at 16:37, 27 October 2015

2015-10-27T16:37:31Z

← Older revision		Revision as of 16:37, 27 October 2015
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]]

Kate Racaza at 22:30, 22 October 2015

2015-10-22T22:30:10Z

← Older revision		Revision as of 22:30, 22 October 2015
Line 10:		Line 10:
	</div>		</div>

	In this section, we'll update the properties of the model we've created in the previous section ~~and also update its definition~~.		In this section, we'll update the properties of the model we've created in the previous section.


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 ~~add a~~ description and part number ~~for the model~~.		3. Let's update the model's properties. Use the following code to edit the model's name, description and part number.

	'''VBA\|VB.NET'''		'''VBA\|VB.NET'''

	{{APIComment\|'~~Add a~~ description and part number ~~for the model~~.}}		{{APIComment\|'Edit the model's name, description and part number.}}
			Amodel.Name = {{APIString\|"MyNewModel_Updated"}}
	Amodel.ItemDescription = {{APIString\|"A specific type of light bulb."}}		Amodel.ItemDescription = {{APIString\|"A specific type of light bulb."}}
	Amodel.ItemPartNumber = {{APIString\|"PN5461"}}		Amodel.ItemPartNumber = {{APIString\|"PN5461"}}

	4. Let's also update the model's definition by changing its name to "MyNewModel_Updated" and the values of beta = 2 and eta = 150. Use the <code>SetModel</code> method to define the model. In VB.NET, you can use an in-line parameter list to define the values of the parameters.		4. Use the <code>UpdateModel</code> method to apply the changes to the model.

	~~'''VBA'''~~

	~~{{APIComment\|'Define a new model name and values for beta and eta.}}~~
	~~{{APIPrefix\|Dim}} ModelParams(1) {{APIPrefix\|As}} Double~~
	~~ModelParams(0) = 2~~
	~~ModelParams(1) = 150~~

	~~{{APIPrefix\|Call}} AModel.SetModel(ModelTypeEnum_Weibull2, ModelCategoryEnum_Reliability, {{APIString\|"MyNewModel_Updated"}}, ModelParams)~~

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

	~~{{APIComment\|'Define a new model name and values for beta and eta.}}~~
	~~AModel.SetModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString\|"MyNewModel_Updated"}}, {{APIPrefix\|New Double}}() {2, 150})~~

	5. Use the <code>UpdateModel</code> method to apply the changes to the model.

	'''VBA'''		'''VBA'''
Line 83:		Line 68:

	===Test the Code===		===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 ~~model's name has~~ been ~~changed~~ to ~~"MyNewModel_Updated"~~ and ~~that beta = 2~~ and ~~eta = 150~~.		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'''		'''VBA'''
Line 98:		Line 83:
	{{APIPrefix\|Set}} AModel = MyRepository.Model.GetModel(21)		{{APIPrefix\|Set}} AModel = MyRepository.Model.GetModel(21)

	{{APIComment\|'~~Add a~~ description and part number ~~for the model~~.}}		{{APIComment\|'Edit the model's name, description and part number.}}
			Amodel.Name = {{APIString\|"MyNewModel_Updated"}}
	Amodel.ItemDescription = {{APIString\|"A specific type of light bulb."}}		Amodel.ItemDescription = {{APIString\|"A specific type of light bulb."}}
	Amodel.ItemPartNumber = {{APIString\|"PN5461"}}		Amodel.ItemPartNumber = {{APIString\|"PN5461"}}

	~~{{APIComment\|'Define a new model name and values for beta and eta.}}~~
	~~{{APIPrefix\|Dim}} ModelParams(1) {{APIPrefix\|As}} Double~~
	~~ModelParams(0) = 2~~
	~~ModelParams(1) = 150~~

	~~{{APIPrefix\|Call}} AModel.SetModel(ModelTypeEnum_Weibull2, ModelCategoryEnum_Reliability, {{APIString\|"MyNewModel_Updated"}}, ModelParams)~~

	{{APIComment\|'Apply the changes to the model.}}		{{APIComment\|'Apply the changes to the model.}}
Line 127:		Line 106:
	AModel = MyRepository.Model.GetModel(21)		AModel = MyRepository.Model.GetModel(21)

	{{APIComment\|'~~Add a~~ description and part number ~~for the model~~.}}		{{APIComment\|'Edit the model's name, description and part number.}}
			Amodel.Name = {{APIString\|"MyNewModel_Updated"}}
	Amodel.ItemDescription = {{APIString\|"A specific type of light bulb."}}		Amodel.ItemDescription = {{APIString\|"A specific type of light bulb."}}
	Amodel.ItemPartNumber = {{APIString\|"PN5461"}}		Amodel.ItemPartNumber = {{APIString\|"PN5461"}}

	~~{{APIComment\|'Define a new model name and values for beta and eta.}}~~
	~~AModel.SetModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString\|"MyNewModel_Updated"}}, {{APIPrefix\|New Double}}() {2, 150})~~

	{{APIComment\|'Apply the changes to the model.}}		{{APIComment\|'Apply the changes to the model.}}

Kate Racaza at 16:41, 22 October 2015

2015-10-22T16:41:50Z

← Older revision		Revision as of 16:41, 22 October 2015
Line 118:		Line 118:
	Sub Main()		Sub Main()

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

Kate Racaza at 16:33, 22 October 2015

2015-10-22T16:33:34Z

← Older revision		Revision as of 16:33, 22 October 2015
Line 46:		Line 46:
	AModel = MyRepository.Model.GetModel(21)		AModel = MyRepository.Model.GetModel(21)

	~~<div id="Anchor1"></div>~~
	3. Let's update the model's properties. Use the following code to add a description and part number for the model.		3. Let's update the model's properties. Use the following code to add a description and part number for the model.

Kate Racaza at 16:12, 22 October 2015

2015-10-22T16:12:29Z

← Older revision		Revision as of 16:12, 22 October 2015
Line 149:		Line 149:


	'''<span style="color:#808080;">Next: [[APISynthesisResourcesTutorial4\|Calculate Results from a Model>>]]</span>'''		'''<span style="color:#808080;">Next: [[APISynthesisResourcesTutorial4\|Calculate Results from a Model >>]]</span>'''

Kate Racaza: Created page with '{{DISPLAYTITLE:Synthesis Resources Tutorial}}{{Template:InProgress}}{{Template:API}}

← Older revision		Revision as of 18:17, 28 October 2015
Line 95:		Line 95:
	'''VB.NET'''		'''VB.NET'''

	Sub ~~Main~~()		{{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.}}		{{APIComment\|'Connect to the Synthesis repository and set project ID#1 as the current project.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}})		MyRepository.ConnectToRepository({{APIString\|"C:\RSRepository1.rsr10"}})
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)

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

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

	{{APIComment\|'Apply the changes to the model.}}		{{APIComment\|'Apply the changes to the model.}}
	MyRepository.Model.UpdateModel(AModel)		MyRepository.Model.UpdateModel(AModel)

	End ~~Sub~~		{{APIPrefix\|End Sub}}
			{{APIPrefix\|End Class}}