CModel.ScaleParameter A: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 9: Line 9:


== Usage Example ==
== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
{{APIComment|'Declare a new repository connection class. 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.}}
        Dim AModel as cModel
  Dim AModel as cModel
        AModel = MyRepository.GetModel(ListOfModels(0).ID)
  AModel = MyRepository.GetModel(ListOfModels(0).ID)
 
 
{{APIComment|Retrieve the scale parameter of the Model.}}
{{APIComment|'Retrieve the scale parameter of the Model.}}
        Dim ScaleParameter as Double
  Dim ScaleParameter as Double
        ScaleParameter = MyRepository.GetModel(ListOfModels(0).ID).ScaleParameter_A
  ScaleParameter = MyRepository.GetModel(ListOfModels(0).ID).ScaleParameter_A

Revision as of 17:06, 6 May 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. See Repository. 
 Dim 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