CModel Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
← Older editNewer edit →
Alex Ulanov (talk | contribs)
ReliaSoft
245 edits
No edit summary
Kate Racaza (talk | contribs)
6,536 edits
No edit summary
Line 1: Line 1:
{{DISPLAYTITLE:cModel Class}} {{Template:APIClass|Resource Classes|Resource Classes}}  
{{Template:API}}{{Template:APIBreadcrumbClass}}


{{Template:CModel_Class.Cmt}}


{{Template:ResourceLinkToRepositoryClass.Cmt}}
Represents a model resource.


== Constructors ==
==Constructors==
{| {{APITable}}
|-
| style="width: 200px;"|cModel||Creates an instance of the cModel class.
|-
|[[CModel Constructors|cModel()]]||{{:CModel Constructors}}
|}


*[[CModel Constructors|cModel]] {{APIComment|Creates an empty model. SetModel method must be called to set the model name, type, category and parameters.}}
*[[CModel Constructors|cModel( ModelTypeEnum, ModelCategoryEnum, String, Double() )]] {{APIComment|Creates a new model using the provided model type, category, name and parameters.}}


== Methods and Properties  ==
== Methods==
{| {{APITable}}
|-
| style="width: 200px;"|[[CModel.SetModel|SetModel]]||{{:CModel.SetModel}}
|-
|[[CModel.Parameters|Parameters]]||{{:CModel.Parameters}}
|}


'''Model'''


