Difference between revisions of "CModel.ScaleParameter A"

From ReliaWiki
Jump to navigation Jump to search
Line 1: Line 1:
{{DISPLAYTITLE:cModel.ScaleParameter_A}}
+
{{DISPLAYTITLE:cModel.ScaleParameterA}}{{Template:API}}{{Template:APIBreadcrumb|9|.[[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>Returns the value of the scale parameter at the use stress level for ALTA models. Type: '''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'''
<div style="margin-right: 150px;">
+
  {{APIComment|'Declare a new repository connection object. See [[Repository Class|Repository]].}}
+
  {{APIComment|...}}
  Dim MyRepository As New Repository
+
 
+
  {{APIComment|'Add code to get an existing ALTA model from the repository.}}
  {{APIComment|'Connect to the Synthesis repository.}}
+
   {{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel
   Dim Success As Boolean = False
+
  {{APIComment|...}}
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+
 
+
  {{APIComment|'Retrieve the scale parameter of the model.}}
{{APIComment|'Get the list of projects in the connected repository.}}
+
   {{APIPrefix|Dim}} ScaleParameter {{APIPrefix|As Double}}
  Dim ListOfModels() As [[NameIdPair Class|NameIdPair]]
+
   ScaleParameter = AModel.ScaleParameter_A
  ListOfModels = MyRepository.GetAllModelsInfo()
 
 
 
  {{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
 
</div>
 

Revision as of 20:29, 28 July 2015

APIWiki.png


Member of: SynthesisAPI9.cModel


Returns the value of the scale parameter at the use stress level for ALTA models. Type: 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