# Class CIM_NumericSensor
extends CIM_Sensor

A Numeric Sensor is capable of returning numeric readings and optionally supports thresholds settings.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_EnabledLogicalElement
|
+--CIM_LogicalDevice
|
+--CIM_Sensor
|
+--CIM_NumericSensor

## Direct Known Subclasses

CIM_CurrentSensor
CIM_Tachometer
CIM_TemperatureSensor
CIM_VoltageSensor

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A Numeric Sensor is capable of returning numeric readings and optionally supports thresholds settings.
UMLPackagePath | string | CIM::Device::Sensors
Version | string | 2.16.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
Accuracy | sint32 |
Description | string | Indicates the accuracy of the Sensor for the measured property. Its value is recorded as plus/minus hundredths of a percent. Accuracy, along with Resolution, is used to calculate the actual value of the measured physical property. Accuracy may vary depending on whether the Device is linear over its dynamic range.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.19, MIF.DMTF|Electrical Current Probe|001.19, MIF.DMTF|Voltage Probe|001.19
PUnit | string | percent * 10^-2
Units | string | Hundredths of Percent
BaseUnits | uint16 |
Description | string | The base unit of the values returned by this Sensor. All the values returned by this Sensor are represented in the units obtained by (BaseUnits * 10 raised to the power of the UnitModifier). For example, if BaseUnits is Volts and the UnitModifier is -6, then the units of the values returned are MicroVolts. However, if the RateUnits property is set to a value other than "None", then the units are further qualified as rate units. In the above example, if RateUnits is set to "Per Second", then the values returned by the Sensor are in MicroVolts/Second. The units apply to all numeric properties of the Sensor, unless explicitly overridden by the Units qualifier.
ModelCorrespondence | string | CIM_NumericSensor.UnitModifier, CIM_NumericSensor.RateUnits
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66
Values | string | Unknown, Other, Degrees C, Degrees F, Degrees K, Volts, Amps, Watts, Joules, Coulombs, VA, Nits, Lumens, Lux, Candelas, kPa, PSI, Newtons, CFM, RPM, Hertz, Seconds, Minutes, Hours, Days, Weeks, Mils, Inches, Feet, Cubic Inches, Cubic Feet, Meters, Cubic Centimeters, Cubic Meters, Liters, Fluid Ounces, Radians, Steradians, Revolutions, Cycles, Gravities, Ounces, Pounds, Foot-Pounds, Ounce-Inches, Gauss, Gilberts, Henries, Farads, Ohms, Siemens, Moles, Becquerels, PPM (parts/million), Decibels, DbA, DbC, Grays, Sieverts, Color Temperature Degrees K, Bits, Bytes, Words (data), DoubleWords, QuadWords, Percentage, Pascals
CurrentReading | sint32 |
Description | string | The current value indicated by the Sensor.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.5, MIF.DMTF|Electrical Current Probe|001.5, MIF.DMTF|Voltage Probe|001.5
Hysteresis | uint32 |
Description | string | Indicates the margin built around the thresholds. This margin prevents unnecessary state changes when the Sensor reading may fluctuate very close to its thresholds. This could be due to the Sensor's tolerance/accuracy/resolution or due to environmental factors. Once a threshold is crossed, the state of the Sensor should change. However, the state should not fluctuate between the old and new states unless the Sensor's change in the reading exceeds the hysteresis value. The units for this measurement are determined by BaseUnit*UnitModifier/RateUnit.
IsLinear | boolean |
Description | string | Indicates that the Sensor is linear over its dynamic range.
LowerThresholdCritical | sint32 |
Description | string | The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If the CurrentReading is between LowerThresholdCritical and Lower ThresholdFatal, then the CurrentState is Critical.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.13, MIF.DMTF|Electrical Current Probe|001.13, MIF.DMTF|Voltage Probe|001.13
Write | boolean | true
LowerThresholdFatal | sint32 |
Description | string | The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If the CurrentReading is below LowerThresholdFatal, then the Current State is Fatal.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.15, MIF.DMTF|Electrical Current Probe|001.15, MIF.DMTF|Voltage Probe|001.15
Write | boolean | true
LowerThresholdNonCritical | sint32 |
Description | string | The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If Current Reading is between LowerThresholdNonCritical and Upper ThresholdNonCritical, then the Sensor is reporting a normal value. If CurrentReading is between LowerThresholdNonCritical and LowerThresholdCritical, then the CurrentState is NonCritical.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.11, MIF.DMTF|Electrical Current Probe|001.11, MIF.DMTF|Voltage Probe|001.11
Write | boolean | true
MaxReadable | sint32 |
Description | string | MaxReadable indicates the largest value of the measured property that can be read by the NumericSensor.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.9, MIF.DMTF|Electrical Current Probe|001.9, MIF.DMTF|Voltage Probe|001.9
MinReadable | sint32 |
Description | string | MinReadable indicates the smallest value of the measured property that can be read by the NumericSensor.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.10, MIF.DMTF|Electrical Current Probe|001.10, MIF.DMTF|Voltage Probe|001.10
NominalReading | sint32 |
Description | string | NominalReading indicates the 'normal' or expected value for the NumericSensor.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.6, MIF.DMTF|Electrical Current Probe|001.6, MIF.DMTF|Voltage Probe|001.6
NormalMax | sint32 |
Description | string | NormalMax provides guidance for the user as to the normal maximum range for the NumericSensor.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.7, MIF.DMTF|Electrical Current Probe|001.7, MIF.DMTF|Voltage Probe|001.7
NormalMin | sint32 |
Description | string | NormalMin provides guidance for the user as to the normal minimum range for the NumericSensor.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.8, MIF.DMTF|Electrical Current Probe|001.8, MIF.DMTF|Voltage Probe|001.8
RateUnits | uint16 |
Description | string | Specifies if the units returned by this Sensor are rate units. All the values returned by this Sensor are represented in the units obtained by (BaseUnits * 10 raised to the power of the UnitModifier). This is true unless this property (RateUnits) has a value different than "None". For example, if BaseUnits is Volts and the UnitModifier is -6, then the units of the values returned are MicroVolts. But, if the RateUnits property is set to a value other than "None", then the units are further qualified as rate units. In the above example, if RateUnits is set to "Per Second", then the values returned by the Sensor are in MicroVolts/Second. The units apply to all numeric properties of the Sensor, unless explicitly overridden by the Units qualifier. Any implementation of CurrentReading should be qualified with either a Counter or a Gauge qualifier, depending on the characteristics of the sensor being modeled.
ModelCorrespondence | string | CIM_NumericSensor.UnitModifier, CIM_NumericSensor.BaseUnits
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9
Values | string | None, Per MicroSecond, Per MilliSecond, Per Second, Per Minute, Per Hour, Per Day, Per Week, Per Month, Per Year
Resolution | uint32 |
Description | string | Resolution indicates the ability of the Sensor to resolve differences in the measured property. The units for this measurement are determined by BaseUnit*UnitModifier/RateUnit.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.17, MIF.DMTF|Electrical Current Probe|001.17, MIF.DMTF|Voltage Probe|001.17
Tolerance | sint32 |
Deprecated | string | CIM_NumericSensor.Resolution, CIM_NumericSensor.Accuracy
Description | string | This property is being deprecated in lieu of using the Resolution and Accuracy properties. Indicates the tolerance of the Sensor for the measured property. Tolerance, along with Resolution and Accuracy, is used to calculate the actual value of the measured physical property. Tolerance may vary depending on whether the Device is linear over its dynamic range.
UnitModifier | sint32 |
Description | string | The unit multiplier for the values returned by this Sensor. All the values returned by this Sensor are represented in the units obtained by (BaseUnits * 10 raised to the power of the UnitModifier). For example, if BaseUnits is Volts and the Unit Modifier is -6, then the units of the values returned are MicroVolts. However, if the RateUnits property is set to a value other than "None", then the units are further qualified as rate units. In the above example, if RateUnits is set to "Per Second", then the values returned by the Sensor are in MicroVolts/Second. The units apply to all numeric properties of the Sensor, unless explicitly overridden by the Units qualifier.
ModelCorrespondence | string | CIM_NumericSensor.BaseUnits, CIM_NumericSensor.RateUnits
UpperThresholdCritical | sint32 |
Description | string | The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If the CurrentReading is between UpperThresholdCritical and Upper ThresholdFatal, then the CurrentState is Critical.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.14, MIF.DMTF|Electrical Current Probe|001.14, MIF.DMTF|Voltage Probe|001.14
Write | boolean | true
UpperThresholdFatal | sint32 |
Description | string | The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If the CurrentReading is above UpperThresholdFatal, then the Current State is Fatal.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.16, MIF.DMTF|Electrical Current Probe|001.16, MIF.DMTF|Voltage Probe|001.16
Write | boolean | true
UpperThresholdNonCritical | sint32 |
Description | string | The Sensor's threshold values specify the ranges (min and max values) for determining whether the Sensor is operating under Normal, NonCritical, Critical or Fatal conditions. If the CurrentReading is between LowerThresholdNonCritical and UpperThresholdNonCritical, then the Sensor is reporting a normal value. If the CurrentReading is between UpperThreshold NonCritical and UpperThresholdCritical, then the CurrentState is NonCritical.
MappingStrings | string | MIF.DMTF|Temperature Probe|002.12, MIF.DMTF|Electrical Current Probe|001.12, MIF.DMTF|Voltage Probe|001.12
Write | boolean | true
EnabledThresholds | uint16[] |
Description | string | An array representing the thresholds that are currently enabled for this Sensor.
ValueMap | string | 0, 1, 2, 3, 4, 5
Values | string | LowerThresholdNonCritical, UpperThresholdNonCritical, LowerThresholdCritical, UpperThresholdCritical, LowerThresholdFatal, UpperThresholdFatal
SettableThresholds | uint16[] |
Description | string | An array representing the writable thresholds supported by Sensor.
ValueMap | string | 0, 1, 2, 3, 4, 5
Values | string | LowerThresholdNonCritical, UpperThresholdNonCritical, LowerThresholdCritical, UpperThresholdCritical, LowerThresholdFatal, UpperThresholdFatal
SupportedThresholds | uint16[] |
Description | string | An array representing the thresholds supported by this Sensor.
ValueMap | string | 0, 1, 2, 3, 4, 5
Values | string | LowerThresholdNonCritical, UpperThresholdNonCritical, LowerThresholdCritical, UpperThresholdCritical, LowerThresholdFatal, UpperThresholdFatal

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Availability | uint16 | CIM_LogicalDevice
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_LogicalDevice
CurrentState | string | CIM_Sensor
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
DeviceID | string | CIM_LogicalDevice
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
ErrorCleared | boolean | CIM_LogicalDevice
ErrorDescription | string | CIM_LogicalDevice
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LastErrorCode | uint32 | CIM_LogicalDevice
MaxQuiesceTime | uint64 | CIM_LogicalDevice
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OtherSensorTypeDescription | string | CIM_Sensor
PollingInterval | uint64 | CIM_Sensor
PowerManagementSupported | boolean | CIM_LogicalDevice
PowerOnHours | uint64 | CIM_LogicalDevice
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
SensorContext | string | CIM_Sensor
SensorType | uint16 | CIM_Sensor
Status | string | CIM_ManagedSystemElement
StatusInfo | uint16 | CIM_LogicalDevice
SystemCreationClassName | string | CIM_LogicalDevice
SystemName | string | CIM_LogicalDevice
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TotalPowerOnHours | uint64 | CIM_LogicalDevice
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AdditionalAvailability | uint16[] | CIM_LogicalDevice
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_LogicalDevice
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_LogicalDevice
PossibleStates | string[] | CIM_Sensor
PowerManagementCapabilities | uint16[] | CIM_LogicalDevice
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### RestoreDefaultThresholds (uint32)

