ALTADataSet.AddSuspensionInterval: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|ALTADataSet Class|ALTADataSet}} Inserts a suspension interval to the ALTADataSet. == Method Syntax == {{APIName|AddSuspensionInterval(}} {{APIPrefix|ByVal}}…')
 
No edit summary
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|ALTADataSet Class|ALTADataSet}}
{{Template:API}}{{Template:APIBreadcrumb|.[[ALTADataSet_Class|ALTADataSet]]}}<div style="border:1px solid #D0CDE8; background:#EEEDF7; border-radius:10px; width:auto; margin:0 0 1em 1em; padding:1em; float:right;"><span style="font-family:arial;font-size:5;color:#585858">Other Versions: [[ALTADataSet.AddSuspensionInterval 10|Version 10]]</span></div>


Inserts a suspension interval to the ALTADataSet.


== Method Syntax ==
<onlyinclude>Adds interval censored suspensions to the data set.</onlyinclude>
{{APIName|AddSuspensionInterval(}}
{{APIPrefix|ByVal}}
{{APIName|StartValue}}
{{APIPrefix|As Double}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|EndValue}}
{{APIPrefix|As Double}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|NumberInGroup}}
{{APIPrefix|As Integer}}
{{APIName|,}}
{{APIPrefix|ByRef}}
{{APIName|Stress()}}
{{APIPrefix|As Object}}
{{APIName|)}}


{{APIName|AddSuspensionInterval(}}
==Syntax==
{{APIPrefix|ByVal}}
'''VBA'''
{{APIName|StartValue}}
{{APIPrefix|As Double}}
'''.AddSuspensionInterval'''(''StartValue'', ''EndValue'', ''NumberinGroup'', {{APIPrefix|ByRef}} ''Stress()'')
{{APIName|,}}
{{APIPrefix|ByVal}}
'''.AddSuspensionInterval_2'''(''StartValue'', ''EndValue'', ''NumberinGroup'', ''Stress1'')
{{APIName|EndValue}}
{{APIPrefix|As Double}}
'''.AddSuspensionInterval_3'''(''StartValue'', ''EndValue'', ''NumberinGroup'', ''Stress1'', ''Stress2'')
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|NumberInGroup}}
{{APIPrefix|As Integer}}
{{APIName|,}}
{{APIPrefix|ByRef}}
{{APIName|Stress1}}
{{APIPrefix|As Object}}
{{APIName|)}}


{{APIName|AddSuspensionInterval(}}
'''VB.NET'''
{{APIPrefix|ByVal}}
{{APIName|StartValue}}
'''.AddSuspensionInterval'''(''StartValue'', ''EndValue'', ''NumberinGroup'', {{APIPrefix|ByRef}} ''Stress()'')
{{APIPrefix|As Double}}
{{APIName|,}}
'''.AddSuspensionInterval'''(''StartValue'', ''EndValue'', ''NumberinGroup'', ''Stress1'')
{{APIPrefix|ByVal}}
{{APIName|EndValue}}
'''.AddSuspensionInterval'''(''StartValue'', ''EndValue'', ''NumberinGroup'', ''Stress1'', ''Stress2'')
{{APIPrefix|As Double}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|NumberInGroup}}
{{APIPrefix|As Integer}}
{{APIName|,}}
{{APIPrefix|ByRef}}
{{APIName|Stress1, Stress2}}
{{APIPrefix|As Object}}
{{APIName|)}}
<br> {{APIComment|Adds a suspension interval to the collection of data points in the data set.}}


== Parameters ==
===Parameters===
'''StartValue'''
''StartValue''
The starting value of this suspension interval.
:Required. Double. The starting value of the suspension interval.


'''EndValue'''
''EndValue''
The ending value of this suspension interval.
:Required. Double. The ending value of the suspension interval.


'''NumberInGroup'''
''NumberInGroup''
The number of units that were suspended during this interval.
:Required. Integer. The number of units that were suspended during the interval.


'''Stress()'''
''Stress()''
An array of numeric values or references to [[ALTAStressProfile Class|ALTAStressProfiles]] already entered into the ALTADataSet
:Required. Object. Can be an array of numeric stress values or [[CProfile_Class|Profile]] objects.


'''Stress1'''
''Stress1''
An numeric value or a reference to an [[ALTAStressProfile Class|ALTAStressProfile]]
:Required. Object. The stress value for the first stress definition. Can be a numeric stress value or [[CProfile_Class|Profile]] object.


'''Stress2'''
''Stress2''
An numeric value or a reference to an [[ALTAStressProfile Class|ALTAStressProfile]]
:Required. Object. The stress value for the second stress definition. Can be a numeric stress value or [[CProfile_Class|Profile]] object.


{{APIComment|Adds a suspension interval to the collection of data points in the data set.}}


== Usage Example ==
== Example ==
The following example demonstrates how to add suspension intervals to an ALTADataSet object.


