TreeAge Pro


TreeObj.Sensitivity		v1.0
TreeObj - Object Overview
TreeAge Pro - Table of Contents

TreeAge Pro Interactive - Table of Contents

Documentation Home
TreeAge Website Home
  
Syntax: Function Sensitivity (saParams as Object) as Object
Description: This method runs a sensitivity analysis at the currently-selected node.
Return value:  Returns a SensAnOutput object.
Remarks:  The parameters of the analysis are input by filling in the properties of the SensAnParams object which is passed in to this method.

The value of lastError is set by this method. If it is zero, the analysis succeeded; otherwise, it will be an error code. Also, the "valid" property of the returned object will be set to false if any error occurs.

Also, this method sets the calcTime property to the number of milliseconds required to perform the analysis.

Sample code: 
Dim saParams as New SensAnParams, saOutput as SensAnOutput 
Dim err as Long, grph as GraphObj, htmlStr as String

'--- prepare the analysis parameters
saParams.variable = "pLive"
saParams.low = 0.1
saParams.high = 0.9
saParams.intervals = 8

'--- run the analysis
Set saOutput = tree.Sensitivity(saParams)
err = tree.lastError
if err != active_noErr then
    Set grph = saOutput.GetGraph (0, "")
	htmlStr = saOutput.GetTextReport( 0 )
    ...
else
    '--- handle the error
end if
See also: SensAnOutput
SensAnParams
lastError
Error codes
calcTime