CustomObservation.SetComputedValue(String, String, Variable) Method

Top 

Description

Sets the Pre-Update or Post-Update ComputedValue for the Custom Measurement with the specified label.

 

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

Click here to see the documentation for this object in millisecond timing precision mode.

 

Method Signature

CustomObservation.SetComputedValue(

String meausrementLabel,


String computedValueToSet,


Variable computedValue)

 

 

Arguments

meausrementLabel


Description:

The name or label of the Custom Measurement.

 

 

computedValueToSet


Description:

The designation of which Computed Value to set, Pre-Update or Post-Update.

Valid Values:

Value

Label

"Pre-Update"

Set the PreUpdateComputedValue.

"Post-Update"

Set the PostUpdateComputedValue.

 

 

 

computedValue


Description:

The computed value of the Custom Measurement.

 

 

 

Return Value

Type:

number

 

 

Returns the 1 if the Computed Value of the Custom Measurement was successfully set.

 

Syntax

myVariable1 = myCustomObservation1.SetComputedValue(myString1, myString2, myVariable2);

 

 

See also

CustomObservation Object