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

NameData TypeValue
DescriptionstringA Numeric Sensor is capable of returning numeric readings and optionally supports thresholds settings.
UMLPackagePathstringCIM::Device::Sensors
Versionstring2.16.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
Accuracysint32
DescriptionstringIndicates 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.19, MIF.DMTF|Electrical Current Probe|001.19, MIF.DMTF|Voltage Probe|001.19
PUnitstringpercent * 10^-2
UnitsstringHundredths of Percent
BaseUnitsuint16
DescriptionstringThe 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.
ModelCorrespondencestringCIM_NumericSensor.UnitModifier, CIM_NumericSensor.RateUnits
ValueMapstring0, 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
ValuesstringUnknown, 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
CurrentReadingsint32
DescriptionstringThe current value indicated by the Sensor.
MappingStringsstringMIF.DMTF|Temperature Probe|002.5, MIF.DMTF|Electrical Current Probe|001.5, MIF.DMTF|Voltage Probe|001.5
Hysteresisuint32
DescriptionstringIndicates 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.
IsLinearboolean
DescriptionstringIndicates that the Sensor is linear over its dynamic range.
LowerThresholdCriticalsint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.13, MIF.DMTF|Electrical Current Probe|001.13, MIF.DMTF|Voltage Probe|001.13
Writebooleantrue
LowerThresholdFatalsint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.15, MIF.DMTF|Electrical Current Probe|001.15, MIF.DMTF|Voltage Probe|001.15
Writebooleantrue
LowerThresholdNonCriticalsint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.11, MIF.DMTF|Electrical Current Probe|001.11, MIF.DMTF|Voltage Probe|001.11
Writebooleantrue
MaxReadablesint32
DescriptionstringMaxReadable indicates the largest value of the measured property that can be read by the NumericSensor.
MappingStringsstringMIF.DMTF|Temperature Probe|002.9, MIF.DMTF|Electrical Current Probe|001.9, MIF.DMTF|Voltage Probe|001.9
MinReadablesint32
DescriptionstringMinReadable indicates the smallest value of the measured property that can be read by the NumericSensor.
MappingStringsstringMIF.DMTF|Temperature Probe|002.10, MIF.DMTF|Electrical Current Probe|001.10, MIF.DMTF|Voltage Probe|001.10
NominalReadingsint32
DescriptionstringNominalReading indicates the 'normal' or expected value for the NumericSensor.
MappingStringsstringMIF.DMTF|Temperature Probe|002.6, MIF.DMTF|Electrical Current Probe|001.6, MIF.DMTF|Voltage Probe|001.6
NormalMaxsint32
DescriptionstringNormalMax provides guidance for the user as to the normal maximum range for the NumericSensor.
MappingStringsstringMIF.DMTF|Temperature Probe|002.7, MIF.DMTF|Electrical Current Probe|001.7, MIF.DMTF|Voltage Probe|001.7
NormalMinsint32
DescriptionstringNormalMin provides guidance for the user as to the normal minimum range for the NumericSensor.
MappingStringsstringMIF.DMTF|Temperature Probe|002.8, MIF.DMTF|Electrical Current Probe|001.8, MIF.DMTF|Voltage Probe|001.8
RateUnitsuint16
DescriptionstringSpecifies 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.
ModelCorrespondencestringCIM_NumericSensor.UnitModifier, CIM_NumericSensor.BaseUnits
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9
ValuesstringNone, Per MicroSecond, Per MilliSecond, Per Second, Per Minute, Per Hour, Per Day, Per Week, Per Month, Per Year
Resolutionuint32
DescriptionstringResolution indicates the ability of the Sensor to resolve differences in the measured property. The units for this measurement are determined by BaseUnit*UnitModifier/RateUnit.
MappingStringsstringMIF.DMTF|Temperature Probe|002.17, MIF.DMTF|Electrical Current Probe|001.17, MIF.DMTF|Voltage Probe|001.17
Tolerancesint32
DeprecatedstringCIM_NumericSensor.Resolution, CIM_NumericSensor.Accuracy
DescriptionstringThis 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.
UnitModifiersint32
DescriptionstringThe 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.
ModelCorrespondencestringCIM_NumericSensor.BaseUnits, CIM_NumericSensor.RateUnits
UpperThresholdCriticalsint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.14, MIF.DMTF|Electrical Current Probe|001.14, MIF.DMTF|Voltage Probe|001.14
Writebooleantrue
UpperThresholdFatalsint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.16, MIF.DMTF|Electrical Current Probe|001.16, MIF.DMTF|Voltage Probe|001.16
Writebooleantrue
UpperThresholdNonCriticalsint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Temperature Probe|002.12, MIF.DMTF|Electrical Current Probe|001.12, MIF.DMTF|Voltage Probe|001.12
Writebooleantrue
EnabledThresholdsuint16[]
DescriptionstringAn array representing the thresholds that are currently enabled for this Sensor.
ValueMapstring0, 1, 2, 3, 4, 5
ValuesstringLowerThresholdNonCritical, UpperThresholdNonCritical, LowerThresholdCritical, UpperThresholdCritical, LowerThresholdFatal, UpperThresholdFatal
SettableThresholdsuint16[]
DescriptionstringAn array representing the writable thresholds supported by Sensor.
ValueMapstring0, 1, 2, 3, 4, 5
ValuesstringLowerThresholdNonCritical, UpperThresholdNonCritical, LowerThresholdCritical, UpperThresholdCritical, LowerThresholdFatal, UpperThresholdFatal
SupportedThresholdsuint16[]
DescriptionstringAn array representing the thresholds supported by this Sensor.
ValueMapstring0, 1, 2, 3, 4, 5
ValuesstringLowerThresholdNonCritical, UpperThresholdNonCritical, LowerThresholdCritical, UpperThresholdCritical, LowerThresholdFatal, UpperThresholdFatal

Inherited Properties

NameData TypeClass Origin
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
CurrentStatestringCIM_Sensor
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherSensorTypeDescriptionstringCIM_Sensor
PollingIntervaluint64CIM_Sensor
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
SensorTypeuint16CIM_Sensor
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PossibleStatesstring[]CIM_Sensor
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

RestoreDefaultThresholds (uint32)

Method Qualifiers (RestoreDefaultThresholds)

NameData TypeValue
DescriptionstringThis 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)

NameTypeQualifiers
NameData TypeValue

GetNonLinearFactors (uint32)

Method Qualifiers (GetNonLinearFactors)

NameData TypeValue
DeprecatedstringNo value
DescriptionstringThe 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)

NameTypeQualifiers
NameData TypeValue
Accuracysint32
DescriptionstringThe accuracy of the reading.
INbooleanfalse
OUTbooleantrue
Hysteresisuint32
DescriptionstringThe Hysteresis of the reading.
INbooleanfalse
OUTbooleantrue
Resolutionuint32
DescriptionstringThe resolution of the reading.
INbooleanfalse
OUTbooleantrue
SensorReadingsint32
DescriptionstringThe sensor reading to get information for.
INbooleantrue
Tolerancesint32
DescriptionstringThe tolerance of the reading.
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice