ALTADataSet.AddSuspension: Difference between revisions

Latest revision as of 23:42, 22 March 2017

Other Versions: Version 10

Adds suspensions to the data set.

Syntax

VBA

.AddSuspension(Value, NumberinGroup, ByRef Stress())

.AddSuspension_2(Value, NumberinGroup, Stress1)

.AddSuspension_3(Value, NumberinGroup, Stress1, Stress2)

VB.NET

.AddSuspension(Value, NumberinGroup, ByRef Stress())

.AddSuspension(Value, NumberinGroup, Stress1)

.AddSuspension(Value, NumberinGroup, Stress1, Stress2)

Parameters

Value

Required. Double. The suspension time.

NumberinGroup

Required. Integer. The number of suspended units at the time of suspension.

Stress()

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

Stress1

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

Stress2

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

Example

The following example demonstrates how to add suspensions 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("Stress1",,10)
  
 'Add suspensions for Stress1 = 190. 
  Call ADS.AddSuspension_2(100, 1, 190)
  Call ADS.AddSuspension_2(120, 1, 190)
  Call ADS.AddSuspension_2(130, 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("Stress1",,10)
 
 'Add suspensions for Stress1 = 190. 
  ADS.AddSuspension(100, 1, 190)
  ADS.AddSuspension(120, 1, 190)
  ADS.AddSuspension(130, 1, 190)

@@ 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.AddSuspension 10|Version 10]]</span></div>
-Adds suspensions to the data set, using the time at which the units were suspended, the number of suspensions at that time and the associated stress level.
-== Syntax ==
-<ul>
-<li>
-AddSuspension(
-{{APIName|Value}}
-{{APIPrefix|As Double}}
-{{APIName|,}}
-{{APIName|NumberInGroup}}
-{{APIPrefix|As Integer}}
-{{APIName|,}}
-{{APIName|Stress()}}
-{{APIPrefix|As Object}}
-{{APIName|)}}
-{{APIComment|{{Template:ALTADataSet.AddSuspension1.Cmt}}}}
-</li>
-<li>
-AddSuspension(
-{{APIName|Value}}
-{{APIPrefix|As Double}}
-{{APIName|,}}
-{{APIName|NumberInGroup}}
-{{APIPrefix|As Integer}}
-{{APIName|,}}
-{{APIName|Stress1}}
-{{APIPrefix|As Object}}
-{{APIName|)}}
-{{APIComment|{{Template:ALTADataSet.AddSuspension2.Cmt}}}}
-</li>
-<li>
-AddSuspension(
-{{APIName|Value}}
-{{APIPrefix|As Double}}
-{{APIName|,}}
-{{APIName|NumberInGroup}}
-{{APIPrefix|As Integer}}
-{{APIName|,}}
-{{APIName|Stress1}}
-{{APIPrefix|As Object}}
-{{APIName|,}}
-{{APIName|Stress2}}
-{{APIPrefix|As Object}}
-{{APIName|)}}{{APIComment|{{Template:ALTADataSet.AddSuspension3.Cmt}}}}
-</li>
-</ul>
-Parameters
+<onlyinclude>Adds suspensions to the data set.</onlyinclude>
-:''Value'': The suspension time.
-:''NumberInGroup'': The number of units that were suspended at the ''Value'' time.
+==Syntax==
+ '''VBA'''
+ '''.AddSuspension'''(''Value'', ''NumberinGroup'', {{APIPrefix|ByRef}} ''Stress()'')
+ '''.AddSuspension_2'''(''Value'', ''NumberinGroup'', ''Stress1'')
+ '''.AddSuspension_3'''(''Value'', ''NumberinGroup'', ''Stress1'', ''Stress2'')
+ '''VB.NET'''
+ '''.AddSuspension'''(''Value'', ''NumberinGroup'', {{APIPrefix|ByRef}} ''Stress()'')
+ '''.AddSuspension'''(''Value'', ''NumberinGroup'', ''Stress1'')
+ '''.AddSuspension'''(''Value'', ''NumberinGroup'', ''Stress1'', ''Stress2'')
-{{Template:ALTADataSet.StressParameters.Cmt}}
+===Parameters===
+''Value''
+:Required. Double. The suspension time.
-== Usage Example ==
+''NumberinGroup''
+:Required. Integer. The number of suspended units at the time of suspension.
-  {{APIComment|'Declare a new ALTADataSet object. See [[ALTADataSet Class|ALTADataSet]] for.}}
+''Stress()''
-  Dim ADS As New ALTADataSet("AddFailure_Example")
+:Required. Object. Can be an array of numeric stress values or [[CProfile_Class|cProfile]] objects.
+''Stress1''
+:Required. Object. The stress value for the first stress definition. Can be a numeric stress value or [[CProfile_Class|cProfile]] object.
+''Stress2''
+:Required. Object. The stress value for the second stress definition. Can be a numeric stress value or [[CProfile_Class|cProfile]] object.
+== Example ==
+The following example demonstrates how to add suspensions to an ALTADataSet object.
+ '''VBA'''
+  {{APIComment|'Declare a new ALTADataSet object.}}
+   {{APIPrefix|Dim}} ADS {{APIPrefix|As New}} ALTADataSet
-  {{APIComment|'Define a new stress. See [[ALTADataSet.AddStressDefinition|AddStressDefinition]].}}
+  {{APIComment|'Define a stress type with use stress level &#61; 10.}}
-  ADS.AddStressDefinition("Stress1")
+   {{APIPrefix|Call}} ADS.AddStressDefinition({{APIString|"Stress1"}},,10)
-  {{APIComment|'Add 5 suspensions at time &#61; 500 and stress &#61; 100 to the data set.}}
+  {{APIComment|'Add suspensions for Stress1 &#61; 190.}}
-   ADS.AddSuspensions(500, 5, 100)
+   {{APIPrefix|Call}} ADS.AddSuspension_2(100, 1, 190)
+   {{APIPrefix|Call}} ADS.AddSuspension_2(120, 1, 190)
+   {{APIPrefix|Call}} ADS.AddSuspension_2(130, 1, 190)
+ '''VB.NET'''
+ {{APIComment|'Declare a new ALTADataSet object.}}
+   {{APIPrefix|Dim}} ADS {{APIPrefix|As New}} ALTADataSet
+ {{APIComment|'Define a stress type with use stress level &#61; 10.}}
+   ADS.AddStressDefinition({{APIString|"Stress1"}},,10)
+ {{APIComment|'Add suspensions for Stress1 &#61; 190.}}
+   ADS.AddSuspension(100, 1, 190)
+   ADS.AddSuspension(120, 1, 190)
+   ADS.AddSuspension(130, 1, 190)
+== See Also ==
+*[[ALTADataSet.AddStressProfile|ALTADataSet.AddStressProfile Method]]

ALTADataSet.AddSuspension: Difference between revisions

Latest revision as of 23:42, 22 March 2017

Syntax

Parameters

Example

See Also

Navigation menu

Search