CModel.ScaleParameter A: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cModel.ScaleParameter_A}}
{{DISPLAYTITLE:cModel.ScaleParameter_A}}
{{Template:APIClass|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.<br>
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.
 
Scale parameter = ''eta'' for Weibull, ''lambda'' for exponential, ''log-mean'' for lognormal.
 
== Syntax==
== Syntax==
*ScaleParameter_A(){{APIPrefix|As Double}}
*ScaleParameter_A(){{APIPrefix|As Double}}

Revision as of 17:29, 6 March 2014


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.

Syntax

  • ScaleParameter_A()As Double

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of Projects in the connected repository.

       Dim ListOfModels() As NameIdPair
       ListOfModels = MyRepository.GetAllModelsInfo()

Select the ID of the model and retrieve it.

       Dim AModel as cModel
       AModel = MyRepository.GetModel(ListOfModels(0).ID)

Retrieve the scale parameter of the Model.

       Dim ScaleParameter as Double
       ScaleParameter = MyRepository.GetModel(ListOfModels(0).ID).ScaleParameter_A