Difference between revisions of "CModel Constructors"

From ReliaWiki
Jump to navigation Jump to search
Line 9: Line 9:
 
===Parameters===
 
===Parameters===
 
''ModelType''
 
''ModelType''
: The type of model (e.g., 2-parameter Weibull), specified with a [[ModelTypeEnum Enumeration|ModelTypeEnum]] enumeration value.
+
: The type of model (e.g., 2-parameter Weibull). Can be any [[ModelTypeEnum Enumeration|ModelTypeEnum]] constant. (Required)
 
''ModelCategory''
 
''ModelCategory''
: The model category (e.g., reliability model), specified with a [[ModelCategoryEnum Enumeration|ModelCategoryEnum]] enumeration value.
+
: The model category (e.g., reliability model). Can be any [[ModelCategoryEnum Enumeration|ModelCategoryEnum]] constant. (Required)
 
''ModelName''
 
''ModelName''
: String. The model name.
+
: String. The model name. (Required)
 
''ModelParams()''
 
''ModelParams()''
: Double. An array of parameter values. <!--Need to create/link page explaining how the values should be ordered, depending on distribution.-->
+
: Double. An array of parameter values. (Required)<!--Need to create/link page explaining how the values should be ordered, depending on distribution.-->
  
 
== Example ==
 
== Example ==

Revision as of 17:40, 28 July 2015

APIWiki.png


Member of: SynthesisAPI9.cModel


A parameterized constructor for the cModel class. (VisualBasic.NET only)

Syntax

cModel(ModelType, ModelCategory, ModelName, 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 parameter values. (Required)

Example

VB.NET

 'Declare the cModel class using a pre-defined parameter list. 
 Dim newParams(1) As Double
 newParams(0) = 1
 newParams(1) = 100
 Dim newModel As New cModel(ModelTypeEnum.Weibull2,ModelCategoryEnum.Reliability, "NewModel1", newParams)
 
 'Alternatively, declare the cModel class using an in-line parameter list. 
 Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "NewModel1", 1, 100)