Repository.Xfmea.GetAllXfmeaEffects Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 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 list of effects associated with an FMEA failure. Returns an '''[[XfmeaEffect Class|XfmeaEffect]]''' object array that contains all the effects in that FMEA failure.</onlyinclude>   
<onlyinclude>Returns an array of '''[[XfmeaEffect Class|XfmeaEffect]]''' objects that represent the effects associated with a failure.</onlyinclude>   


Note that grouped effects are counted as a single element in the array.  
 
'''Remarks''': Grouped effects are counted as a single element in the array.  


== Syntax ==
== Syntax ==
Line 11: Line 12:
===Parameters===
===Parameters===
''FailureID''
''FailureID''
:Required. Integer. The record ID of the FMEA failure.
:Required. Integer. The record ID of the failure.




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


  '''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 effects associated with failure #1 in project #1.}}
  {{APIComment|'Get a list of all effects associated with FMEA failure #1 in project #1.}}
  {{APIPrefix|Dim}} ListofEffects() {{APIPrefix|As}} XfmeaEffect
  {{APIPrefix|Dim}} ListofEffects() {{APIPrefix|As}} XfmeaEffect
  MyRepository.Project.SetCurrentProject (1)   
  MyRepository.Project.SetCurrentProject (1)   
  ListofEffects = MyRepository.Xfmea.GetAllXfmeaEffects(1)
  ListofEffects = MyRepository.Xfmea.GetAllXfmeaEffects(1)
   
   
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIComment|'Output sample: Display the number of effects.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofEffects) - LBound(ListofEffects) + 1
  NumberofElements = UBound(ListofEffects) - LBound(ListofEffects) + 1
  MsgBox (NumberofElements)
  MsgBox (NumberofElements)

Latest revision as of 20:40, 18 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of XfmeaEffect objects that represent the effects associated with a failure.


Remarks: Grouped effects are counted as a single element in the array.

Syntax

.Xfmea.GetAllXfmeaEffects(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 effects associated with failure #1 in project #1. 
  Dim ListofEffects() As XfmeaEffect
  MyRepository.Project.SetCurrentProject (1)  
  ListofEffects = MyRepository.Xfmea.GetAllXfmeaEffects(1)

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