ALTAStressProfile Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 5: Line 5:
This section contains information on how to create a new stress profile.
This section contains information on how to create a new stress profile.
*'''[[New ALTAStressProfile]]''' {{APIComment|Creates a new stress profile.}}
*'''[[New ALTAStressProfile]]''' {{APIComment|Creates a new stress profile.}}
== Methods==
This section contains the methods that a user might use to manipulate their stress profile.
*'''[[ALTAStressProfile.AddSegment|AddSegment]]''' {{APIComment|Adds a new segment to the stress profile.}}
*'''[[ALTAStressProfile.GetSegments|GetSegments]]''' {{APIComment|Retrieves an array listing of the stress segments.}}


== Properties ==
== Properties ==
 
This section contains properties that a user may use to analyse their stress profile.
*'''[[ALTAStressProfile.Name|Name]]''' {{APIComment|Returns the name of the stress profile.}}
*'''[[ALTAStressProfile.Name|Name]]''' {{APIComment|Returns the name of the stress profile.}}
*'''[[ALTAStressProfile.RepeatCycle|RepeatCycle]]''' {{APIComment|If set to true, cycles the segments. Otherwise continues from the last stress.}}
*'''[[ALTAStressProfile.RepeatCycle|RepeatCycle]]''' {{APIComment|If set to true, cycles the segments. Otherwise continues from the last stress.}}
== Methods==
*'''[[ALTAStressProfile.AddSegment|AddSegment]]''' {{APIComment|Adds a new segment to the stress profile.}}
*'''[[ALTAStressProfile.GetSegments|GetSegments]]''' {{APIComment|Retrieves an array listing of the stress segments.}}

Revision as of 18:41, 30 January 2014


Constructors

This section contains information on how to create a new 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 Retrieves an array listing of the stress segments.

Properties

This section contains properties that a user may use to analyse their stress profile.

  • Name Returns the name of the stress profile.
  • RepeatCycle If set to true, cycles the segments. Otherwise continues from the last stress.