Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>


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.
Updates the properties of an existing model in the current project. 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).  
This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Model.UpdateModel(''m'')'''
'''.Model.UpdateModel'''(''m'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''m''
|-
:The [[CModel Class|cModel]] object 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|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
 
   
   
  {{APIComment|'Get model #47 from project #1.}}
  {{APIComment|'Get model #47 from project #1.}}

Revision as of 20:23, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository

Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

This method does not affect 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

The cModel object to be updated.


Example

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

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 
  

 '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"

 'Apply the update to the model. Changes will be reflected in the repository. 
 Call MyRepository.Model.UpdateModel(AModel)

VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository. 

  '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"

 'Apply the update to the model. Changes will be reflected in the repository. 
 MyRepository.Model.UpdateModel(AModel)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.UpdateModel&oldid=59587"