Repository.Model.GetModel: Difference between revisions

Latest revision as of 18:53, 9 June 2016

Returns a cModel object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.

Syntax

.Model.GetModel(ID)

Parameters

ID

Required. Integer. The ID number of the model to retrieve.

Example

This example assumes that a model with ID #47 exists in the first project of a Synthesis 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)

 'Output sample: Display the name and ID of the model. 
  Dim ModelName As String
  Dim ModelID As Integer
  ModelName = AModel.Name
  ModelID = AModel.ID
  MsgBox ("You got " & ModelName & ", ID#" & ModelID)

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)

 'Output sample: Display the name and ID of the model. 
  Dim ModelName As String
  Dim ModelID As Integer
  ModelName = AModel.Name
  ModelID = AModel.ID
  MsgBox ("You got " & ModelName & ", ID#" & ModelID)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{Template:Repository.GetModel.Cmt}}
-''Note regarding compound analytical models:'' After you connect to a database and create the cModel using [[Repository Class]] ([[Repository.GetModel|GetModel]] or [[Repository.GetAllModels|GetAllModels]] methods), the [[Repository Class]] must stay connected to the same database until you are done working with the model.
+<onlyinclude>Returns a '''[[CModel Class|cModel]]''' object that represents a given model resource in the current project. Returns nothing if the model does not exist or is not in the current project.</onlyinclude>
-== Syntax==
+== Syntax ==
-*GetModel( ID{{APIPrefix|As Integer}}){{APIPrefix|As}}[[cModel Class|cModel]]
+ '''.Model.GetModel'''(''ID'')
-Parameters
+=== Parameters ===
-:''ID'': The ID of the model to retrieve.
+''ID''
+:Required. Integer. The ID number of the model to retrieve.
-==Usage Example==
-  {{APIComment|'Declare a new repository connection class.}}
+== Example ==
-  Dim MyRepository As New Repository
+This example assumes that a model with ID #47 exists in the first project of a Synthesis repository.
-  {{APIComment|'Connect to the Synthesis repository.}}
+ '''VBA'''
-  Dim Success As Boolean = False
-  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
-  {{APIComment|'Get the list of Models in the connected repository.}}
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
-  ListOfModels = MyRepository.GetAllModelsInfo()
+  {{APIComment|'Get model #47 from project#1.}}
+   {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
+   MyRepository.Project.SetCurrentProject(1)
+   {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
+  {{APIComment|'Output sample: Display the name and ID of the model.}}
+   {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
+   {{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer
+   ModelName = AModel.Name
+   ModelID = AModel.ID
+   MsgBox ({{APIString|"You got "}} & ModelName & {{APIString|", ID#"}} & ModelID)
+ '''VB.NET'''
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  {{APIComment|'Select the ID of the model and retrieve it.  In this example, the first model is used.}}
+  {{APIComment|'Get model #47 from project#1.}}
-  Dim AModel as cModel
+   {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
-  AModel = MyRepository.GetModel(ListOfModels(0).ID)
+   MyRepository.Project.SetCurrentProject(1)
+   AModel = MyRepository.Model.GetModel(47)
+ {{APIComment|'Output sample: Display the name and ID of the model.}}
+   {{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String
+   {{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer
+   ModelName = AModel.Name
+   ModelID = AModel.ID
+   MsgBox ({{APIString|"You got "}} & ModelName & {{APIString|", ID#"}} & ModelID)

Repository.Model.GetModel: Difference between revisions

Latest revision as of 18:53, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search