ALTAStressProfile Class: Difference between revisions

Revision as of 17:27, 6 February 2014

Main Page
Global ALTA

Constructors

This section contains information on how to create a new stress profile.

New ALTAStressProfile Creates a new stress profile class that represents the data of the stress profile.

Methods

This section contains the methods that a user might use to manipulate their stress profile.

AddSegment 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 Gets the name of the stress profile.
RepeatCycle If set to true, cycles through the segments. Otherwise continues from the last stress.

Formatted 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.

       ALTADS.AddStressProfile(sp)

@@ Line 15: / Line 15: @@
 *'''[[ALTAStressProfile.Name|Name]]''' {{APIComment|{{Template:ALTAStressProfile.Name.Cmt}}}}
 *'''[[ALTAStressProfile.RepeatCycle|RepeatCycle]]''' {{APIComment|{{Template:ALTAStressProfile.RepeatCycle.Cmt}}}}
+== 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.}}
+        '''ALTADS.AddStressProfile(sp)'''