Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|10|Repository}}
{{Template:Repository.UpdateModel.Cmt}} {{Template:BooleanReturn.Cmt}}
{{Template:API}}
Saves all updates to a model that you specify. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.


== Syntax==
== Syntax ==
UpdateModel( m {{APIPrefix|As}}[[cModel Class|cModel]] ) {{APIPrefix|As Boolean}}
''object''.'''Model.UpdateModel(''m'')'''


Parameters
where ''object'' is a variable that represents a Repository object.
:''m'': The [[cModel Class|cModel]] to update.


== Usage Example ==
=== Parameters ===
{{APIComment|'Declare a new repository connection object.}}
{| {{APITable}}
   Dim MyRepository As New Repository
|-
 
|m{{APIParam|Required}}||The '''[[CModel Class|cModel]]''' object to be updated.
  {{APIComment|'Connect to the Synthesis repository.}}
|}
  Dim Success As Boolean = False
 
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 
== Example ==
  {{APIComment|'Get the list of models in the connected repository.}}
'''VBA'''<br>
  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  ListOfModels = MyRepository.Model.GetAllModelsInfo()
  {{APIComment|...'Add code to connect to a Synthesis repository.}}<br> 
 
  {{APIComment|'Get the model. If getting a local model, add code to specify the current project.}}
  {{APIComment|'Retrieve the model with ID &#061; 20.}}
  {{APIComment|'For example, the following code retrieves model #47 from project #1.}}
   Dim AModel as cModel
   {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
   AModel = MyRepository.Model.GetModel(20)
  MyRepository.Project.SetCurrentProject(1) 
 
   AModel = MyRepository.Model.GetModel(47)<br>
  {{APIComment|'Change the model's name.}}
  {{APIComment|'Change model #47's name to "New Name".}}
   AModel.Name = "New Name"
   {{APIPrefix|Set}} AModel.Name = "New Name"<br>
   
  {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}}
  {{APIComment|'Update the model in the repository.}}
   MyRepository.Model.UpdateModel(AModel)
   Dim SuccessUpdateModel As Boolean
  SuccessUpdateModel = MyRepository.Model.UpdateModel(AModel)
   
{{APIComment|'Disconnect from the repository.}}
  MyRepository.DisconnectFromRepository

Revision as of 23:26, 13 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


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

Syntax

object.Model.UpdateModel(m)

where object is a variable that represents a Repository object.

Parameters

Name Description
mborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status The cModel object to be updated.


Example

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository. 
  
 'Get the model. If getting a local model, add code to specify the current project. 
 'For example, the following code retrieves model #47 from project #1. 
 Dim AModel As cModel
 MyRepository.Project.SetCurrentProject(1)   
 AModel = MyRepository.Model.GetModel(47)

 'Change model #47's name to "New Name". 
 Set 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=59368"