Repository.BlockSim.GetAllRBDBlocksData: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:API}}{{Template:APIBreadcrumb|.Repository}}')
 
No edit summary
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
<onlyinclude>Gets an array containing the data of all blocks in a BlockSim reliability block diagram (RBD) or fault tree. Returns an '''[[RBDBlockData Class|RBDBlockData]]''' object that represents the properties of each block.</onlyinclude>
==Syntax==
'''.BlockSim.GetAllRBDBlocksData'''(''DiagramID'')
===Properties===
''DiagramID''
:Required. Integer. The numeric ID of the RBD or fault tree.
==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 a project that contains a BlockSim diagram.}}
  MyRepository.Project.SetCurrentProject(1)
{{APIComment|'Get all block data in diagram #21.}}
  {{APIPrefix|Dim}} ABlock() {{APIPrefix|As}} RBDBlockData
  ABlock = MyRepository.BlockSim.GetAllRBDBlocksData(21)
{{APIComment|'Display the name and ID of the first block in the array.}}
  {{APIPrefix|Dim}} Name {{APIPrefix|As}} String
  {{APIPrefix|Dim}} ID {{APIPrefix|As}} Integer
  Name= ABlock(0).DisplayName
  ID= ABlock(0).BlockID
  MsgBox (Name & {{APIString|", "}} & ID)

Latest revision as of 23:31, 6 September 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Gets an array containing the data of all blocks in a BlockSim reliability block diagram (RBD) or fault tree. Returns an RBDBlockData object that represents the properties of each block.

Syntax

.BlockSim.GetAllRBDBlocksData(DiagramID)

Properties

DiagramID

Required. Integer. The numeric ID of the RBD or fault tree.


Example

VBA|VB.NET

 'Connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Connect to a project that contains a BlockSim diagram. 
  MyRepository.Project.SetCurrentProject(1)

 'Get all block data in diagram #21. 
  Dim ABlock() As RBDBlockData
  ABlock = MyRepository.BlockSim.GetAllRBDBlocksData(21)

 'Display the name and ID of the first block in the array. 
  Dim Name As String
  Dim ID As Integer
  Name= ABlock(0).DisplayName
  ID= ABlock(0).BlockID
  MsgBox (Name & ", " & ID)