ALTAStressProfile Class: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) |
Chris Kahn (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:APIClass| | {{Template:APIClass|ALTADataSet Class|ALTADataSet}} | ||
{{Template:ALTAStressProfile Class.Cmt}} | {{Template:ALTAStressProfile Class.Cmt}} | ||
==Constructors== | ==Constructors== | ||
*ALTAStressProfile {{APIComment|Creates a new ALTAStressProfile object.}} | |||
* | |||
== Methods== | == Methods== | ||
This section contains the methods that a user might use to manipulate their stress profile. | This section contains the methods that a user might use to manipulate their stress profile. | ||
* | *[[ALTAStressProfile.AddSegment|AddSegment( Double, Double )]] {{APIComment|{{Template:ALTAStressProfile.AddSegment.Cmt}}}} | ||
* | *[[ALTAStressProfile.GetSegments|GetSegments]] {{APIComment|{{Template:ALTAStressProfile.GetSegments.Cmt}}}} | ||
== Properties == | == Properties == | ||
This section contains properties that a user may use to analyse their stress profile. | This section contains properties that a user may use to analyse their stress profile. | ||
*'' | *Name (as ''string'') {{APIComment|{{Template:ALTAStressProfile.Name.Cmt}}}} | ||
*'' | *RepeatCycle (as ''string'') {{APIComment|{{Template:ALTAStressProfile.RepeatCycle.Cmt}}}} | ||
== | == Usage Example == | ||
{{APIComment|Declare the ALTADataSet. See [[New ALTADataSet]] for additional details.}} | {{APIComment|Declare the ALTADataSet. See [[New ALTADataSet]] for additional details.}} | ||
Revision as of 16:34, 11 March 2014
Constructors
- ALTAStressProfile Creates a new ALTAStressProfile object.
Methods
This section contains the methods that a user might use to manipulate their stress profile.
- AddSegment( Double, Double ) Adds a new segment to the stress profile.
- GetSegments Returns an array of ALTASegment objects that define each segment in the profile.
Properties
This section contains properties that a user may use to analyse their stress profile.
- Name (as string) Gets the name of the stress profile.
- RepeatCycle (as string) If set to true, cycles through the segments. Otherwise continues from the last stress.
Usage Example
Declare the ALTADataSet. See New ALTADataSet for additional details.
Dim ALTADS as New ALTADataSet
Declare an ALTAStressProfile. See ALTAStressProfile for additional details.
Dim sp = New ALTAStressProfile("Profile1")
sp.RepeatCycle = True
sp.AddSegment(1, 250)
sp.AddSegment(2, 300)
sp.AddSegment(3, 400)
Add the stress profile. See AddStressProfile for additional details.
ALTADS.AddStressProfile(sp)