Data Object - HostNumericSensorInfo

Property of
HostSystemHealthInfo
Extends
DynamicData
See also
ElementDescription
Since
VI API 2.5

Data Object Description

Base class for numeric sensor information.

Properties

Name Type Description
baseUnitsxsd:string

The base units in which the sensor reading is specified. If rateUnits is set the units of the current reading is further qualified by the rateUnits.
See rateUnits

currentReadingxsd:long

The current reading of the element indicated by the sensor. The actual sensor reading is obtained by multiplying the current reading by the scale factor.
healthState*ElementDescription

The health state of the of the element indicated by the sensor. This property is populated only for sensors that support threshold settings.
See HostNumericSensorHealthState

namexsd:string

The name of the physical element associated with the sensor
rateUnits*xsd:string

The rate units in which the sensor reading is specified. For example if the baseUnits is Volts and the rateUnits is per second the value returned by the sensor are in Volts/second.
sensorTypexsd:string

The type of the sensor. If the sensor type is set to Other the sensor name can be used to further identify the type of sensor. The sensor units can also be used to further implicitly determine the type of the sensor.
See HostNumericSensorType

unitModifierxsd:int

The unit multiplier for the values returned by the sensor. All values returned by the sensor are current reading * 10 raised to the power of the UnitModifier.
Properties inherited from DynamicData
dynamicProperty, dynamicType
*Need not be set