Difference between revisions of "CModel.ScaleParameter A"

From ReliaWiki
Jump to navigation Jump to search
m
 
(17 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|CModel Class|CModel}}
+
{{DISPLAYTITLE:cModel.ScaleParameter_A}}{{Template:API}}{{Template:APIBreadcrumb|.[[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, LogMean for Lognormal.
+
 
== Syntax==
 
{{APIName|ScaleParameter_A}}
 
{{APIName|()}}
 
{{APIPrefix|As Double}}<br>
 
{{APIComment|Returns an array containing model parameters and their values.}}
 
  
== Usage Example ==
+
<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>
{{APIComment|Declare a new repository connection class.}}
 
        Private WithEvents MyRepository As New Repository
 
  
{{APIComment|Connect to the Synthesis repository.}}
+
== Syntax==
        Dim Success As Boolean = False
+
.'''ScaleParameter_A()'''
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
  
{{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.}}
+
== Example ==
        Dim AModel as cModel
+
'''VBA'''
        AModel = MyRepository.GetModel(ListOfModels(0).ID)
+
 +
{{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
  
{{APIComment|Retrieve the scale parameter of the Model.}}
+
'''VB.NET'''
        Dim ScaleParameter as Double
+
        ScaleParameter = MyRepository.GetModel(ListOfModels(0).ID).ScaleParameter_A
+
{{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}}
 +
  ScaleParameter = AModel.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