Repository.BlockSim.GetAllFaultTrees: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:InProgress}}
 
 
<onlyinclude>Gets a list of all BlockSim fault trees associated with a project. Returns a '''[[NameIdPair Class|NameIdPair]]''' object that represents the name and ID pairs of the fault trees.</onlyinclude>
 
== Syntax ==
'''.BlockSim.GetAllFaultTrees()'''
 
 
==Example==
'''VBA|VB.NET'''
 
{{APIComment|'Connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
{{APIComment|'Connect to project#1 in the repository.}}
  MyRepository.Project.SetCurrentProject (1)
   
{{APIComment|'Get a list of all fault trees in project #1.}}
  {{APIPrefix|Dim}} ListofFTs() {{APIPrefix|As}} NameIdPair
  ListofFTs = MyRepository.BlockSim.GetAllFaultTrees()
{{APIComment|'Output sample: Display the number of fault trees in the project.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofFTs) - LBound(ListofFTs) + 1
  MsgBox (NumberofElements)

Latest revision as of 23:29, 6 September 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Gets a list of all BlockSim fault trees associated with a project. Returns a NameIdPair object that represents the name and ID pairs of the fault trees.

Syntax

.BlockSim.GetAllFaultTrees()


Example

VBA|VB.NET
 
 'Connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Connect to project#1 in the repository. 
  MyRepository.Project.SetCurrentProject (1)
   
 'Get a list of all fault trees in project #1. 
  Dim ListofFTs() As NameIdPair
  ListofFTs = MyRepository.BlockSim.GetAllFaultTrees()

 'Output sample: Display the number of fault trees in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofFTs) - LBound(ListofFTs) + 1
  MsgBox (NumberofElements)