Difference between revisions of "Repository.Xfmea.GetAllXfmeaCausesDictionary Method"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
  
  
<onlyinclude>Gets a dictionary of the causes associated with a failure. Returns a '''Dictionary(Of Integer, [[XfmeaCause Class|XfmeaCause]])''' object, where the keys are the ID numbers of the causes. (VB.NET only)</onlyinclude>
+
<onlyinclude>Returns a dictionary object that contains all available causes associated with a failure. The dictionary syntax is '''Dictionary(Of Integer, XfmeaCause)''', where the ID numbers are the keys, and the [[XfmeaCause Class|XfmeaCause]] objects that represent the causes are the associated values. (VB.NET only)</onlyinclude>
  
 
== Syntax ==
 
== Syntax ==
Line 10: Line 10:
 
''FailureID''
 
''FailureID''
 
:Required. Integer. The record ID of the failure.
 
:Required. Integer. The record ID of the failure.
 
  
  
Line 20: Line 19:
 
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
+
  {{APIComment|'Open project #1 and get a dictionary of all causes associated with failure #1.}}
+
  {{APIComment|'Set the first project in the repository as the current project.}}
 +
  MyRepository.Project.SetCurrentProject(1
 +
 
 +
{{APIComment|'Declare a new dictionary object.}}
 
   {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaCause)   
 
   {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaCause)   
  MyRepository.Project.SetCurrentProject(1) 
+
 +
{{APIComment|'Add values to the dictionary.}}
 
   Dict = MyRepository.Xfmea.GetAllXfmeaCausesDictionary(1)
 
   Dict = MyRepository.Xfmea.GetAllXfmeaCausesDictionary(1)
 
   
 
   
 
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
 
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
 
   MsgBox(Dict.Count)
 
   MsgBox(Dict.Count)

Revision as of 18:04, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a dictionary object that contains all available causes associated with a failure. The dictionary syntax is Dictionary(Of Integer, XfmeaCause), where the ID numbers are the keys, and the XfmeaCause objects that represent the causes are the associated values. (VB.NET only)

Syntax

.Xfmea.GetAllXfmeaCausesDictionary(FailureID)

Parameters

FailureID

Required. Integer. The record ID of the failure.


Example

This example assumes that system hierarchy items with FMEAs exists in the first available project of a repository.

VB.NET 

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Set the first project in the repository as the current project. 
  MyRepository.Project.SetCurrentProject(1)  
  
 'Declare a new dictionary object. 
  Dim Dict As Dictionary (of Integer, XfmeaCause)  

 'Add values to the dictionary. 
  Dict = MyRepository.Xfmea.GetAllXfmeaCausesDictionary(1)

 'Output sample: Display the number of entries in the dictionary. 
  MsgBox(Dict.Count)