Repository.Model.AddModel: Difference between revisions

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




<onlyinclude>Saves a new [[CModel Class|cModel]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  
<onlyinclude>Adds a new model to a Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  


If a model with the same name already exists in the current project, the application will automatically increment the name. For example, if "Model1" already exists, the new model might be renamed to "Model2," "Model3," etc.
If a model with the same name already exists in the current project, the application will automatically increment the name. For example, if "Model1" already exists, the new model might be renamed to "Model2," "Model3," etc.
== Syntax ==
== Syntax ==
  '''.Model.AddModel'''(''m'')
  '''.Model.AddModel'''(''m'')
Line 10: Line 11:
=== Parameters ===
=== Parameters ===
''m''
''m''
:The [[CModel Class|cModel]] object to be added. (Required)
:Required. The [[CModel Class|cModel]] object to be added.




Line 23: Line 24:
   
   
  {{APIComment|'Create a new model. The following example creates a 2-parameter Weibull reliability model,}}
  {{APIComment|'Create a new model. The following example creates a 2-parameter Weibull reliability model,}}
  {{APIComment|'with beta 1 and eta 100. The model name is "MyNewModel."}}
  {{APIComment|'with beta &#61; 1 and eta &#61; 100. The model name is "MyNewModel."}}
   {{APIPrefix|Dim}} ModelType {{APIPrefix|As}} ModelTypeEnum
   {{APIPrefix|Dim}} ModelType {{APIPrefix|As}} ModelTypeEnum
   {{APIPrefix|Dim}} ModelCategory {{APIPrefix|As}} ModelCategoryEnum
   {{APIPrefix|Dim}} ModelCategory {{APIPrefix|As}} ModelCategoryEnum
Line 38: Line 39:
   {{APIPrefix|Call}} newModel.SetModel(ModelType, ModelCategory, ModelName, ModelParams)
   {{APIPrefix|Call}} newModel.SetModel(ModelType, ModelCategory, ModelName, ModelParams)
   
   
  {{APIComment|'Add the new model to project #1. The model will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new model to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   {{APIPrefix|Call}} MyRepository.Model.AddModel(newModel)
   {{APIPrefix|Call}} MyRepository.Model.AddModel(newModel)
Line 50: Line 51:
   
   
  {{APIComment|'Create a new model. The following example creates a 2-parameter Weibull reliability model,}}
  {{APIComment|'Create a new model. The following example creates a 2-parameter Weibull reliability model,}}
  {{APIComment|'with beta 1 and eta 100. The model name is "MyNewModel."}}
  {{APIComment|'with beta &#61; 1 and eta &#61; 100. The model name is "MyNewModel."}}
   {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, 1, 100)
   {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, 1, 100)
   
   
  {{APIComment|'Add the new model to project #1. The model will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new model to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Model.AddModel(newModel)
   MyRepository.Model.AddModel(newModel)

Revision as of 21:32, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Adds a new model to a Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

If a model with the same name already exists in the current project, the application will automatically increment the name. 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 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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ...   


 '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)