Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.


Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API).  
<onlyinclude>Updates the properties of a given model resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
<noinclude>
 
== Syntax ==
''object''.'''Model.UpdateModel(''m'')'''


where ''object'' is a variable that represents a Repository object.
'''Remarks''': This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.


== Syntax ==
'''.Model.UpdateModel'''(''m'')
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''m''
|-
:Required. The [[CModel Class|cModel]] object that represents the model resource to be updated.
|m{{APIParam|Required}}||The [[CModel Class|cModel]] object to be updated.
|}




== Example ==
== Example ==
This example assumes that a model with ID#47 exists in the repository.
This example assumes that a model with ID #47 exists in the first available project of a repository.


  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
  {{APIComment|'Get model #47 from project #1.}}
  {{APIComment|'Get model #47 from project #1.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
  {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
   
   
  {{APIComment|'Change the model's name to "New_Name."}}
  {{APIComment|'Change the model's name to "New_Name."}}
  AModel.Name = {{APIString|"New_Name"}}
  AModel.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)
  {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
   
   {{APIComment|'Get model #47 from project #1.}}
   {{APIComment|'Get model #47 from project #1.}}
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  AModel = MyRepository.Model.GetModel(47)
  AModel = MyRepository.Model.GetModel(47)
   
   
  {{APIComment|'Change the model's name to "New_Name."}}
  {{APIComment|'Change the model's name to "New_Name."}}
  AModel.Name = {{APIString|"New_Name"}}
  AModel.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Model.UpdateModel(AModel)
  MyRepository.Model.UpdateModel(AModel)
</noinclude>

Latest revision as of 20:34, 18 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Updates the properties of a given model resource in the current project. Returns a Boolean value; when true, indicates a successful update.


Remarks: This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.

Syntax

.Model.UpdateModel(m)

Parameters

m

Required. The cModel object that represents the model resource to be updated.


Example

This example assumes that a model with ID #47 exists in the first available project of a repository. 

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
   
 'Get model #47 from project #1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)  
  Set AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
  AModel.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Model.UpdateModel(AModel)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

  'Get model #47 from project #1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)  
  AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
  AModel.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Model.UpdateModel(AModel)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.UpdateModel&oldid=64610"