ALTASegment Class - Revision history

Kate Racaza at 15:32, 23 March 2017

2017-03-23T15:32:17Z

← Older revision		Revision as of 15:32, 23 March 2017
Line 1:		Line 1:
	{{Template:API}}{{Template:DeprecatedAPI}}{{Template:APIBreadcrumb}}		{{Template:API}}{{Template:DeprecatedAPI\|class}}{{Template:APIBreadcrumb}}

Kate Racaza at 15:17, 23 March 2017

2017-03-23T15:17:39Z

← Older revision		Revision as of 15:17, 23 March 2017
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb}}		{{Template:API}}{{Template:DeprecatedAPI}}{{Template:APIBreadcrumb}}

Kate Racaza at 17:43, 24 June 2016

2016-06-24T17:43:57Z

← Older revision		Revision as of 17:43, 24 June 2016
Line 2:		Line 2:


	Represents the time ~~segment~~ of an associated [[ALTAStressProfile Class\|ALTAStressProfile]] object.		Represents the time segments of an associated [[ALTAStressProfile Class\|ALTAStressProfile]] object.

	== Properties ==		== Properties ==

Kate Racaza at 17:42, 24 June 2016

2016-06-24T17:42:45Z

← Older revision		Revision as of 17:42, 24 June 2016
Line 13:		Line 13:
	\|Stress\|\|The stress level throughout the segment. '''Double'''.		\|Stress\|\|The stress level throughout the segment. '''Double'''.
	\|}		\|}


	== Example==		== Example==

Kate Racaza at 22:03, 19 April 2016

2016-04-19T22:03:46Z

← Older revision		Revision as of 22:03, 19 April 2016
Line 1:		Line 1:
	{{Template:~~APIClass\|ALTAStressProfile Class\|ALTAStressProfile~~}}		{{Template:API}}{{Template:APIBreadcrumb}}
	~~Used with~~ the [[ALTAStressProfile~~.GetSegments~~]] ~~method to return each segment of a stress profile~~.

			Represents the time segment 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'''.
			\|}

	*SegmentStart (as ''~~double~~'') {{APIComment\|~~The segment~~'~~s start time~~.}}		== Example==
	*SegmentEnd (~~as ''double''~~) {{APIComment\|~~The segment~~'~~s end time~~.}}
	*Stress (~~as ''double''~~) {{APIComment\|~~The stress level throughout~~ the segment.}}		'''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

	~~== Usage Example==~~		'''VB.NET'''
	{{APIComment\|'Declare an ALTAStressProfile object~~. See [[ALTAStressProfile Class\|ALTAStressProfile]]~~.}}
	Dim SP As New ALTAStressProfile~~("Profile1")~~		{{APIComment\|'Declare an ALTAStressProfile object.}}
			{{APIPrefix\|Dim}} SP {{APIPrefix\|As New}} ALTAStressProfile

	{{APIComment\|'Add segments.}}		{{APIComment\|'Add segments.}}
	SP.AddSegment(1, 250)		SP.AddSegment(1, 250)
	SP.AddSegment(2, 300)		SP.AddSegment(2, 300)
	SP.AddSegment(3, 400)		SP.AddSegment(3, 400)

	{{APIComment\|'Get segments.}}		{{APIComment\|'Get segments.}}
	Dim StressSegments() As ALTASegment		{{APIPrefix\|Dim}} StressSegments() {{APIPrefix\|As}} ALTASegment
	StressSegments = SP.GetSegments		StressSegments = SP.GetSegments

	{{APIComment\|'Get the start time of the first segment.}}		{{APIComment\|'Get the start time of the first segment.}}
	Dim SegStart As Double		{{APIPrefix\|Dim}} SegStart {{APIPrefix\|As}} Double
	SegStart = StressSegments(0).SegmentStart		SegStart = StressSegments(0).SegmentStart

Chris Kahn at 23:03, 11 April 2014

2014-04-11T23:03:47Z

← Older revision		Revision as of 23:03, 11 April 2014
Line 1:		Line 1:
	{{Template:APIClass\|ALTAStressProfile Class\|ALTAStressProfile}}		{{Template:APIClass\|ALTAStressProfile Class\|ALTAStressProfile}}
	Used with the [[ALTAStressProfile.GetSegments]] method to ~~define~~ each segment of a stress profile.		Used with the [[ALTAStressProfile.GetSegments]] method to return each segment of a stress profile.

	== Properties ==		== Properties ==

Chris Kahn: /* Usage Example */

2014-04-11T23:03:13Z

Usage Example

← Older revision		Revision as of 23:03, 11 April 2014
Line 18:		Line 18:

	{{APIComment\|'Get segments.}}		{{APIComment\|'Get segments.}}
	Dim StressSegments() As [[ALTASegment ~~Class\|ALTASegment]]~~		Dim StressSegments() As ALTASegment
	StressSegments = SP.GetSegments		StressSegments = SP.GetSegments

Chris Kahn at 23:03, 11 April 2014

2014-04-11T23:03:00Z

← Older revision		Revision as of 23:03, 11 April 2014
Line 7:		Line 7:
	*SegmentEnd (as ''double'') {{APIComment\|The segment's end time.}}		*SegmentEnd (as ''double'') {{APIComment\|The segment's end time.}}
	*Stress (as ''double'') {{APIComment\|The stress level throughout the segment.}}		*Stress (as ''double'') {{APIComment\|The stress level throughout the segment.}}

			== Usage Example==
			{{APIComment\|'Declare an ALTAStressProfile object. See [[ALTAStressProfile Class\|ALTAStressProfile]].}}
			Dim SP As New ALTAStressProfile("Profile1")

			{{APIComment\|'Add segments.}}
			SP.AddSegment(1, 250)
			SP.AddSegment(2, 300)
			SP.AddSegment(3, 400)

			{{APIComment\|'Get segments.}}
			Dim StressSegments() As [[ALTASegment Class\|ALTASegment]]
			StressSegments = SP.GetSegments

			{{APIComment\|'Get the start time of the first segment.}}
			Dim SegStart As Double
			SegStart = StressSegments(0).SegmentStart

Chris Kahn at 18:01, 11 March 2014

2014-03-11T18:01:42Z

← Older revision		Revision as of 18:01, 11 March 2014
Line 4:		Line 4:
	== Properties ==		== Properties ==

	*SegmentStart (as ''~~TYPE~~'') {{APIComment\|The segment's start time.}}		*SegmentStart (as ''double'') {{APIComment\|The segment's start time.}}
	*SegmentEnd (as ''~~TYPE~~'') {{APIComment\|The segment's end time.}}		*SegmentEnd (as ''double'') {{APIComment\|The segment's end time.}}
	*Stress (as ''~~TYPE~~'') {{APIComment\|The stress level throughout the segment.}}		*Stress (as ''double'') {{APIComment\|The stress level throughout the segment.}}

Chris Kahn at 18:01, 11 March 2014

2014-03-11T18:01:27Z

← Older revision		Revision as of 18:01, 11 March 2014
Line 1:		Line 1:
	{{Template:APIClass\|~~Global_ALTA~~\|~~Global_ALTA~~}}		{{Template:APIClass\|ALTAStressProfile Class\|ALTAStressProfile}}
	Used with the [[ALTAStressProfile.GetSegments]] method to define each segment of a stress profile.		Used with the [[ALTAStressProfile.GetSegments]] method to define each segment of a stress profile.