Repository.Model.AddModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(24 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.AddModel.Cmt}} {{Template:BooleanReturn.Cmt}}


== Syntax==
*AddModel( m {{APIPrefix|As}}[[cModel Class|cModel]] ){{APIPrefix|As Boolean}}


Parameters
<onlyinclude>Adds a new model resource to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>
:''m'': The [[cModel Class|cModel]] to add.


== Usage Example ==
 
  {{APIComment|'Declare a new repository connection class.}}
'''Remarks''': If a model with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Model1" already exists, the new model might be renamed to "Model2," "Model3," etc.
  Dim MyRepository As New Repository
 
== Syntax ==
'''.Model.AddModel'''(''m'')
 
=== Parameters ===
''m''
:Required. The [[CModel Class|cModel]] object that represents the model resource to be added.
 
 
== Example ==
This example creates a new model resource, and then saves it in the first available project in a Synthesis repository.
'''VBA'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Create a new model. The following example creates a 2-parameter Weibull reliability model,}}
  Dim Success As Boolean = False
{{APIComment|'with beta &#61; 1 and eta &#61; 100. The model name is "MyNewModel."}}
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  {{APIPrefix|Dim}} ModelType {{APIPrefix|As}} ModelTypeEnum
  {{APIPrefix|Dim}} ModelCategory {{APIPrefix|As}} ModelCategoryEnum
  {{APIPrefix|Dim}} ModelName {{APIPrefix|As String}}
  {{APIPrefix|Dim}} ModelParams(2) {{APIPrefix|As Double}}
    
    
  {{APIComment|'Declare a new model using an in-line parameter list. See [[cModel Class|cModel]].}}
  ModelType = ModelTypeEnum_Weibull2
  Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "NewModel1", 1, 100)
  ModelCategory = ModelCategoryEnum_Reliability
  ModelName = {{APIString|"MyNewModel"}}
  ModelParams(0) = 1
  ModelParams(1) = 100
  {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel
  {{APIPrefix|Call}} newModel.SetModel(ModelType, ModelCategory, ModelName, ModelParams)
  {{APIComment|'Add the new model to project #1.}}
  MyRepository.Project.SetCurrentProject(1) 
  {{APIPrefix|Call}} MyRepository.Model.AddModel(newModel)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Add model to the current project.}}
{{APIComment|'Create a new model. The following example creates a 2-parameter Weibull reliability model,}}
   Dim SuccessAddModel As Boolean = False
{{APIComment|'with beta &#61; 1 and eta &#61; 100. The model name is "MyNewModel."}}
  SuccessAddModel = MyRepository.AddModel(newModel)
  {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, 1, 100)
  {{APIComment|'Add the new model to project #1.}}
  MyRepository.Project.SetCurrentProject(1)    
  MyRepository.Model.AddModel(newModel)

Latest revision as of 20:35, 18 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new model resource to the current project. Returns a Boolean value; when true, indicates a successful save.


Remarks: If a model with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Model1" already exists, the new model might be renamed to "Model2," "Model3," etc.

Syntax

.Model.AddModel(m)

Parameters

m

Required. The cModel object that represents the model resource to be added.


Example

This example creates a new model resource, and then saves it in the first available project in a Synthesis repository. 

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new model. The following example creates a 2-parameter Weibull reliability model, 
 'with beta = 1 and eta = 100. The model name is "MyNewModel." 
  Dim ModelType As ModelTypeEnum
  Dim ModelCategory As ModelCategoryEnum
  Dim ModelName As String
  Dim ModelParams(2) As Double
 
  ModelType = ModelTypeEnum_Weibull2
  ModelCategory = ModelCategoryEnum_Reliability
  ModelName = "MyNewModel"
  ModelParams(0) = 1
  ModelParams(1) = 100

  Dim newModel As New cModel
  Call newModel.SetModel(ModelType, ModelCategory, ModelName, ModelParams)

 'Add the new model to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  Call MyRepository.Model.AddModel(newModel)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new model. The following example creates a 2-parameter Weibull reliability model, 
 'with beta = 1 and eta = 100. The model name is "MyNewModel." 
  Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "MyNewModel", 1, 100)

 'Add the new model to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Model.AddModel(newModel)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Model.AddModel&oldid=64611"