Repository.Xfmea.GetAllXfmeaCauses Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:




<onlyinclude>Gets a list of causes associated with a failure. Returns an '''[[XfmeaCause Class|XfmeaCause]]''' object array that contains all the causes in that failure.</onlyinclude>   
<onlyinclude>Returns an array of '''[[XfmeaCause Class|XfmeaCause]]''' objects that represent the causes associated with a failure.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 17: Line 17:
  '''VBA|VB.NET'''
  '''VBA|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|'Get a list of all causes associated with failure #1 in project #1.}}
  {{APIComment|'Get a list of all causes associated with failure #1 in project #1.}}
  {{APIPrefix|Dim}} ListofCauses() {{APIPrefix|As}} XfmeaCause
  {{APIPrefix|Dim}} ListofCauses() {{APIPrefix|As}} XfmeaCause
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  ListofCauses = MyRepository.Xfmea.GetAllXfmeaCauses(1)
  ListofCauses = MyRepository.Xfmea.GetAllXfmeaCauses(1)
   
   
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIComment|'Output sample: Display the number of causes.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofCauses) - LBound(ListofCauses) + 1
  NumberofElements = UBound(ListofCauses) - LBound(ListofCauses) + 1
  MsgBox (NumberofElements)
  MsgBox (NumberofElements)

Latest revision as of 18:31, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of XfmeaCause objects that represent the causes associated with a failure.

Syntax

.Xfmea.GetAllXfmeaCauses(FailureID)

Parameters

FailureID

Required. Integer. The record ID of the failure.


Example

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

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
   
 'Get a list of all causes associated with failure #1 in project #1. 
  Dim ListofCauses() As XfmeaCause
  MyRepository.Project.SetCurrentProject (1)  
  ListofCauses = MyRepository.Xfmea.GetAllXfmeaCauses(1)

 'Output sample: Display the number of causes. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofCauses) - LBound(ListofCauses) + 1
  MsgBox (NumberofElements)