CModel.SetUseStress - Revision history

Kate Racaza at 21:17, 13 November 2015

2015-11-13T21:17:55Z

← Older revision		Revision as of 21:17, 13 November 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:cModel.SetUseStress}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[CModel Class\|cModel]]}}		{{DISPLAYTITLE:cModel.SetUseStress}}{{Template:API}}{{Template:APIBreadcrumb\|.[[CModel Class\|cModel]]}}

Kate Racaza at 18:53, 5 November 2015

2015-11-05T18:53:48Z

← Older revision		Revision as of 18:53, 5 November 2015
Line 1:		Line 1:
	~~{{InProgress}}~~{{DISPLAYTITLE:cModel.SetUseStress}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[CModel Class\|cModel]]}}		{{DISPLAYTITLE:cModel.SetUseStress}}{{Template:API}}{{Template:APIBreadcrumb\|9\|.[[CModel Class\|cModel]]}}

Kate Racaza at 18:53, 5 November 2015

2015-11-05T18:53:01Z

← Older revision		Revision as of 18:53, 5 November 2015
Line 28:		Line 28:

	== Example ==		== Example ==
	This example assumes that a model with ID #47 exists in project ID#1 of a repository.		This example assumes that an ALTA model with ID #47 exists in project ID #1 of a repository.

	'''VBA'''		'''VBA'''
