CModel Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 19: Line 19:
|-
|-
|[[CModel.Parameters|Parameters]]||{{:CModel.Parameters}}  
|[[CModel.Parameters|Parameters]]||{{:CModel.Parameters}}  
|}
'''ALTA Models'''
{| {{APITable}}
|-
|-
| style="width: 200px;"|[[CModel.ScaleParameter A|ScaleParameter_A]]||{{:CModel.ScaleParameter_A}}
|[[CModel.ScaleParameter A|ScaleParameter_A]]||{{:CModel.ScaleParameter_A}}
|-
|-
|[[CModel.SetUseStress|SetUseStress]]||{{APIComment|{{Template:CModel.SetUseStress1}}}}  
|[[CModel.SetUseStress|SetUseStress]]||{{APIComment|{{Template:CModel.SetUseStress1}}}}  

Revision as of 22:40, 6 August 2015

APIWiki.png


Member of: SynthesisAPI


Represents a model resource.

Constructors

Name Description
cModel Creates an instance of the cModel class.
cModel() A parameterized constructor for the cModel class. (.NET only)


Methods

Name Description
SetModel Sets the model type, category, name and parameters of an associated cModel object.
Parameters Returns an array of ParamValues objects that represent the parameter name and value pairs of an associated cModel object.
ScaleParameter_A For ALTA models, returns the scale parameter at the use stress level. Double. Returns 0 if the model is not an ALTA model.
SetUseStress Updates the use stress value for the stress with the specified index.


Standard Calculations

Name Description
Reliability Returns the reliability at the specified time. Double
Unreliability Returns the probability of failure at the specified time. Double
Time Returns the time at which a specified reliability will be achieved. Double
MeanTime Returns the mean time to failure. Double
Pdf Returns the y-value of the pdf at the specified x-value (time). Double
FailureRate Returns the failure rate at the specified time. Double


Confidence Bound Calculations

Name Description
SetConfidenceLevel Sets the confidence level to use in confidence bounds calculations for published models. Returns a Boolean value; when true, indicates that a confidence level has been set.
Bounds_Reliability Calculates the bounds on the reliability at the specified time for an associated cModel object. Returns a BoundsValues object that represents the confidence bounds.
Bounds_Unreliability Calculates the bounds on the probability of failure at a specified time for an associated cModel object. Returns a BoundsValues object that represents the confidence bounds.
Bounds_Time Calculates the bounds on the time at which a specified reliability will be achieved for an associated cModel object. Returns a BoundsValues object that represents the confidence bounds.
Bounds_MeanTime Calculates the bounds on the mean time to failure for an associated cModel object. Returns a BoundsValues object that represents the confidence bounds.
Bounds_FailureRate Calculates the bounds on the failure rate at a specified time for an associated cModel object. Returns a BoundsValues object that represents the confidence bounds.
Bounds_Parameters Calculates the confidence bounds on the parameter estimates of an associated cModel object. Returns a ParamBoundsValues object that represents the confidence bounds on the parameter estimates.

Properties

Name Description
Name Gets or sets the name of the model. String
Type Gets a value from the ModelTypeEnum enumeration, which specifies the model type (e.g., distribution, constant or dynamic).
Designation Gets a string representing the model type (e.g., distribution, constant or dynamic). String
Category Gets a value from the ModelCategoryEnum enumeration, which specifies the model's category (e.g., reliability model, duration model, cost model, etc.).
ProjectID Gets the numeric ID of the project the model belongs to. Integer
UnitID Gets or sets the model's (user-defined) unit ID number. Integer
ID Gets a string representing the (system-generated) numeric ID of the model. String
ConfLevel Gets the confidence level that is currently used for calculations. Double
ConfBoundsMethod Gets a value from the ConfBoundsMethods enumeration, which specifies the method used for estimating the confidence bounds.
NumStresses Applies to ALTA models only. Gets the number of stresses in the model. Integer
ErrorHappened Indicates whether the last calculation produced an error. Boolean


Synthesis Identifiers

Name Description
ItemApplication Gets or sets the item's application. (Synthesis identifier) String
ItemCategoryID Gets or sets the category ID. (Synthesis identifier) Integer
ItemComments Gets or sets the comments. (Synthesis identifier) String
ItemDescription Gets or sets the description. (Synthesis identifier) String
ItemKeywords Gets or sets the keywords. (Synthesis identifier) String
ItemPartNumber Gets or sets the part number. (Synthesis identifier) String
ItemSupplier Gets or sets the supplier name. (Synthesis identifier) String
ItemVersion Gets or sets the version number. (Synthesis identifier) String