Difference between revisions of "CModel.Pdf"

From ReliaWiki
Jump to navigation Jump to search
m
 
(14 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:APIClass|CModel Class|CModel}}  
+
{{DISPLAYTITLE:cModel.Pdf}}{{Template:API}}{{Template:APIBreadcrumb|.[[CModel Class|cModel]]}}
  
  
== Syntax==
+
<onlyinclude>Returns the y-value of the pdf at the specified x-value (time). '''Double'''</onlyinclude>
{{Template:cModel.Pdf}}
+
 
{{APIPrefix|Public Function}}
+
== Syntax ==
{{APIName|[[cModel.Pdf|Pdf]]}}
+
 
{{APIName|(}}
+
'''.Pdf'''(''Time'', ''CurrentAge'', ''DutyCycle'')
{{APIPrefix|ByVal}}
+
 
{{APIName|Time}}
+
===Parameters===
{{APIPrefix|As Double}}
+
 
{{APIName|,}}
+
''Time''
{{APIPrefix|Optional ByVal}}
+
:Required. Double. The x-value (time) at which to calculate the y-value.
{{APIName|CurrentAge}}
+
 
{{APIPrefix|As Double}}
+
''CurrentAge''
=
+
:Optional. Double. The current age. Default value = 0.
{{APIName|0,}}
+
 
{{APIPrefix|Optional ByVal}}
+
''DutyCycle''
{{APIName|DutyCycle}}
+
:Optional. Double. The duty cycle. Default value = 1.  
{{APIPrefix|As Double}}
+
 
=
+
 
{{APIName|1)}}
+
== Example ==
{{APIPrefix|As Double}}<br>
+
'''VBA|VB.NET'''
{{APIComment|Returns pdf given time.}}
+
 +
{{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)