Repository.Model.GetAllModels: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetAllModels.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.


==Syntax==
<onlyinclude>Returns an array of '''[[CModel Class|cModel]]''' objects that represent the model resources in the current project.</onlyinclude>
*GetAllModels(){{APIPrefix|As}}[[cModel Class|cModel]]()


== Usage Example ==
== Syntax ==
<div style="margin-right: 150px;">
'''.Model.GetAllModels'''(''Filter'')
  {{APIComment|'Declare a new repository connection object.}}
 
  Dim MyRepository As New Repository
===Parameters===
 
''Filter''
  {{APIComment|'Connect to the Synthesis repository.}}
:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.
  Dim Success As Boolean = False
 
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 
== Example ==
  {{APIComment|'Get an array of [[cModel Class|cModel]] representing all the models in the Current Project.}}
This example assumes that models exist in the first available project of a repository.
  Dim ListOfModels() As [[cModel Class|cModel]]
 
  ListOfModels = MyRepository.GetAllModels()
'''VBA|VB.NET'''
</div>
  {{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|'Get a list of all local models in project #1.}}
  {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel
  MyRepository.Project.SetCurrentProject (1) 
  ListofModels = MyRepository.Model.GetAllModels()
  {{APIComment|'Output sample: Display the number of models in the array.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
  MsgBox (NumberofElements)

Latest revision as of 18:53, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cModel objects that represent the model resources in the current project.

Syntax

.Model.GetAllModels(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

This example assumes that models exist in the first available project of a repository. 

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all local models in project #1. 
  Dim ListofModels() As cModel
  MyRepository.Project.SetCurrentProject (1)  
  ListofModels = MyRepository.Model.GetAllModels()

 'Output sample: Display the number of models in the array. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofModels) - LBound(ListofModels) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.GetAllModels&oldid=64315"