ALTADataSet.AddStressDefinition: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(31 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|ALTADataSet Class|ALTADataSet}}
{{Template:API}}{{Template:APIBreadcrumb|.[[ALTADataSet_Class|ALTADataSet]]}}


Sets a new stress definition(column) to be used.


== Declaration  ==
<onlyinclude>Adds a stress type to the data set.</onlyinclude>
{{APIName|AddStressDefinition(}}
{{APIPrefix|ByVal}}
{{APIName|Name}}
{{APIPrefix|As String, Optional ByVal}}
{{APIName|StressRelation}}
{{APIPrefix|As [[ALTASolverLSR]]}}
=
{{APIName|[[ALTASolverLSR]].Exponential,}}
{{APIPrefix|Optional ByVal,}}
{{APIName|UseStress}}
{{APIPrefix|As Double}}
=
{{APIName|1)}}


{{APIComment|Adds a stress definition (column). The number of stresses in subsequent calls to AddFailure, AddSuspension etc. must be equal to the number of stress definitions in the data set.}}
==Syntax==
'''.AddStressDefinition'''(''Name'', ''StressRelation'', ''UseStress'')


== Parameters ==
===Parameters===
'''Name'''
''Name''
The name of the new stress definition
:Required. String. The name of the stress.


'''StressRelation'''
''StressRelation''
The relation to set the new stress definition
:Optional. The stress transformation that will be applied to the stress. Applies to the general log-linear (GLL) or cumulative damage (CD) models only. Can be any [[ALTASolverLSR_Enumeration|ALTASolverLSR]] constant. Default value &#61; 0 (exponential life-stress relationship).


'''UseStress'''
''UseStress''
The Use stress level
:Optional. Double. The use stress level. Default value &#61; 1.


== Usage Example ==


{{APIComment|Declare the ALTADataSet. See [[New ALTADataSet]] for additional details.}}
== Example ==
        Dim ALTADS as New ALTADataSet
The following example demonstrates how to add stress definitions to an ALTADataSet object.


{{APIComment|Declare an [[ALTAStressProfile Class|ALTAStressProfile]]. See [[ALTAStressProfile Class|ALTAStressProfile]] for additional details.}}
'''VBA'''
        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 2 stress types with use stress levels &#61; 10 and 25.}}
  {{APIPrefix|Call}} ADS.AddStressDefinition({{APIString|"Stress1"}},,10)
  {{APIPrefix|Call}} ADS.AddStressDefinition({{APIString|"Stress2"}},,25)
 
{{APIComment|'Add failure times for Stress1 &#61; 190 and Stress2 &#61; 235.}}
  {{APIPrefix|Call}} ADS.AddFailure_3(100, 1, 190, 235)
  {{APIPrefix|Call}} ADS.AddFailure_3(120, 1, 190, 235)
  {{APIPrefix|Call}} ADS.AddFailure_3(130, 1, 190, 235)


{{APIComment|Add the stress profile}}
'''VB.NET'''
        ALTADS.AddStressProfile(sp)
 
 
{{APIComment|'Declare a new ALTADataSet object.}}  
{{APIComment|Add values to the raw data. See [[ALTADataSet.AddFailure|AddFailure]] for additional details.]}}
  {{APIPrefix|Dim}} ADS {{APIPrefix|As New}} ALTADataSet
        ALTADS.AddFailure(1, 1, sp)
 
        ALTADS.AddFailure(2, 1, sp)
{{APIComment|'Define 2 stress types with use stress levels &#61; 10 and 25.}}
        ALTADS.AddFailure(3, 1, sp)
  ADS.AddStressDefinition({{APIString|"Stress1"}},,10)
 
  ADS.AddStressDefinition({{APIString|"Stress2"}},,25)
{{APIComment|Add a new stress definition.}}
        '''ALTADS.AddStressDefinition("NewStress1")'''
{{APIComment|'Add failure times for Stress1 &#61; 190 and Stress2 &#61; 235.}}
 
  ADS.AddFailure(100, 1, 190, 235)
{{APIComment|Add values to the raw data. With the addition of "NewStress1", AddFailure now requires an additional stress.}}
  ADS.AddFailure(120, 1, 190, 235)
        Dim sp2 = New ALTAStressProfile("Profile1")
  ADS.AddFailure(130, 1, 190, 235)
        sp2.RepeatCycle = True
        sp2.AddSegment(4, 100)
        sp2.AddSegment(5, 200)
        sp2.AddSegment(6, 300)
        ALTADS.AddStressProfile(sp2)
        ALTADS.AddFailure(4, 1, sp, sp2)
        ALTADS.AddFailure(5, 1, sp, sp2)
        ALTADS.AddFailure(6, 1, sp, sp2)

Latest revision as of 20:41, 24 June 2016

APIWiki.png


Member of: SynthesisAPI.ALTADataSet


Adds a stress type to the data set.

Syntax

.AddStressDefinition(Name, StressRelation, UseStress)

Parameters

Name

Required. String. The name of the stress.

StressRelation

Optional. The stress transformation that will be applied to the stress. Applies to the general log-linear (GLL) or cumulative damage (CD) models only. Can be any ALTASolverLSR constant. Default value = 0 (exponential life-stress relationship).

UseStress

Optional. Double. The use stress level. Default value = 1.


Example

The following example demonstrates how to add stress definitions to an ALTADataSet object.

VBA

 'Declare a new ALTADataSet object.  
  Dim ADS As New ALTADataSet
 
 'Define 2 stress types with use stress levels = 10 and 25. 
  Call ADS.AddStressDefinition("Stress1",,10)
  Call ADS.AddStressDefinition("Stress2",,25)
 
 'Add failure times for Stress1 = 190 and Stress2 = 235. 
  Call ADS.AddFailure_3(100, 1, 190, 235)
  Call ADS.AddFailure_3(120, 1, 190, 235)
  Call ADS.AddFailure_3(130, 1, 190, 235)
VB.NET
 
 'Declare a new ALTADataSet object.  
  Dim ADS As New ALTADataSet
 
 'Define 2 stress types with use stress levels = 10 and 25. 
  ADS.AddStressDefinition("Stress1",,10)
  ADS.AddStressDefinition("Stress2",,25)

 'Add failure times for Stress1 = 190 and Stress2 = 235. 
  ADS.AddFailure(100, 1, 190, 235)
  ADS.AddFailure(120, 1, 190, 235)
  ADS.AddFailure(130, 1, 190, 235)