ALTAStressProfile.AddSegment: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "ALTAStressProfile.AddSegment" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|ALTAStressProfile Class|ALTAStressProfile}}
{{Template:API}}{{Template:DeprecatedAPI}}{{Template:APIBreadcrumb|.[[ALTAStressProfile_Class|ALTAStressProfile]]}}


Add a new segment into the Stress Profile


== Method Syntax ==
<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Adds a new segment to the stress profile.</onlyinclude>
{{APIName|AddSegment(}}
{{APIPrefix|ByVal}}
{{APIName|SegmentEnd}}
{{APIPrefix|As Double}}
{{APIName|,}}
{{APIPrefix|ByVal}}
{{APIName|Stress}}
{{APIPrefix|As Double}}
{{APIName|)}}


{{APIComment|Adds a new segment to the stress profile.}}
== Syntax ==
'''.AddSegment'''(''SegmentEnd'', ''Stress'')


== Parameters ==
===Parameters===
'''SegmentEnd'''
''SegmentEnd''
The time at the end of this segment.
:Required. Double. The time at the end of this segment.


'''Stress'''
''Stress''
The stress during this segment.
:Required. Double. The stress value during this segment.


== Usage Example ==


{{APIComment|Declare an [[ALTAStressProfile Class|ALTAStressProfile]]. See [[ALTAStressProfile Class|ALTAStressProfile]] for additional details.}}
== Example ==
        Dim sp = New ALTAStressProfile("Profile1")
 
'''VBA'''
{{APIComment|'Declare an ALTAStressProfile object.}}
  {{APIPrefix|Dim}} sp {{APIPrefix|As New}} ALTAStressProfile
 
{{APIComment|'Add segments.}}
  {{APIPrefix|Call}} sp.AddSegment(1, 250)
  {{APIPrefix|Call}} sp.AddSegment(2, 300)
  {{APIPrefix|Call}} sp.AddSegment(3, 400)


{{APIComment|Add segments.}}
'''VB.NET'''
        sp.AddSegment(1, 250)
        sp.AddSegment(2, 300)
{{APIComment|'Declare an ALTAStressProfile object.}}
        sp.AddSegment(3, 400)
  {{APIPrefix|Dim}} sp {{APIPrefix|As New}} ALTAStressProfile
 
{{APIComment|'Add segments.}}
  sp.AddSegment(1, 250)
  sp.AddSegment(2, 300)
  sp.AddSegment(3, 400)

Latest revision as of 22:04, 23 March 2017

APIWiki.png


This method has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications.


Member of: SynthesisAPI.ALTAStressProfile


Adds a new segment to the stress profile.

Syntax

.AddSegment(SegmentEnd, Stress) 

Parameters

SegmentEnd

Required. Double. The time at the end of this segment.

Stress

Required. Double. The stress value during this segment.


Example

VBA

 'Declare an ALTAStressProfile object. 
 Dim sp As New ALTAStressProfile
 
 'Add segments. 
 Call sp.AddSegment(1, 250)
 Call sp.AddSegment(2, 300)
 Call sp.AddSegment(3, 400)
VB.NET

 'Declare an ALTAStressProfile object. 
 Dim sp As New ALTAStressProfile
 
 'Add segments. 
 sp.AddSegment(1, 250)
 sp.AddSegment(2, 300)
 sp.AddSegment(3, 400)