Package org.metricshub.ipmi.client.model

Class Sensor

java.lang.Object

org.metricshub.ipmi.client.model.Sensor

public class Sensor
extends Object

Wraps Sensor information:

• The Sensor record which can be either CompactSensorRecord or FullSensorRecord. Note that the compact sensor record is used to discover and collect the state of the devices, where the full sensor record is used to collect the devices reading values, i.e. temperature, power consumption, voltage, ...etc.
• The sensor reading response data wrapping the reading value
• The states of the sensor record formatted as the following: $sensorName=$state|$sensorName=$state|...|$sensorName=$state

Constructor Summary

Constructors

Constructor	Description
Sensor(SensorRecord sensorRecord, GetSensorReadingResponseData data, String states)

Method Summary

Modifier and Type	Method	Description
GetSensorReadingResponseData	getData()
Byte	getDeviceId()	Get the device identifier
EntityId	getEntityId()	Get the EntityId from the current SensorRecord record; instance
String	getName()	Get the name of the sensor record
SensorRecord	getRecord()
String	getStates()
boolean	isCompact()
boolean	isFull()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Sensor

public Sensor(SensorRecord sensorRecord,
 GetSensorReadingResponseData data,
 String states)

Method Details

getRecord

public SensorRecord getRecord()

getData

public GetSensorReadingResponseData getData()

isCompact

public boolean isCompact()

isFull

public boolean isFull()

getEntityId

public EntityId getEntityId()

Get the EntityId from the current SensorRecord record; instance

Returns:

EntityId instance

getDeviceId

public Byte getDeviceId()

Get the device identifier

Returns:

Byte value or null if the type of the sensor cannot be detected.

getName

public String getName()

Get the name of the sensor record

Returns:

String value

getStates

public String getStates()

Returns:

state values formatted as: $sensorName=$state|$sensorName=$state...|$sensorName=$state