Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>
<onlyinclude>Applies any changes made to an existing model. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>


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.
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.
Line 10: Line 10:
=== Parameters ===
=== Parameters ===
''m''
''m''
:The [[CModel Class|cModel]] object to be updated.
:Required. The [[CModel Class|cModel]] object to be updated.




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


  '''VBA'''
  '''VBA'''
Line 31: Line 31:
   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|'Apply the change to the model. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)
   {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)


Line 47: Line 47:
   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|'Apply the change to the model. Changes are recorded in the Synthesis repository.}}
   MyRepository.Model.UpdateModel(AModel)
   MyRepository.Model.UpdateModel(AModel)

Revision as of 20:50, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing model. Returns a Boolean value; when true, indicates a successful save.

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

Required. 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 change to the model. Changes are recorded in the Synthesis 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 change to the model. Changes are recorded in the Synthesis repository. 
 MyRepository.Model.UpdateModel(AModel)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.UpdateModel&oldid=60496"