GetMeasurementTypes method

Description

VWorks software calls the GetMeasurementTypes method to get all available measurement types from the plugin, such as battery level, power load, and internal temperature.

Syntax

 

HRESULT GetMeasurementTypes( [out] BSTR *xmlTypes, [out,retval] enum ReturnCode *retcode );

Parameters

 

xmlTypes	[out] A MeasurementTypes XML block that defines all available measurement types.
retcode	[out, retval] Returns an error code. Possible values: 0 = The request was completed (RETURN_SUCCESS) 1 = Something was wrong with the input, so the request was not completed (RETURN_BAD_ARGS) 2 = The request was not completed (RETURN_FAIL) For more information, see “ReturnCode enumerated type” .

GetMeasurementTypes method output

The plugin returns a MeasurementTypes XML block in the xmlTypes parameter of the GetMeasurementTypes method.

MeasurementTypes XML block

The MeasurementTypes XML block contains the MeasurementTypes element and all its children. This XML block defines the available measurement types, including settings that are specified on the Measurement Manager tab.

XML structure

The value of the file attribute for the Velocity11 element is Measurement. See “Velocity11 element” .

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11> <MeasurementTypes> <MeasurementType /> ... </MeasurementTypes> </Velocity11>

MeasurementTypes element

The MeasurementTypes element contains one or more MeasurementType elements.

MeasurementType element

The MeasurementType element has the following attributes:

 

Name	Value
CriticalTime	The time, in seconds, that the measurement is allowed to be above the upper limit or below the lower limit before it is considered to be out of range. Required: No Default value: 0
LogAction	Specifies when to log the measurement value. Possible values: -1 = Always log the measurement value based on the poll frequency (LOG_ACTION_ALWAYS)  0 = Do not log any measurement values (LOG_ACTION_NONE)  1 = Log the measurement value only when the value is less than the lower limit and the duration is longer than the critical time (LOG_ACTION_LOW)  2 = Log the measurement value only when the value exceeds the upper limit and the duration is longer than the critical time (LOG_ACTION_HIGH)  3 = Log the measurement value when the value is less than the lower limit or exceeds the upper limit and when the duration is longer than the critical time (LOG_ACTION_HIGHLOW) Required: No Default value: 0
LowerLimit	The lower limit for the measurement type. Required: No Default value: 0.0
MeasurementName	The name of the measurement type. Required: No Default value: No value
PauseAction	Specifies when to pause the scheduler. Possible values: 0 = Do not pause the scheduler for any measurement values (PAUSE_ACTION_NONE) 1 = Pause the scheduler for the measurement value only when the value is less than the lower limit and the duration is longer than the critical time (PAUSE_ACTION_LOW) 2 = Pause the scheduler for the measurement value only when the value exceeds the upper limit and the duration is longer than the critical time (PAUSE_ACTION_HIGH) 3 = Pause the scheduler for the measurement value when the value is less than the lower limit or exceeds the upper limit and when the duration is longer than the critical time (PAUSE_ACTION_HIGHLOW) Required: No Default value: 0
PollFrequency	The frequency at which VWorks software requests measurement values, in seconds. Required: No Default value: 0
Unit	The unit of measurement for the measurement type. Required: No Default value: No value
UpperLimit	The upper limit for the measurement type. Required: No Default value: 0.0

Example of GetMeasurementTypes method output

The following sample code is a MeasurementTypes XML block that is returned to VWorks software by the plugin as a string in the xmlTypes parameter of the GetMeasurementTypes method. The plugin returns the measurement type named Battery level to VWorks software.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='Measurement' md5sum='d597fb30274a5effc9c50473338e7522' →version='1.1' > <MeasurementTypes > <MeasurementType CriticalTime='5' LogAction='1' LowerLimit='80' →MeasurementName='Battery level' PauseAction='3' PollFrequency='10' Unit='%' →UpperLimit='100' /> </MeasurementTypes> </Velocity11>

Related information

 

For information about...	See...
GetMeasurement method	“GetMeasurement method”