Repository.Xfmea.GetAllXfmeaFunctionsDictionary 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 FMEA functions associated with a system hierarchy item. Returns a '''Dictionary(Of Integer, [[XfmeaFunction Class|XfmeaFunction]])''' object, where the keys are the ID numbers of the functions. (VB.NET only)</onlyinclude>
<onlyinclude>Returns a dictionary object that contains all available FMEA functions associated with a system hierarchy item. The dictionary syntax is '''Dictionary(Of Integer, XfmeaFunction)''', where the ID numbers are the keys, and the [[XfmeaFunction Class|XfmeaFunction]] objects that represent the FMEA functions are the associated values. (.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
Line 9: Line 9:
===Parameters===
===Parameters===
''HID''
''HID''
:Required. Integer. The Hierarchy ID or record ID of the system hierarchy item.
:Required. Integer. The record ID of the system hierarchy item.


''IncludeLinkedAnalyses''
''IncludeLinkedAnalyses''
Line 19: Line 19:
  '''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, XfmeaFunction) 
   
   
  {{APIComment|'Open project #1 and get a dictionary of all FMEA functions associated with system hierarchy item #1.}}
  {{APIComment|'Add values to the dictionary.}}
  {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaFunction) 
  Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, {{APIPrefix|True)}}
  MyRepository.Project.SetCurrentProject(1) 
  Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, {{APIPrefix|True)}}
   
   
  {{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 FMEA functions associated with a system hierarchy item. The dictionary syntax is Dictionary(Of Integer, XfmeaFunction), where the ID numbers are the keys, and the XfmeaFunction objects that represent the FMEA functions are the associated values. (.NET only)

Syntax

.Xfmea.GetAllXfmeaFunctionsDictionary(HID,IncludeLinkedAnalyses)

Parameters

HID

Required. Integer. The record ID of the system hierarchy item.

IncludeLinkedAnalyses

Required. Boolean. Indicates whether to include linked FMEAs in the dictionary.


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

 'Add values to the dictionary. 
  Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, True)

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