ALTADataSet.AddSuspension: Difference between revisions
Jump to navigation
Jump to search
Chris Kahn (talk | contribs) |
Kate Racaza (talk | contribs) No edit summary |
||
(5 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
{{Template: | {{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> | ||
<onlyinclude>Adds suspensions to the data set.</onlyinclude> | |||
==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'') | |||
===Parameters=== | |||
''Value'' | |||
:Required. Double. The suspension time. | |||
''NumberinGroup'' | |||
:Required. Integer. The number of suspended units at the time of suspension. | |||
{{APIComment|'Declare a new ALTADataSet object | ''Stress()'' | ||
: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 | {{APIComment|'Define a stress type with use stress level = 10.}} | ||
{{APIPrefix|Call}} ADS.AddStressDefinition({{APIString|"Stress1"}},,10) | |||
{{APIComment|'Add | {{APIComment|'Add suspensions for Stress1 = 190.}} | ||
ADS. | {{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 = 10.}} | |||
ADS.AddStressDefinition({{APIString|"Stress1"}},,10) | |||
{{APIComment|'Add suspensions for Stress1 = 190.}} | |||
ADS.AddSuspension(100, 1, 190) | |||
ADS.AddSuspension(120, 1, 190) | |||
ADS.AddSuspension(130, 1, 190) | |||
== See Also == | |||
*[[ALTADataSet.AddStressProfile|ALTADataSet.AddStressProfile Method]] |
Latest revision as of 23:42, 22 March 2017
Member of: SynthesisAPI.ALTADataSet
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)