#### Method Qualifiers (RestoreDefaultThresholds)

Name | Data Type | Value
--- | --- | ---
Description | string | This method resets the values of the thresholds to hardware defaults. This method returns 0 if successful, 1 if unsupported and any other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.

#### Method Parameters (RestoreDefaultThresholds)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

#### GetNonLinearFactors (uint32)

#### Method Qualifiers (GetNonLinearFactors)

Name | Data Type | Value
--- | --- | ---
Deprecated | string | No value
Description | string | The use of this method is being deprecated, since Current senor reading can be retrieved through the GetInstance operation. For a non-linear Sensor, the resolution, accuracy, tolerance and hysteresis vary as the current reading moves. This method can be used to get these factors for a given reading. It returns 0 if successful, 1 if unsupported, and any other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.

#### Method Parameters (GetNonLinearFactors)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Accuracy | sint32
Description | string | The accuracy of the reading.
IN | boolean | false
OUT | boolean | true
Hysteresis | uint32
Description | string | The Hysteresis of the reading.
IN | boolean | false
OUT | boolean | true
Resolution | uint32
Description | string | The resolution of the reading.
IN | boolean | false
OUT | boolean | true
SensorReading | sint32
Description | string | The sensor reading to get information for.
IN | boolean | true
Tolerance | sint32
Description | string | The tolerance of the reading.
IN | boolean | false
OUT | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
EnableDevice | uint32 | CIM_LogicalDevice
OnlineDevice | uint32 | CIM_LogicalDevice
QuiesceDevice | uint32 | CIM_LogicalDevice
RequestStateChange | uint32 | CIM_EnabledLogicalElement
Reset | uint32 | CIM_LogicalDevice
RestoreProperties | uint32 | CIM_LogicalDevice
SaveProperties | uint32 | CIM_LogicalDevice
SetPowerState | uint32 | CIM_LogicalDevice