Line 54:		Line 54:
	UseStressArray(1) = 750		UseStressArray(1) = 750

	{{APIComment\|'Set the use stress values for the model.}}		{{APIComment\|'Set the use stress values for the model. This is intended for calculations}}
			{{APIComment\|'only; it does not save the changes to the model in the repository.}}
	{{APIPrefix\|Call}} AModel.SetUseStress_2(UseStressArray)		{{APIPrefix\|Call}} AModel.SetUseStress_2(UseStressArray)

Line 87:		Line 88:
	UseStressArray(1) = 750		UseStressArray(1) = 750

	{{APIComment\|'Set the use stress values for the model.}}		{{APIComment\|'Set the use stress values for the model. This is intended for calculations}}
			{{APIComment\|'only; it does not save the changes to the model in the repository.}}
	AModel.SetUseStress(UseStressArray)		AModel.SetUseStress(UseStressArray)

Kate Racaza at 23:30, 21 October 2015

2015-10-21T23:30:14Z

← Older revision		Revision as of 23:30, 21 October 2015
Line 5:		Line 5:

	== Syntax ==		== Syntax ==

			'''VBA'''

			'''.SetUseStress'''(''Index'', ''StressValue'')
			'''.SetUseStress_2'''(''StressValues()'')

			'''VB.NET'''

	'''.SetUseStress'''(''Index'', ''StressValue'')		'''.SetUseStress'''(''Index'', ''StressValue'')
	'''.SetUseStress'''(''StressValues()'')		'''.SetUseStress'''(''StressValues()'')

	===Parameters===		===Parameters===
	''Index''		''Index''
Line 21:		Line 28:

	== Example ==		== Example ==
	This example assumes that a model with ID #47 exists in ~~the first available~~ project of a repository.		This example assumes that a model with ID #47 exists in project ID#1 of a repository.

			'''VBA'''

			{{APIComment\|'Add code to connect to a Synthesis repository.}}
			{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}


			{{APIComment\|'Get ALTA model #47 from project #1.}}
			{{APIPrefix\|Dim}} AModel {{APIPrefix\|As}} cModel
			MyRepository.Project.SetCurrentProject(1)
			{{APIPrefix\|Set}} AModel = MyRepository.Model.GetModel(47)

			{{APIComment\|'Get the number of stresses in the model.}}
			{{APIPrefix\|Dim}} MyNumStresses {{APIPrefix\|As Integer}}
			MyNumStresses = AModel.NumStresses

			{{APIComment\|'Assume that the number of stresses in this example is 2.}}
			{{APIComment\|'Set the use stress values for each of the stresses.}}
			{{APIPrefix\|Dim}} UseStressArray() {{APIPrefix\|As Double}}
			{{APIPrefix\|ReDim}} UseStressArray(MyNumStresses)

			UseStressArray(0) = 500
			UseStressArray(1) = 750

			{{APIComment\|'Set the use stress values for the model.}}
			{{APIPrefix\|Call}} AModel.SetUseStress_2(UseStressArray)

			{{APIComment\|'Calculations using the specified stress values are now possible. For example,}}
			{{APIComment\|'the following code returns the model's reliability at 100 hrs}}
			{{APIComment\|'at the specified use stress levels.}}
			{{APIPrefix\|Dim}} ResultValue {{APIPrefix\|As Double}}
			ResultValue = AModel.Reliability(100)
			MsgBox(ResultValue)

	'''VB.NET'''		'''VB.NET'''
Line 31:		Line 72:

	{{APIComment\|'Get ALTA model #47 from project #1.}}		{{APIComment\|'Get ALTA model #47 from project #1.}}
	{{APIPrefix\|Dim}} AModel {{APIPrefix\|As}} cModel		{{APIPrefix\|Dim}} AModel {{APIPrefix\|As}} cModel
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	AModel = MyRepository.Model.GetModel(47)		AModel = MyRepository.Model.GetModel(47)

	{{APIComment\|'Get the number of stresses in the model.}}		{{APIComment\|'Get the number of stresses in the model.}}
	{{APIPrefix\|Dim}} MyNumStresses {{APIPrefix\|As Integer}}		{{APIPrefix\|Dim}} MyNumStresses {{APIPrefix\|As Integer}}
	MyNumStresses = AModel.NumStresses		MyNumStresses = AModel.NumStresses

	{{APIComment\|'Assume that the number of stresses in this example is 2.}}		{{APIComment\|'Assume that the number of stresses in this example is 2.}}
	{{APIComment\|'Set the use stress values for each of the stresses.}}		{{APIComment\|'Set the use stress values for each of the stresses.}}
	{{APIPrefix\|Dim}} UseStressArray(MyNumStresses-1) {{APIPrefix\|As Double}}		{{APIPrefix\|Dim}} UseStressArray(MyNumStresses-1) {{APIPrefix\|As Double}}
	UseStressArray(0) = 500
	UseStressArray(1) = 750		UseStressArray(0) = 500
			UseStressArray(1) = 750

	{{APIComment\|'Set the use stress values for the model.}}		{{APIComment\|'Set the use stress values for the model.}}
	AModel.SetUseStress(UseStressArray)		AModel.SetUseStress(UseStressArray)

	{{APIComment\|'Calculations using the specified stress values are now possible. For example,}}		{{APIComment\|'Calculations using the specified stress values are now possible. For example,}}
	{{APIComment\|'the following code returns the model's reliability at 100 hrs}}		{{APIComment\|'the following code returns the model's reliability at 100 hrs}}
	{{APIComment\|'at the specified use stress levels.}}		{{APIComment\|'at the specified use stress levels.}}
	{{APIPrefix\|Dim}} ResultValue {{APIPrefix\|As Double}}		{{APIPrefix\|Dim}} ResultValue {{APIPrefix\|As Double}}
	ResultValue = AModel.Reliability(100)		ResultValue = AModel.Reliability(100)
			MsgBox(ResultValue)

Kate Racaza at 23:47, 2 October 2015

2015-10-02T23:47:41Z

← Older revision		Revision as of 23:47, 2 October 2015
Line 2:		Line 2:


	<onlyinclude>For ALTA models only. ~~Sets~~ the use stress level for ~~one or multiple stresses for subsequent~~ calculations.</onlyinclude>		<onlyinclude>For ALTA models only. Specifies the use stress level(s) to use for calculations.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 11:		Line 11:
	===Parameters===		===Parameters===
	''Index''		''Index''
	:Required. Integer. The 0-based index of the stress ~~for which~~ the ~~use~~ stress ~~level will be updated~~.		:Required. Integer. The 0-based index of the stress (e.g., the first stress in the model has an index = 0, the second stress has an index = 1, etc.).

	''StressValue''		''StressValue''
Line 17:		Line 17:

	''StressValues()''		''StressValues()''
	:Required. Double. An array of ~~new~~ use stress values ~~that~~ correspond to the ~~array~~ of stresses in the model (e.g., the first ~~stress value will become~~ the use stress ~~level for~~ the first stress).		:Required. Double. An array of the use stress values. The order of the elements in the array correspond to the order of the stresses in the model (e.g., the first element of the array defines the use stress value of the first stress in the model, etc.)

Kate Racaza at 18:07, 2 October 2015

2015-10-02T18:07:16Z

← Older revision		Revision as of 18:07, 2 October 2015
Line 2:		Line 2:


	<onlyinclude>For ALTA models only. Sets the use stress level for one or multiple stresses ~~of a [[CModel Class\|cModel]] object~~.</onlyinclude>		<onlyinclude>For ALTA models only. Sets the use stress level for one or multiple stresses for subsequent calculations.</onlyinclude>

	~~This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.~~
	== Syntax ==		== Syntax ==
	~~'''VBA'''~~

	~~'''.SetUseStress'''(''Index'', ''StressValue'')~~
	~~'''.SetUseStress_2'''(''StressValues()'')~~

	~~'''VB.NET'''~~

	'''.SetUseStress'''(''Index'', ''StressValue'')		'''.SetUseStress'''(''Index'', ''StressValue'')
Line 28:		Line 21:

	== Example ==		== Example ==
	~~{{APIComment\|'Declare~~ a ~~new~~ repository ~~connection object~~. ~~See [[Repository Class\|Repository]]~~.}}		This example assumes that a model with ID #47 exists in the first available project of a repository.
	~~Dim MyRepository As New Repository~~
			'''VB.NET'''
	{{APIComment\|'~~Connect~~ to ~~the~~ Synthesis repository.}}
	Dim ~~Success As Boolean = False~~		{{APIComment\|'Add code to connect to a Synthesis repository.}}
	~~Success =~~ MyRepository~~.ConnectToRepository("RepositoryFileNamePath")~~		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}
	{{~~APIComment~~\|~~'Get the list of projects in the connected repository.~~}}
	~~Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]~~
	~~ListOfModels = MyRepository.GetAllModelsInfo()~~

	{{APIComment\|~~'Select the ID of the model and retrieve it~~. ~~In this example, the first model is used~~.}}
	~~Dim AModel as cModel~~
	~~AModel = MyRepository.GetModel(ListOfModels(0).ID)~~

			{{APIComment\|'Get ALTA model #47 from project #1.}}
			{{APIPrefix\|Dim}} AModel {{APIPrefix\|As}} cModel
			MyRepository.Project.SetCurrentProject(1)
			AModel = MyRepository.Model.GetModel(47)

	{{APIComment\|'Get the number of stresses in the model.}}		{{APIComment\|'Get the number of stresses in the model.}}
	Dim MyNumStresses As Integer		{{APIPrefix\|Dim}} MyNumStresses {{APIPrefix\|As Integer}}
	MyNumStresses = AModel.NumStresses		MyNumStresses = AModel.NumStresses

	{{APIComment\|'~~Create an array and specify~~ the ~~use stress values for each~~ of ~~the~~ stresses.}}		{{APIComment\|'Assume that the number of stresses in this example is 2.}}
	{{APIComment\|'~~Assume~~ the ~~MyNumStresses in this example is 2~~.}}		{{APIComment\|'Set the use stress values for each of the stresses.}}
	Dim UseStressArray(MyNumStresses - 1) As Double		{{APIPrefix\|Dim}} UseStressArray(MyNumStresses-1) {{APIPrefix\|As Double}}
	UseStressArray(0) = 500		UseStressArray(0) = 500
	UseStressArray(1) = 750		UseStressArray(1) = 750

	{{APIComment\|'Set the ~~UseStress~~ for the model.}}		{{APIComment\|'Set the use stress values for the model.}}
	AModel.SetUseStress(UseStressArray)		AModel.SetUseStress(UseStressArray)

			{{APIComment\|'Calculations using the specified stress values are now possible. For example,}}
			{{APIComment\|'the following code returns the model's reliability at 100 hrs}}
			{{APIComment\|'at the specified use stress levels.}}
			{{APIPrefix\|Dim}} ResultValue {{APIPrefix\|As Double}}
			ResultValue = AModel.Reliability(100)

Kate Racaza at 00:00, 2 October 2015

2015-10-02T00:00:19Z

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:cModel.SetUseStress}}
+{{InProgress}}{{DISPLAYTITLE:cModel.SetUseStress}}{{Template:API}}{{Template:APIBreadcrumb|9|.[[CModel Class|cModel]]}}
 == Syntax ==
-*SetUseStress( Index {{APIPrefix|As Integer}}, StressValue{{APIPrefix|As Double}}) {{APIComment|{{Template:CModel.SetUseStress1}}}}
+ '''VBA'''
-*SetUseStress( StressValues() {{APIPrefix|As Double}}) {{APIComment|{{Template:CModel.SetUseStress2}}}}
-== Usage Example ==
+== Example ==
   {{APIComment|'Declare a new repository connection object. See [[Repository Class|Repository]].}}
    Dim MyRepository As New Repository

Chris Kahn: /* Usage Example */

2014-05-06T17:11:05Z

Usage Example

← Older revision		Revision as of 17:11, 6 May 2014
Line 13:		Line 13:

	== Usage Example ==		== Usage Example ==
	{{APIComment\|Declare a new repository connection ~~class~~.}}		{{APIComment\|'Declare a new repository connection object. See [[Repository Class\|Repository]].}}
	~~Private WithEvents~~ MyRepository As New Repository		Dim MyRepository As New Repository

	{{APIComment\|Connect to the Synthesis repository.}}		{{APIComment\|'Connect to the Synthesis repository.}}
	Dim Success As Boolean = False		Dim Success As Boolean = False
	Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")		Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

	{{APIComment\|Get the list of ~~Projects~~ in the connected repository.}}		{{APIComment\|'Get the list of projects in the connected repository.}}
	Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]		Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]
	ListOfModels = MyRepository.GetAllModelsInfo()		ListOfModels = MyRepository.GetAllModelsInfo()

	{{APIComment\|Select the ID of the model and retrieve it.}}		{{APIComment\|'Select the ID of the model and retrieve it. In this example, the first model is used.}}
	Dim AModel as cModel		Dim AModel as cModel
	AModel = MyRepository.GetModel(ListOfModels(0).ID)		AModel = MyRepository.GetModel(ListOfModels(0).ID)

	{{APIComment\|Get the number of stresses~~. In this example,~~ the ~~first~~ model ~~is used~~.}}		{{APIComment\|'Get the number of stresses in the model.}}
	Dim MyNumStresses As Integer		Dim MyNumStresses As Integer
	MyNumStresses = AModel.NumStresses		MyNumStresses = AModel.NumStresses

	{{APIComment\|Create an array and ~~fill Use Stress levels~~ for each of the stresses. Assume the MyNumStresses in this example is 2.}}		{{APIComment\|'Create an array and specify the use stress values for each of the stresses.}}
	Dim UseStressArray(MyNumStresses - 1) As Double		{{APIComment\|'Assume the MyNumStresses in this example is 2.}}
	UseStressArray(0) = 500		Dim UseStressArray(MyNumStresses - 1) As Double
	UseStressArray(1) = 750		UseStressArray(0) = 500
			UseStressArray(1) = 750
	{{APIComment\|Set the UseStress for the model.}}
	AModel.SetUseStress(UseStressArray)		{{APIComment\|'Set the UseStress for the model.}}
			AModel.SetUseStress(UseStressArray)

Chris Kahn: /* Syntax */

2014-03-06T17:57:13Z

Syntax

← Older revision		Revision as of 17:57, 6 March 2014
Line 4:		Line 4:

	== Syntax ==		== Syntax ==
	*SetUseStress( Index {{APIPrefix\|As Integer}}, StressValue{{APIPrefix\|As Double}}) {{APIComment\|~~Sets the use stress value for the stress with the specified index~~.}}		*SetUseStress( Index {{APIPrefix\|As Integer}}, StressValue{{APIPrefix\|As Double}}) {{APIComment\|{{Template:CModel.SetUseStress1}}}}
	*SetUseStress( StressValues() {{APIPrefix\|As Double}}) {{APIComment\|~~Sets the use stress values for all stresses~~.}}		*SetUseStress( StressValues() {{APIPrefix\|As Double}}) {{APIComment\|{{Template:CModel.SetUseStress2}}}}

	Parameters		Parameters

Chris Kahn: /* Syntax */

2014-03-06T17:56:21Z

Syntax

← Older revision		Revision as of 17:56, 6 March 2014
Line 4:		Line 4:

	== Syntax ==		== Syntax ==
	*SetUseStress( Index {{APIPrefix\|As Integer}}, StressValue{{APIPrefix\|As Double}}) {{APIComment\|Sets the use stress value for the specified ~~stress~~.}}		*SetUseStress( Index {{APIPrefix\|As Integer}}, StressValue{{APIPrefix\|As Double}}) {{APIComment\|Sets the use stress value for the stress with the specified index.}}
	*SetUseStress( StressValues() {{APIPrefix\|As Double}}) {{APIComment\|Sets the use stress values for ~~multiple~~ stresses.}}		*SetUseStress( StressValues() {{APIPrefix\|As Double}}) {{APIComment\|Sets the use stress values for all stresses.}}

	Parameters		Parameters