Repository.Xfmea.GetAllXfmeaFailuresDictionary Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>Gets a dictionary of the failures associated with an FMEA function. Returns a '''Dictionary(Of Integer, [[XfmeaFailure Class|XfmeaFailure]])''' object, where the keys are the ID numbers of the failures. (VB.NET only)</onlyinclude>
<onlyinclude>Returns a dictionary object that contains all available failures associated with an FMEA function. The dictionary syntax is '''Dictionary(Of Integer, XfmeaFailure)''', where the ID numbers are the keys, and the [[XfmeaFailure Class|XfmeaFailure]] objects that represent the failures are the associated values. (.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
Line 10: Line 10:
''FunctionID''
''FunctionID''
:Required. Integer. The record ID of the FMEA function.
:Required. Integer. The record ID of the FMEA function.




Line 17: Line 16:
  '''VB.NET'''  
  '''VB.NET'''  
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
{{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, XfmeaFailure) 
   
   
  {{APIComment|'Open project #1 and get a dictionary of all failures associated with FMEA function #1.}}
  {{APIComment|'Add values to the dictionary.}}
  {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaFailure) 
  Dict = MyRepository.Xfmea.GetAllXfmeaFailuresDictionary(1)
  MyRepository.Project.SetCurrentProject(1) 
  Dict = MyRepository.Xfmea.GetAllXfmeaFailuresDictionary(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 failures associated with an FMEA function. The dictionary syntax is Dictionary(Of Integer, XfmeaFailure), where the ID numbers are the keys, and the XfmeaFailure objects that represent the failures are the associated values. (.NET only)

Syntax

.Xfmea.GetAllXfmeaFailuresDictionary(FunctionID)

Parameters

FunctionID

Required. Integer. The record ID of the FMEA function.


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, XfmeaFailure)  

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

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