Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
Line 9: Line 9:


== Usage Example ==
== Usage Example ==
  {{APIComment|'Declare a new repository connection class.}}
  {{APIComment|'Declare a new repository connection object.}}
   Dim MyRepository As New Repository
   Dim MyRepository As New Repository
    
    
Line 20: Line 20:
   ListOfModels = MyRepository.GetAllModelsInfo()
   ListOfModels = MyRepository.GetAllModelsInfo()
    
    
  {{APIComment|'Select the ID of the model and retrieve it.}}
  {{APIComment|'Retrieve the first model in the list.}}
   Dim AModel as cModel
   Dim AModel as cModel
   AModel = MyRepository.GetModel(ListOfModels(0).ID)
   AModel = MyRepository.GetModel(ListOfModels(0).ID)
    
    
  {{APIComment|'After modifying AModel, update the repository.}}
  {{APIComment|'Change the model's name.}}
  AModel.Name = "New Name"
   
{{APIComment|'Update the model in the repository.}}
   Dim SuccessUpdateModel As Boolean
   Dim SuccessUpdateModel As Boolean
   SuccessUpdateModel = MyRepository.UpdateModel(AModel)
   SuccessUpdateModel = MyRepository.UpdateModel(AModel)
   
{{APIComment|'Disconnect from the repository.}}
  MyRepository.DisconnectFromRepository

Revision as of 22:10, 27 May 2014


Updates the model in the repository. Returns True if successful, otherwise returns False.

Syntax

UpdateModel( m AscModel ) As Boolean

Parameters

m: The cModel to update.

Usage Example

 'Declare a new repository connection object. 
 Dim MyRepository As New Repository
 
 'Connect to the Synthesis repository. 
 Dim Success As Boolean = False
 Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 'Get the list of models in the connected repository. 
 Dim ListOfModels() As NameIdPair
 ListOfModels = MyRepository.GetAllModelsInfo()
 
 'Retrieve the first model in the list. 
 Dim AModel as cModel
 AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
 'Change the model's name. 
 AModel.Name = "New Name"
   
 'Update the model in the repository. 
 Dim SuccessUpdateModel As Boolean
 SuccessUpdateModel = MyRepository.UpdateModel(AModel)
   
 'Disconnect from the repository. 
 MyRepository.DisconnectFromRepository