Difference between revisions of "CModel.Pdf"

From ReliaWiki
Jump to navigation Jump to search
m
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:cModel.Pdf}}
+
{{DISPLAYTITLE:cModel.Pdf}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
{{Template:APIClass|CModel Class|CModel}}  
 
{{Template:CModel.Pdf.Cmt}}
 
  
== Syntax==
 
*{{APIName|Pdf}}( Time {{APIPrefix|As Double}} , {{APIPrefix|Optional}} CurrentAge {{APIPrefix|As Double}} = 0 , {{APIPrefix|Optional}} DutyCycle {{APIPrefix|As Double}} = 1 ) {{APIPrefix|As Double}}
 
  
Parameters
+
<onlyinclude>Returns the y-value of the pdf at the specified x-value (time). '''Double'''</onlyinclude>
:''Time'': The x-value (time) to calculate the y-value from the ''pdf''.
 
:''CurrentAge'': The current age.
 
:''DutyCycle'': The duty cycle.
 
  
== Usage Example ==
+
== Syntax ==
{{APIComment|Declare the cModel class using an in-line parameter list.}}
 
        Dim newModel As New cModel(ModelTypeEnum.Weibull2, ModelCategoryEnum.Reliability, "NewModel1", 1, 100)
 
  
{{APIComment|Calculate the PDF at time 100 for the model described in newModel.}}
+
'''.Pdf'''(''Time'', ''CurrentAge'', ''DutyCycle'')
        Dim ResultValue as Double
+
 
        ResultValue = newModel.Pdf(100)
+
===Parameters===
 +
 
 +
''Time''
 +
:Required. Double. The x-value (time) at which to calculate the y-value.
 +
 
 +
''CurrentAge''
 +
:Optional. Double. The current age. Default value = 0.
 +
 
 +
''DutyCycle''
 +
:Optional. Double. The duty cycle. Default value = 1.
 +
 
 +
 
 +
== Example ==
 +
'''VBA|VB.NET'''
 +
 +
{{APIComment|...}}
 +
 +
{{APIComment|'Add code to get an existing model or create a new one.}}
 +
  {{APIPrefix|Dim}} AModel {{APIPrefix|As New}} cModel
 +
{{APIComment|...}}
 +
 +
{{APIComment|Calculate the y-value of the model's pdf at x &#61; 100.}}
 +
  {{APIPrefix|Dim}} ResultValue {{APIPrefix|As Double}}
 +
  ResultValue = AModel.Pdf(100)

Latest revision as of 21:19, 13 November 2015

APIWiki.png


Member of: SynthesisAPI.cModel


Returns the y-value of the pdf at the specified x-value (time). Double

Syntax

.Pdf(Time, CurrentAge, DutyCycle)

Parameters

Time

Required. Double. The x-value (time) at which to calculate the y-value.

CurrentAge

Optional. Double. The current age. Default value = 0.

DutyCycle

Optional. Double. The duty cycle. Default value = 1.


Example

VBA|VB.NET

 ... 

 'Add code to get an existing model or create a new one. 
 Dim AModel As New cModel
 ... 

 Calculate the y-value of the model's pdf at x = 100. 
 Dim ResultValue As Double
 ResultValue = AModel.Pdf(100)