Repository.Project.GetAllProjects: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(27 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetAllProjects.Cmt}}


== Syntax==
*GetAllProjects(){{APIPrefix|As}}[[NameIdPair Class|NameIdPair]]()


== Usage Example ==
<onlyinclude>Returns an array of '''[[NameIdPair Class|NameIDPair]]''' objects that represent the name and ID pairs of the projects associated with the Repository object.</onlyinclude>
In this usage example, the API is used to connect to a repository, retrieve one of the models in it and then calculate the reliability at a specified time, based on that model.
 
  {{APIComment|'Declare a new repository connection class. See [[Repository Class]].}}
== Syntax ==
  Dim MyRepository As New Repository
'''.Project.GetAllProjects()'''
 
 
{{APIComment|'Connect to a Synthesis repository.}}
 
  Dim Success As Boolean = False
== Example ==
  Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr9")
'''VBA|VB.NET'''
 
  {{APIComment|'Get a list of the names/IDs of projects in the connected repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  Dim ListOfProjects() As NameIdPair
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  ListOfProjects = MyRepository.GetAllProjects  
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Open the first project in the list.}}
  {{APIComment|'Get a list of all projects in the repository.}}  
  MyRepository.SetCurrentProject(ListOfProjects(0).ID)
  {{APIPrefix|Dim}} ListofProjects() {{APIPrefix|As}} NameIDPair
 
  ListOfProjects = MyRepository.Project.GetAllProjects
{{APIComment|'Get a list of the names/IDs of models in the current project.}}
  Dim ListOfModels() As NameIdPair
  {{APIComment|'Output sample: Display the number of projects in the repository.}}
  ListOfModels = MyRepository.GetAllModelsInfo()
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
 
  NumberofElements = UBound(ListofProjects) - LBound(ListofProjects) + 1
{{APIComment|'Retrieve the first model in the list.}}
  MsgBox (NumberofElements)
  Dim AModel as cModel
  AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
{{APIComment|'Calculate the reliability at time &#61; 50 and save the result. See [[CModel.Reliability|Reliability]].}}
  Dim Rel as Double
  Rel = AModel.Reliability(50)
 
{{APIComment|'Disconnect from the repository.}}
  MyRepository.DisconnectFromRepository

Latest revision as of 18:54, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object.

Syntax

.Project.GetAllProjects()


Example

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 projects in the repository.  
  Dim ListofProjects() As NameIDPair
  ListOfProjects = MyRepository.Project.GetAllProjects

 'Output sample: Display the number of projects in the repository. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofProjects) - LBound(ListofProjects) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Project.GetAllProjects&oldid=64321"