ALTAStressProfile Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(16 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_ALTA|Global ALTA}}  
{{Template:API}}{{Template:DeprecatedAPI|class}}{{Template:APIBreadcrumb}}
{{Template:ALTAStressProfile Class.Cmt}}


==Constructors==
This section contains information on how to create a new stress profile.
*'''[[New ALTAStressProfile]]''' {{APIComment|{{Template:New ALTAStressProfile.Cmt}}}}


== Methods==
Represents a time-dependent stress profile.
This section contains the methods that a user might use to manipulate their stress profile.
 
*'''[[ALTAStressProfile.AddSegment|AddSegment]]''' {{APIComment|{{Template:ALTAStressProfile.AddSegment.Cmt}}}}
== Constructor  ==
*'''[[ALTAStressProfile.GetSegments|GetSegments]]''' {{APIComment|{{Template:ALTAStressProfile.GetSegments.Cmt}}}}
{| {{APITable}}
|-
| style="width: 180px;"|ALTAStressProfile||Creates an instance of the ALTAStressProfile class.
|-
|[[ALTAStressProfile Constructors|ALTAStressProfile()]]||{{:ALTAStressProfile Constructors}}
|}
 
 
== Methods  ==
{| {{APITable}}
|-
| style="width: 180px;"|[[ALTAStressProfile.AddSegment|AddSegment]]||{{:ALTAStressProfile.AddSegment}}
|-
|[[ALTAStressProfile.Clear|Clear]]||{{:ALTAStressProfile.Clear}}
|-
|[[ALTAStressProfile.GetSegments|GetSegments()]]||{{:ALTAStressProfile.GetSegments}}
|}
 


== Properties ==
== Properties ==
This section contains properties that a user may use to analyse their stress profile.
{| {{APITable}}
*'''[[ALTAStressProfile.Name|Name]]''' {{APIComment|{{Template:ALTAStressProfile.Name.Cmt}}}}
|-
*'''[[ALTAStressProfile.RepeatCycle|RepeatCycle]]''' {{APIComment|{{Template:ALTAStressProfile.RepeatCycle.Cmt}}}}
| style="width: 180px;"|Name||Gets or sets the name of the stress profile. '''String'''.
|-
|RepeatCycle||Indicates whether to cycle through the segments; otherwise, continues with the last stress. '''Boolean'''. Default value = False.
|}




== Formatted Usage Example ==


{{APIComment|Declare the ALTADataSet. See [[New ALTADataSet]] for additional details.}}
        Dim ALTADS as New ALTADataSet


{{APIComment|Declare an [[ALTAStressProfile Class|ALTAStressProfile]]. See [[ALTAStressProfile Class|ALTAStressProfile]] for additional details.}}
        Dim sp = New ALTAStressProfile("Profile1")
        sp.RepeatCycle = True
        sp.AddSegment(1, 250)
        sp.AddSegment(2, 300)
        sp.AddSegment(3, 400)


{{APIComment|Add the stress profile.}}
==See Also==
        '''ALTADS.AddStressProfile(sp)'''
*[[ALTADataSet.AddStressProfile 10|ALTADataSet.AddStressProfile Method]]

Latest revision as of 15:31, 23 March 2017

APIWiki.png


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 a time-dependent stress profile.

Constructor

Name Description
ALTAStressProfile Creates an instance of the ALTAStressProfile class.
ALTAStressProfile()   Deprecated   A parameterized constructor for the ALTAStressProfile class. (.NET only)


Methods

Name Description
AddSegment   Deprecated   Adds a new segment to the stress profile.
Clear   Deprecated   Deletes all segments in the stress profile.
GetSegments()   Deprecated   Returns an array of ALTASegment objects that represent the segments in the stress profile.


Properties

Name Description
Name Gets or sets the name of the stress profile. String.
RepeatCycle Indicates whether to cycle through the segments; otherwise, continues with the last stress. Boolean. Default value = False.



See Also

Retrieved from "https://www.reliawiki.com/index.php?title=ALTAStressProfile_Class&oldid=64983"