Difference between revisions of "CModel.ScaleParameter A"

From ReliaWiki
Jump to navigation Jump to search
m
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:cModel.ScaleParameter_A}}
+
{{DISPLAYTITLE:cModel.ScaleParameter_A}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
{{Template:APIClass|CModel Class|cModel}}  
 
Returns the scale parameter for ALTA models. Returns 0 if the model is not an ALTA model.
 
  
Scale parameter = ''eta'' for Weibull, ''lambda'' for exponential, ''log-mean'' for lognormal.
+
 
 +
<onlyinclude>For ALTA models, returns the scale parameter at the use stress level. '''Double'''. Returns 0 if the model is not an ALTA model.</onlyinclude>
  
 
== Syntax==
 
== Syntax==
*ScaleParameter_A(){{APIPrefix|As Double}}
+
.'''ScaleParameter_A()'''
 +
 
 +
 
 +
== Example ==
 +
'''VBA'''
 +
 +
{{APIComment|...}}
 +
 +
{{APIComment|'Add code to get an existing ALTA model from the repository.}}
 +
  {{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel
 +
{{APIComment|...}}
 +
 +
{{APIComment|'Retrieve the scale parameter of the model.}}
 +
  {{APIPrefix|Dim}} ScaleParameter {{APIPrefix|As Double}}
 +
  {{APIPrefix|Set}} ScaleParameter = AModel.ScaleParameter_A
  
== Usage Example ==
+
'''VB.NET'''
  {{APIComment|'Declare a new repository connection class. See [[Repository Class|Repository]].}}
+
  Dim MyRepository As New Repository
+
  {{APIComment|...}}
 
+
  {{APIComment|'Connect to the Synthesis repository.}}
+
  {{APIComment|'Add code to get an existing ALTA model from the repository.}}
   Dim Success As Boolean = False
+
   {{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+
  {{APIComment|...}}
 
+
{{APIComment|'Get the list of projects in the connected repository.}}
+
  {{APIComment|'Retrieve the scale parameter of the model.}}
  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
+
   {{APIPrefix|Dim}} ScaleParameter {{APIPrefix|As Double}}
  ListOfModels = MyRepository.GetAllModelsInfo()
+
   ScaleParameter = AModel.ScaleParameter_A
 
 
  {{APIComment|'Select the ID of the model and retrieve it.}}
 
  Dim AModel as cModel
 
  AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
 
 
  {{APIComment|'Retrieve the scale parameter of the Model.}}
 
   Dim ScaleParameter as Double
 
   ScaleParameter = MyRepository.GetModel(ListOfModels(0).ID).ScaleParameter_A
 

Latest revision as of 21:18, 13 November 2015

APIWiki.png


Member of: SynthesisAPI.cModel


For ALTA models, returns the scale parameter at the use stress level. Double. Returns 0 if the model is not an ALTA model.

Syntax

.ScaleParameter_A()


Example

VBA

 ... 

 'Add code to get an existing ALTA model from the repository. 
 Dim AModel As New cModel
 ... 

 'Retrieve the scale parameter of the model. 
 Dim ScaleParameter As Double
 Set ScaleParameter = AModel.ScaleParameter_A
VB.NET

 ... 

 'Add code to get an existing ALTA model from the repository. 
 Dim AModel As New cModel
 ... 

 'Retrieve the scale parameter of the model. 
 Dim ScaleParameter As Double
 ScaleParameter = AModel.ScaleParameter_A