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

From ReliaWiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
  
<onlyinclude>Gets a dictionary of the effects associated with a failure. Returns a '''Dictionary(Of Integer, [[XfmeaEffect Class|XfmeaEffect]])''' object, where the keys are the ID numbers of the effects. (VB.NET only)</onlyinclude>
+
<onlyinclude>Returns a dictionary object that contains all available effects associated with a failure. The dictionary syntax is '''Dictionary(Of Integer, XfmeaEffect)''', where the ID numbers are the keys, and the [[XfmeaEffect Class|XfmeaEffect]] objects that represent the effects are the associated values. (.NET only)</onlyinclude>
  
Note that grouped effects are counted as a single entry in the dictionary.
+
 
 +
'''Remarks''': Grouped effects are counted as a single entry in the dictionary.
  
 
== Syntax ==
 
== Syntax ==
Line 12: Line 13:
 
''FailureID''
 
''FailureID''
 
:Required. Integer. The record ID of the failure.
 
:Required. Integer. The record ID of the failure.
 
  
  
Line 23: Line 23:
 
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
    
 
    
  {{APIComment|'Open project #1 and get a dictionary of all effects 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, XfmeaEffect)   
 
   {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaEffect)   
  MyRepository.Project.SetCurrentProject(1) 
+
 +
{{APIComment|'Add values to the dictionary.}}
 
   Dict = MyRepository.Xfmea.GetAllXfmeaEffectsDictionary(1)
 
   Dict = MyRepository.Xfmea.GetAllXfmeaEffectsDictionary(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)

Latest revision as of 15:09, 3 August 2017

APIWiki.png


Member of: SynthesisAPI.Repository


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


Remarks: Grouped effects are counted as a single entry in the dictionary.

Syntax

.Xfmea.GetAllXfmeaEffectsDictionary(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, XfmeaEffect)  

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

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