Difference between revisions of "CModel Constructors"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
  
  
<onlyinclude>A parameterized constructor for the [[CModel Class|cModel]] class. (VisualBasic.NET only)</onlyinclude>
+
<onlyinclude>A parameterized constructor for the [[CModel Class|cModel]] class.</onlyinclude>
  
 
== Syntax ==
 
== Syntax ==
  '''cModel'''(''ModelType'', ''ModelCategory'', ''ModelName'', ''ModelParams()'')
+
  '''cModel'''(''ModelType'', ''ModelCategory'', ''ModelName'', {{APIPrefix|ParamArray}} ''ModelParams()'')
  
 
===Parameters===
 
===Parameters===
Line 15: Line 15:
 
: String. The model name. (Required)
 
: String. The model name. (Required)
 
''ModelParams()''
 
''ModelParams()''
: Double. An array of parameter values. (Required)<!--Need to create/link page explaining how the values should be ordered, depending on distribution.-->
+
: Double. An array of the model's parameters. (Optional)<!--Need to create/link page explaining how the values should be ordered, depending on distribution.-->
 +
 
 +
{{APIPrefix|ParamArray}}
  
 
== Example ==
 
== Example ==
 
  '''VB.NET'''
 
  '''VB.NET'''
 
   
 
   
  {{APIComment|'Create a new model using a pre-defined parameter list.}}
+
  {{APIComment|'The following code creates a 2-parameter Weibull reliability model,}}
   {{APIPrefix|Dim}} newParams(1) {{APIPrefix|As Double}}
+
{{APIComment|'with beta 1 and eta 100. The model name is "MyNewModel."}}
   newParams(0) = 1
+
   {{APIPrefix|Dim}} ModelParams(1) {{APIPrefix|As Double}}
   newParams(1) = 100
+
   ModelParams(0) = 1
   {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2,ModelCategoryEnum.Reliability, {{APIString|"NewModel1"}}, newParams)
+
   ModelParams(1) = 100
 
+
   {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2,ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, ModelParams)
 +
 
  {{APIComment|'Alternatively, you can create a new model using an in-line parameter list.}}
 
  {{APIComment|'Alternatively, you can create a new model using an in-line parameter list.}}
   {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"NewModel1"}}, 1, 100)
+
   {{APIPrefix|Dim}} newModel {{APIPrefix|As New}} cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, {{APIString|"MyNewModel"}}, 1, 100)

Revision as of 22:04, 28 July 2015

APIWiki.png


Member of: SynthesisAPI9.cModel


A parameterized constructor for the cModel class.

Syntax

cModel(ModelType, ModelCategory, ModelName, ParamArray ModelParams())

Parameters

ModelType

The type of model (e.g., 2-parameter Weibull). Can be any ModelTypeEnum constant. (Required)

ModelCategory

The model category (e.g., reliability model). Can be any ModelCategoryEnum constant. (Required)

ModelName

String. The model name. (Required)

ModelParams()

Double. An array of the model's parameters. (Optional)

ParamArray

Example

VB.NET

 'The following code creates a 2-parameter Weibull reliability model, 
 'with beta 1 and eta 100. The model name is "MyNewModel." 
 Dim ModelParams(1) As Double
 ModelParams(0) = 1
 ModelParams(1) = 100
 Dim newModel As New cModel(ModelTypeEnum.Weibull2,ModelCategoryEnum.Reliability, "MyNewModel", ModelParams)

 'Alternatively, you can create a new model using an in-line parameter list. 
 Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "MyNewModel", 1, 100)