ALTASegment Class: Difference between revisions
		
		
		
		Jump to navigation
		Jump to search
		
| Chris Kahn (talk | contribs) No edit summary | Kate Racaza (talk | contribs) No edit summary | ||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| {{Template: | {{Template:API}}{{Template:DeprecatedAPI|class}}{{Template:APIBreadcrumb}} | ||
| Represents the time segments of an associated [[ALTAStressProfile Class|ALTAStressProfile]] object. | |||
| == Properties == | == Properties == | ||
| {| {{APITable}} | |||
| |- | |||
| | style="width: 180px;"|SegmentEnd||The segment's end time. '''Double'''. | |||
| |- | |||
| |SegmentStart||The segment's start time. '''Double'''. | |||
| |- | |||
| |Stress||The stress level throughout the segment. '''Double'''. | |||
| |} | |||
| == Example== | |||
|  '''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|'Get segments.}} | |||
|    {{APIPrefix|Dim}} StressSegments() {{APIPrefix|As}} ALTASegment | |||
|    StressSegments = SP.GetSegments | |||
|  {{APIComment|'Get the start time of the first segment.}} | |||
|    {{APIPrefix|Dim}} SegStart {{APIPrefix|As}} Double | |||
|    SegStart = StressSegments(0).SegmentStart | |||
|  '''VB.NET''' | |||
|  {{APIComment|'Declare an 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 | |||
|  {{APIComment|'Get the start time of the first segment.}} | |||
|    {{APIPrefix|Dim}} SegStart {{APIPrefix|As}} Double | |||
|    SegStart = StressSegments(0).SegmentStart | |||
Latest revision as of 15:32, 23 March 2017
|  | 
 This class has been deprecated and may be removed in future versions of the Synthesis API. Do not use it in new applications.  
Member of:  SynthesisAPI    
Represents the time segments of an associated ALTAStressProfile object.
Properties
| Name | Description | 
|---|---|
| SegmentEnd | The segment's end time. Double. | 
| SegmentStart | The segment's start time. Double. | 
| Stress | The stress level throughout the segment. Double. | 
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) 'Get segments. Dim StressSegments() As ALTASegment StressSegments = SP.GetSegments 'Get the start time of the first segment. Dim SegStart As Double SegStart = StressSegments(0).SegmentStart
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) 'Get segments. Dim StressSegments() As ALTASegment StressSegments = SP.GetSegments 'Get the start time of the first segment. Dim SegStart As Double SegStart = StressSegments(0).SegmentStart