{{APIComment|Declare the ALTADataSet. See [[New ALTADataSet]] for additional details.}}
'''VBA'''
        Dim ALTADS as New ALTADataSet
{{APIComment|'Declare a new ALTADataSet object.}}
  {{APIPrefix|Dim}} ADS {{APIPrefix|As New}} ALTADataSet
 
{{APIComment|'Define a stress type with use stress level &#61; 10.}}
  {{APIPrefix|Call}} ADS.AddStressDefinition({{APIString|"Temperature"}},,10)
 
{{APIComment|'Add suspensions for Temperature &#61; 190.}}
  {{APIPrefix|Call}} ADS.AddSuspensionInterval_2(100, 120, 1, 190)
  {{APIPrefix|Call}} ADS.AddSuspensionInterval_2(120, 130, 1, 190)
  {{APIPrefix|Call}} ADS.AddSuspensionInterval_2(130, 140, 1, 190)


{{APIComment|Declare an [[ALTAStressProfile Class|ALTAStressProfile]]. See [[ALTAStressProfile Class|ALTAStressProfile]] for additional details.}}
'''VB.NET'''
        Dim sp = New ALTAStressProfile("Profile1")
 
        sp.RepeatCycle = True
{{APIComment|'Declare a new ALTADataSet object.}}
        sp.AddSegment(1, 250)
  {{APIPrefix|Dim}} ADS {{APIPrefix|As New}} ALTADataSet
        sp.AddSegment(2, 300)
 
        sp.AddSegment(3, 400)
{{APIComment|'Define a stress type with use stress level &#61; 10.}}
  ADS.AddStressDefinition({{APIString|"Temperature"}},,10)
 
{{APIComment|'Add suspensions for Temperature &#61; 190.}}
  ADS.AddSuspensionInterval(100, 120, 1, 190)
  ADS.AddSuspensionInterval(120, 130, 1, 190)
  ADS.AddSuspensionInterval(130, 140, 1, 190)


{{APIComment|Add values to the raw data.}}
== See Also ==
        ALTADS.AddSuspensionInterval(1, 5, 1, sp)
*[[ALTADataSet.AddStressProfile|ALTADataSet.AddStressProfile Method]]
        ALTADS.AddSuspensionInterval(6, 10, 1, sp)
        ALTADS.AddSuspensionInterval(11, 15, 1, sp)

Latest revision as of 23:48, 22 March 2017

APIWiki.png


Member of: SynthesisAPI.ALTADataSet

Other Versions: Version 10


Adds interval censored suspensions to the data set.

Syntax

VBA

.AddSuspensionInterval(StartValue, EndValue, NumberinGroup, ByRef Stress())

.AddSuspensionInterval_2(StartValue, EndValue, NumberinGroup, Stress1)

.AddSuspensionInterval_3(StartValue, EndValue, NumberinGroup, Stress1, Stress2)

VB.NET

.AddSuspensionInterval(StartValue, EndValue, NumberinGroup, ByRef Stress())

.AddSuspensionInterval(StartValue, EndValue, NumberinGroup, Stress1)

.AddSuspensionInterval(StartValue, EndValue, NumberinGroup, Stress1, Stress2)

Parameters

StartValue

Required. Double. The starting value of the suspension interval.

EndValue

Required. Double. The ending value of the suspension interval.

NumberInGroup

Required. Integer. The number of units that were suspended during the interval.

Stress()

Required. Object. Can be an array of numeric stress values or Profile objects.

Stress1

Required. Object. The stress value for the first stress definition. Can be a numeric stress value or Profile object.

Stress2

Required. Object. The stress value for the second stress definition. Can be a numeric stress value or Profile object.


Example

The following example demonstrates how to add suspension intervals to an ALTADataSet object. 

VBA

 'Declare a new ALTADataSet object.  
  Dim ADS As New ALTADataSet
 
 'Define a stress type with use stress level = 10. 
  Call ADS.AddStressDefinition("Temperature",,10)
  
 'Add suspensions for Temperature = 190. 
  Call ADS.AddSuspensionInterval_2(100, 120, 1, 190)
  Call ADS.AddSuspensionInterval_2(120, 130, 1, 190)
  Call ADS.AddSuspensionInterval_2(130, 140, 1, 190)

VB.NET
 
 'Declare a new ALTADataSet object.  
  Dim ADS As New ALTADataSet
 
 'Define a stress type with use stress level = 10. 
  ADS.AddStressDefinition("Temperature",,10)
  
 'Add suspensions for Temperature = 190. 
  ADS.AddSuspensionInterval(100, 120, 1, 190)
  ADS.AddSuspensionInterval(120, 130, 1, 190)
  ADS.AddSuspensionInterval(130, 140, 1, 190)

See Also

Retrieved from "https://www.reliawiki.com/index.php?title=ALTADataSet.AddSuspensionInterval&oldid=64971"