ALTADataSet.PlotUseStress - Revision history

Kate Racaza at 17:00, 24 June 2016

2016-06-24T17:00:50Z

← Older revision		Revision as of 17:00, 24 June 2016
Line 44:		Line 44:
	ADS.PlotUseStress(0) = 200		ADS.PlotUseStress(0) = 200
	PictureBox1.Image = APlot.CreatePlot(WAPlotType.UseLevelProbability)		PictureBox1.Image = APlot.CreatePlot(WAPlotType.UseLevelProbability)
	~~PictureBox1.SizeMode = PictureBoxSizeMode.AutoSize~~

Kate Racaza at 16:51, 24 June 2016

2016-06-24T16:51:51Z

← Older revision		Revision as of 16:51, 24 June 2016
Line 1:		Line 1:
	~~#REDIRECT~~ [[ALTADataSet_Class]]		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet_Class\|ALTADataSet]]}}


			<onlyinclude>Sets the use stress value to be plotted (does not affect results of calculations). '''Double'''. The Index parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.</onlyinclude>

			== Example ==
			The following example demonstrates how to create a use level probability plot for an ALTA single-stress analysis.

			'''VBA'''

			{{APIComment\|'Declare a new ALTADataSet object.}}
			{{APIPrefix\|Dim}} ADS {{APIPrefix\|As New}} ALTADataSet

			{{APIComment\|'Add code to create an ALTA data set and analyze it.}}
			{{APIComment\|...}}

			{{APIComment\|'Declare a new WAPlots object.}}
			{{APIPrefix\|Dim}} APlot {{APIPrefix\|As New}} WAPlots

			{{APIComment\|'Add the analyzed data set to the plot.}}
			{{APIPrefix\|Call}} APlot.AddDataset(ADS)

			{{APIComment\|'Create a use level probability plot for use stress = 200.}}
			{{APIComment\|'This example assumes that an image control called "Image1" already exists in the active Excel sheet.}}
			ADS.PlotUseStress(0) = 200
			{{APIPrefix\|Set}} Image1.Picture = APlot.CreatePlotVB6(WAPlotType_UseLevelProbability)

			'''VB.NET'''

			{{APIComment\|'Declare a new ALTADataSet object.}}
			{{APIPrefix\|Dim}} ADS {{APIPrefix\|As New}} ALTADataSet

			{{APIComment\|'Add code to create an ALTA data set and analyze it.}}
			{{APIComment\|...}}

			{{APIComment\|'Declare a new WAPlots object.}}
			{{APIPrefix\|Dim}} APlot {{APIPrefix\|As New}} WAPlots

			{{APIComment\|'Add the analyzed data set to the plot.}}
			APlot.AddDataset(ADS)

			{{APIComment\|'Create a use level probability plot for use stress = 200.}}
			{{APIComment\|'This example assumes that a PictureBox control called "PictureBox1" already exists in the Windows Form project.}}
			ADS.PlotUseStress(0) = 200
			PictureBox1.Image = APlot.CreatePlot(WAPlotType.UseLevelProbability)
			PictureBox1.SizeMode = PictureBoxSizeMode.AutoSize

Kate Racaza: Redirected page to ALTADataSet Class

2016-05-04T19:06:41Z

Redirected page to ALTADataSet Class

← Older revision		Revision as of 19:06, 4 May 2016
Line 1:		Line 1:
	~~{{Template:APIClass\|ALTADataSet Class\|ALTADataSet}}~~		#REDIRECT [[ALTADataSet_Class]]
	~~{{Template:ALTADataSet.PlotUseStress.Cmt}}~~

	~~To set the use stress level for calculations, use the~~ [[~~CModel.SetUseStress\|SetUseStress~~]] ~~method on [[ALTADataSet Class\|ALTADataSet]].FittedModel.~~

	~~== Syntax==~~
	~~<ul><li>~~
	~~PlotUseStress(~~
	~~Index~~
	~~{{APIPrefix\|As Integer}}~~
	)
	~~</li></ul>~~

	~~Parameters~~
	~~:''Index'': The index of the stress column (e.g., 0 = the first stress, 1 = the second, etc.).~~

	~~Value~~
	~~:Type: ''double''~~

	~~== Usage Example ==~~
	~~This example demonstrates how to add a stress and set its stress transformation.~~
	~~{{APIComment\|'Declare the ALTADataSet. See [[ALTADataSet Class\|ALTADataSet]].}}~~
	~~Dim ALTADS as New ALTADataSet~~

	~~{{APIComment\|'Add a new stress.}}~~
	~~ALTADS.AddStressDefinition("Stress1")~~

	~~{{APIComment\|'Set the use stress level (to be used in plots) for the first stress.}}~~
	~~ALTADS.PlotUseStress(0) = 200~~

Chris Kahn: /* Usage Example */

2014-05-06T16:44:13Z

Usage Example

← Older revision		Revision as of 16:44, 6 May 2014
Line 20:		Line 20:
	== Usage Example ==		== Usage Example ==
	This example demonstrates how to add a stress and set its stress transformation.		This example demonstrates how to add a stress and set its stress transformation.
	{{APIComment\|'Declare the ALTADataSet. See [[ALTADataSet ~~Constructors~~]].}}		{{APIComment\|'Declare the ALTADataSet. See [[ALTADataSet Class\|ALTADataSet]].}}
	Dim ALTADS as New ALTADataSet		Dim ALTADS as New ALTADataSet

Chris Kahn at 19:52, 26 March 2014

2014-03-26T19:52:32Z

← Older revision		Revision as of 19:52, 26 March 2014
Line 2:		Line 2:
	{{Template:ALTADataSet.PlotUseStress.Cmt}}		{{Template:ALTADataSet.PlotUseStress.Cmt}}

	To set the use stress level for calculations, use the [[CModel.SetUseStress\|SetUseStress]] method on ~~the~~ ALTADataSet.FittedModel ~~property~~.		To set the use stress level for calculations, use the [[CModel.SetUseStress\|SetUseStress]] method on [[ALTADataSet Class\|ALTADataSet]].FittedModel.

	== Syntax==		== Syntax==

Chris Kahn at 23:38, 19 March 2014

2014-03-19T23:38:30Z

← Older revision		Revision as of 23:38, 19 March 2014
Line 2:		Line 2:
	{{Template:ALTADataSet.PlotUseStress.Cmt}}		{{Template:ALTADataSet.PlotUseStress.Cmt}}

	To set the use stress level for calculations, use the [[~~FittedModel~~.SetUseStress]] method.		To set the use stress level for calculations, use the [[CModel.SetUseStress\|SetUseStress]] method on the ALTADataSet.FittedModel property.

	== Syntax==		== Syntax==

Chris Kahn at 23:36, 19 March 2014

2014-03-19T23:36:41Z

← Older revision		Revision as of 23:36, 19 March 2014
Line 2:		Line 2:
	{{Template:ALTADataSet.PlotUseStress.Cmt}}		{{Template:ALTADataSet.PlotUseStress.Cmt}}

	To set the use stress level for calculations, use the FittedModel.SetUseStress method.		To set the use stress level for calculations, use the [[FittedModel.SetUseStress]] method.

	== Syntax==		== Syntax==

Chris Kahn: /* Usage Example */

2014-03-19T23:36:22Z

Usage Example

← Older revision		Revision as of 23:36, 19 March 2014
Line 19:		Line 19:

	== Usage Example ==		== Usage Example ==
	{{APIComment\|Declare the ALTADataSet. See [[~~New~~ ALTADataSet]] ~~for additional details~~.}}		This example demonstrates how to add a stress and set its stress transformation.
	Dim ALTADS as New ALTADataSet		{{APIComment\|'Declare the ALTADataSet. See [[ALTADataSet Constructors]].}}
			Dim ALTADS as New ALTADataSet
	{{APIComment\|~~Declare an [[ALTAStressProfile Class\|ALTAStressProfile]]. See [[ALTAStressProfile Class\|ALTAStressProfile]] for additional details.}}~~
	~~Dim sp = New ALTAStressProfile("Profile1")~~		{{APIComment\|'Add a new stress.}}
	~~sp.RepeatCycle = True~~		ALTADS.AddStressDefinition("Stress1")
	~~sp.AddSegment(1, 250)~~
	~~sp.AddSegment(2, 300)~~		{{APIComment\|'Set the use stress level (to be used in plots) for the first stress.}}
	~~sp.AddSegment(3, 400)~~		ALTADS.PlotUseStress(0) = 200

	~~{{APIComment\|~~Add ~~the~~ stress ~~profile. See [[ALTADataSet~~.~~AddStressProfile]] for additional details~~}}
	ALTADS.~~AddStressProfile~~(sp)

	{{APIComment\|Set the ~~Use Stress~~ level for the stress ~~profile~~.}}
	ALTADS.PlotUseStress(0) = 200

Chris Kahn at 22:39, 26 February 2014

2014-02-26T22:39:13Z

← Older revision		Revision as of 22:39, 26 February 2014
Line 15:		Line 15:
	:''Index'': The index of the stress column (e.g., 0 = the first stress, 1 = the second, etc.).		:''Index'': The index of the stress column (e.g., 0 = the first stress, 1 = the second, etc.).

	~~Return~~ Value		Value
	:Type: ''double''		:Type: ''double''

Chris Kahn at 22:37, 26 February 2014

2014-02-26T22:37:03Z

← Older revision		Revision as of 22:37, 26 February 2014
Line 10:		Line 10:
	{{APIPrefix\|As Integer}}		{{APIPrefix\|As Integer}}
	)		)
	~~{{APIPrefix\|As Double}}~~
	</li></ul>		</li></ul>

	Parameters		Parameters
	:''Index'': The index of the stress column (e.g., 0 = the first stress, 1 = the second, etc.).		:''Index'': The index of the stress column (e.g., 0 = the first stress, 1 = the second, etc.).

			Return Value
			:Type: ''double''

	== Usage Example ==		== Usage Example ==

← Older revision		Revision as of 16:51, 24 June 2016
Line 1:		Line 1:
	~~#REDIRECT~~ [[ALTADataSet_Class]]		{{Template:API}}{{Template:APIBreadcrumb\|.[[ALTADataSet_Class\|ALTADataSet]]}}


			<onlyinclude>Sets the use stress value to be plotted (does not affect results of calculations). '''Double'''. The Index parameter is an integer that specifies the stress index, where 0 = first stress, 1 = second stress, etc.</onlyinclude>

			== Example ==
			The following example demonstrates how to create a use level probability plot for an ALTA single-stress analysis.

			'''VBA'''

			{{APIComment\|'Declare a new ALTADataSet object.}}
			{{APIPrefix\|Dim}} ADS {{APIPrefix\|As New}} ALTADataSet

			{{APIComment\|'Add code to create an ALTA data set and analyze it.}}
			{{APIComment\|...}}

			{{APIComment\|'Declare a new WAPlots object.}}
			{{APIPrefix\|Dim}} APlot {{APIPrefix\|As New}} WAPlots

			{{APIComment\|'Add the analyzed data set to the plot.}}
			{{APIPrefix\|Call}} APlot.AddDataset(ADS)

			{{APIComment\|'Create a use level probability plot for use stress = 200.}}
			{{APIComment\|'This example assumes that an image control called "Image1" already exists in the active Excel sheet.}}
			ADS.PlotUseStress(0) = 200
			{{APIPrefix\|Set}} Image1.Picture = APlot.CreatePlotVB6(WAPlotType_UseLevelProbability)

			'''VB.NET'''

			{{APIComment\|'Declare a new ALTADataSet object.}}
			{{APIPrefix\|Dim}} ADS {{APIPrefix\|As New}} ALTADataSet

			{{APIComment\|'Add code to create an ALTA data set and analyze it.}}
			{{APIComment\|...}}

			{{APIComment\|'Declare a new WAPlots object.}}
			{{APIPrefix\|Dim}} APlot {{APIPrefix\|As New}} WAPlots

			{{APIComment\|'Add the analyzed data set to the plot.}}
			APlot.AddDataset(ADS)

			{{APIComment\|'Create a use level probability plot for use stress = 200.}}
			{{APIComment\|'This example assumes that a PictureBox control called "PictureBox1" already exists in the Windows Form project.}}
			ADS.PlotUseStress(0) = 200
			PictureBox1.Image = APlot.CreatePlot(WAPlotType.UseLevelProbability)
			PictureBox1.SizeMode = PictureBoxSizeMode.AutoSize