ALTAStressProfile.GetSegments: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "ALTAStressProfile.GetSegments" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
 
(11 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]]}}


Returns an array of the stress profile segments


== Method Syntax ==
<onlyinclude><includeonly>{{DeprecatedAPIpic}}</includeonly>Returns an array of [[ALTASegment Class|ALTASegment]] objects that represent the segments in the stress profile. </onlyinclude>
{{APIPrefix|Public Function}}{{APIName|GetSegments()}}
{{APIComment|Returns an array of the stress profile segments.}}


== Usage Example ==
== Syntax ==
'''.GetSegments()'''


{{APIComment|Declare an [[ALTAStressProfile Class|ALTAStressProfile]]. See [[ALTAStressProfile Class|ALTAStressProfile]] for additional details.}}
        Dim SP As New ALTAStressProfile("Profile1")


{{APIComment|Add segments.}}
== Example ==
        SP.AddSegment(1, 250)
'''VBA'''
        SP.AddSegment(2, 300)
        SP.AddSegment(3, 400)
{{APIComment|'Declare a new 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|'Get segments.}}
  {{APIPrefix|Dim}} StressSegments() {{APIPrefix|As}} ALTASegment
  StressSegments = SP.GetSegments


{{APIComment|Get segments.}}
'''VB.NET'''
        Dim StressSegments() As [[ALTASegment Class|ALTASegment]]
        StressSegments = SP.GetSegments
{{APIComment|'Declare a new ALTAStressProfile object.}}
  {{APIPrefix|Dim}} SP {{APIPrefix|As New}} ALTAStressProfile
 
{{APIComment|'Add segments.}}
  SP.AddSegment(1, 250)
  SP.AddSegment(2, 300)
  SP.AddSegment(3, 400)
 
{{APIComment|'Get segments.}}
  {{APIPrefix|Dim}} StressSegments() {{APIPrefix|As}} ALTASegment
  StressSegments = SP.GetSegments

Latest revision as of 22:05, 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


Returns an array of ALTASegment objects that represent the segments in the stress profile.

Syntax

.GetSegments()


Example

VBA

 'Declare a new ALTAStressProfile object. 
 Dim SP As New ALTAStressProfile
 
 'Add segments. 
 Call SP.AddSegment(1, 250)
 Call SP.AddSegment(2, 300)
 Call SP.AddSegment(3, 400)
 
 'Get segments. 
 Dim StressSegments() As ALTASegment
 StressSegments = SP.GetSegments
VB.NET

 'Declare a new ALTAStressProfile object. 
 Dim SP As New ALTAStressProfile
 
 'Add segments. 
 SP.AddSegment(1, 250)
 SP.AddSegment(2, 300)
 SP.AddSegment(3, 400)
 
 'Get segments. 
 Dim StressSegments() As ALTASegment
 StressSegments = SP.GetSegments