*Type (as ''[[ModelTypeEnum Enumeration|ModelTypeEnum]]'') {{APIComment|Gets the model type (e.g., 2-parameter Weibull).}}
'''ALTA Models'''  
*Category (as ''[[ModelCategoryEnum Enumeration|ModelCategoryEnum]]'') {{APIComment|Gets the model category (e.g., reliability).}}  
{| {{APITable}}
*Designation (as ''string'') {{APIComment|Gets a string representing the model type (for example "2P-Weibull").}}
|-
*UnitID (as ''integer'') {{APIComment|Gets or sets the unit ID.}} [[#Notes|*]]
| style="width: 200px;"|[[CModel.ScaleParameter A|ScaleParameter_A]]||{{:CModel.ScaleParameter_A}}
*[[CModel.SetModel|SetModel( ModelTypeEnum, ModelCategoryEnum, Double() )]] {{APIComment|{{Template:CModel.SetModel.Cmt}}}}  
|-
*[[CModel.Parameters|Parameters]] {{APIComment|{{Template:CModel.Parameters.Cmt}}}}  
|[[CModel.SetUseStress|SetUseStress]]||{{APIComment|{{Template:CModel.SetUseStress1}}}}  
*[[CModel.ScaleParameter A|ScaleParameter_A]] {{APIComment|Returns the scale parameter for ALTA models. Returns 0 if the model is not an ALTA model.}}
|}


'''Item'''


*Name (as ''string'') {{APIComment|Gets or sets the name of the model.}}
'''Standard Calculations'''
*ID (as ''string''){{APIComment|Gets the numerical ID of the model.}}
{| {{APITable}}
*ProjectID (as ''integer'') {{APIComment|Gets the numerical ID of the project the model belongs to.}}  
|-
*[[CModel.ItemCategoryID|ItemCategoryID(Integer)]] {{APIComment|{{Template:ItemCategoryID.Cmt}}}}
| style="width: 200px;"|[[CModel.Reliability|Reliability]]||{{:CModel.Reliability}}  
*[[CModel.ItemPartNumber|ItemPartNumber(String)]] {{APIComment|{{Template:ItemPartNumber.Cmt}}}}  
|-
*[[CModel.ItemVersion|ItemVersion(String)]] {{APIComment|{{Template:ItemVersion.Cmt}}}}  
|[[CModel.Unreliability|Unreliability]]||{{:CModel.Unreliability}}  
*[[CModel.ItemSupplier|ItemSupplier(String)]] {{APIComment|{{Template:ItemSupplier.Cmt}}}}  
|-
*[[CModel.ItemApplication|ItemApplication(String)]] {{APIComment|{{Template:ItemApplication.Cmt}}}}  
|[[CModel.Time|Time]]||{{:CModel.Time}}  
*[[CModel.ItemDescription|ItemDescription(String)]] {{APIComment|{{Template:ItemDescription.Cmt}}}}  
|-
*[[CModel.ItemComments|ItemComments(String)]] {{APIComment|{{Template:ItemComments.Cmt}}}}  
|[[CModel.MeanTime|MeanTime]]||{{:CModel.MeanTime}}  
*[[CModel.ItemKeywords|ItemKeywords(String)]] {{APIComment|{{Template:ItemKeywords.Cmt}}}}
|-
|[[CModel.Pdf|Pdf]]||{{:CModel.Pdf}}}  
|-
|[[CModel.FailureRate|FailureRate]]||{{:CModel.FailureRate}}
|}


'''Stress (ALTA Models Only)'''


*NumStresses (as ''integer'') {{APIComment|Gets the number of stresses in the model.}}  
'''Confidence Bound Calculations'''
*[[CModel.SetUseStress|SetUseStress( Integer, Double )]] {{APIComment|{{Template:CModel.SetUseStress1}}}}  
{| {{APITable}}
*[[CModel.SetUseStress|SetUseStress( Double() )]] {{APIComment|{{Template:CModel.SetUseStress2}}}}
|-
| style="width: 200px;"|[[CModel.SetConfidenceLevel|SetConfidenceLevel]]||{{:CModel.SetConfidenceLevel}}  
|-
|[[CModel.Bounds Reliability|Bounds_Reliability]]||{{:CModel.Bounds Reliability}}
|-
|[[CModel.Bounds Unreliability|Bounds_Unreliability]]||{{:CModel.Bounds Unreliability}}  
|-
|[[CModel.Bounds Time|Bounds_Time]]||{{:CModel.Bounds Time}}  
|-
|[[CModel.Bounds MeanTime|Bounds_MeanTime]]||{{:CModel.Bounds MeanTime}}
|-
|[[CModel.Bounds FailureRate|Bounds_FailureRate]]||{{:CModel.Bounds FailureRate}}
|-
|[[CModel.Bounds Parameters|Bounds_Parameters]]||{{:CModel.Bounds Parameters}}
|}


'''Standard Calculations'''


*ErrorHappened (as ''boolean'') {{APIComment|Whether or not the last calculation produced an error.}}
==Properties==
*[[CModel.Reliability|Reliability( Double, [Double], [Double] )]] {{APIComment|{{Template:CModel.Reliability.Cmt}}}}
{| {{APITable}}
*[[CModel.Unreliability|Unreliability( Double, [Double], [Double] )]] {{APIComment|{{Template:CModel.Unreliability.Cmt}}}}
|-
*[[CModel.Time|Time( Double [Double], [Double] )]] {{APIComment|{{Template:CModel.Time.Cmt}}}}
| style="width: 200px;"|
*[[CModel.MeanTime|MeanTime( [Double], [Double] )]] {{APIComment|{{Template:CModel.MeanTime.Cmt}}}}
|-
*[[CModel.Pdf|Pdf( Double [Double], [Double] )]] {{APIComment|{{Template:CModel.Pdf.Cmt}}}}
|Name||''String''. Gets or sets the name of the model.
*[[CModel.FailureRate|FailureRate( Double [Double], [Double] )]] {{APIComment|{{Template:CModel.FailureRate.Cmt}}}}
|-
|Type||Gets or sets a value from the [[ModelTypeEnum Enumeration|ModelTypeEnum]] enumeration, which specifies the types of models (e.g., 2-parameter Weibull).
|-
|Designation||''String''. Gets a string representing the model type (e.g., 2P-Weibull).
|-
|Category||Gets or sets a value from the [[ModelCategoryEnum Enumeration|ModelCategoryEnum]] enumeration, which specifies the model categories (e.g., reliability).
|-
|ProjectID||''Integer''. Gets the numerical ID of the project the model belongs to.  
|-
|UnitID||''Integer''. Gets or sets the model's unit ID number.
|-
|ID||''String''. Gets a string representing the numerical ID of the model.
|-
|ConfLevel||''Double''. Gets the confidence level that is currently used for calculations.  
|-
|NumStresses||''Integer''. Applies to ALTA models only. Gets the number of stresses in the model.
|-
|ErrorHappened||''Boolean''. Indicates whether the last calculation produced an error.  
|}


'''Confidence Bound Calculations'''


*ConfLevel (as ''double'') {{APIComment|Gets the confidence level that is currently used for calculations.}}
'''Synthesis Identifiers'''
*[[CModel.SetConfidenceLevel|SetConfidenceLevel( Double, ConfBoundsSides, Boolean, String )]] {{APIComment|{{CModel.SetConfidenceLevel.Cmt}}}}
{| {{APITable}}
*[[CModel.Bounds Reliability|Bounds_Reliability( Double, [Double], [Double] )]] {{APIComment|{{CModel.Bounds Reliability.Cmt}}}}
|-
*[[CModel.Bounds Unreliability|Bounds_Unreliability( Double, [Double], [Double] )]] {{APIComment|{{Template:CModel.Bounds Unreliability.Cmt}}}}
| style="width: 200px;"|ItemCategoryID||''Integer''. Gets or sets the category ID.  
*[[CModel.Bounds Time|Bounds_Time( Double, [Double], [Double] )]] {{APIComment|{{Template:CModel.Bounds Time.Cmt}}}}
|-
*[[CModel.Bounds MeanTime|Bounds_MeanTime( [Double], [Double] )]] {{APIComment|{{Template:CModel.Bounds MeanTime.Cmt}}}}
|ItemPartNumber||''String''. Gets or sets the part number.  
*[[CModel.Bounds FailureRate|Bounds_FailureRate( Double, [Double], [Double] )]] {{APIComment|{{Template:CModel.Bounds FailureRate.Cmt}} }}
|-
*[[CModel.Bounds Parameters|Bounds_Parameters]] {{APIComment|{{Template:CModel.Bounds Parameters.Cmt}}}}
|ItemVersion||''String''. Gets or sets the version number.  
|-
|ItemSupplier||''String''. Gets or sets the supplier name.  
|-
|ItemApplication||''String''. Gets or sets the application.
|-
|ItemDescription||''String''. Gets or sets the description.  
|-
|ItemComments||''String''. Gets or sets the comments.  
|-
|ItemKeywords||''String''. Gets or sets the keywords.
|}


<!--
== Usage Example  ==
== Usage Example  ==


Line 83: Line 135:
  Dim Rel as Double
  Dim Rel as Double
  Rel = WDSFittedModel.Reliability(50)
  Rel = WDSFittedModel.Reliability(50)
 
-->
== Notes ==
{{v10orgreater}}

Revision as of 23:26, 29 July 2015


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.


ALTA Models

Name Description
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 String. Gets or sets the name of the model.
Type Gets or sets a value from the ModelTypeEnum enumeration, which specifies the types of models (e.g., 2-parameter Weibull).
Designation String. Gets a string representing the model type (e.g., 2P-Weibull).
Category Gets or sets a value from the ModelCategoryEnum enumeration, which specifies the model categories (e.g., reliability).
ProjectID Integer. Gets the numerical ID of the project the model belongs to.
UnitID Integer. Gets or sets the model's unit ID number.
ID String. Gets a string representing the numerical ID of the model.
ConfLevel Double. Gets the confidence level that is currently used for calculations.
NumStresses Integer. Applies to ALTA models only. Gets the number of stresses in the model.
ErrorHappened Boolean. Indicates whether the last calculation produced an error.


Synthesis Identifiers

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


Retrieved from "https://www.reliawiki.com/index.php?title=CModel_Class&oldid=60165"