com.facebook.battery.metrics.devicebattery

Class DeviceBatteryMetrics

java.lang.Object

com.facebook.battery.metrics.api.SystemMetrics<DeviceBatteryMetrics>

com.facebook.battery.metrics.devicebattery.DeviceBatteryMetrics

All Implemented Interfaces:

java.io.Serializable

public class DeviceBatteryMetrics
extends SystemMetrics<DeviceBatteryMetrics>

This class contains the metrics for measuring the device level battery metrics. This is cheap to record and can be a useful addition to modeled battery drain. We also measure the time spent on battery and while charging since the start of the app

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	batteryLevelPct
long	batteryRealtimeMs
long	chargingRealtimeMs

Constructor Summary

Constructors

Constructor and Description
DeviceBatteryMetrics()

Method Summary

Modifier and Type	Method and Description
DeviceBatteryMetrics	diff(DeviceBatteryMetrics b, DeviceBatteryMetrics output) Subtract the object passed in from the current object.
boolean	equals(java.lang.Object o)
int	hashCode()
DeviceBatteryMetrics	set(DeviceBatteryMetrics metrics) Sets all fields in this to values from the SystemMetrics object passed in: a _deep_ copy that shouldn't share any values with other metrics objects.
DeviceBatteryMetrics	sum(DeviceBatteryMetrics b, DeviceBatteryMetrics output) Add values from the SystemMetrics object passed in and sets them on the output object, if available.
java.lang.String	toString()

Methods inherited from class com.facebook.battery.metrics.api.SystemMetrics

diff, sum

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

batteryLevelPct

public float batteryLevelPct

batteryRealtimeMs

public long batteryRealtimeMs

chargingRealtimeMs

public long chargingRealtimeMs

Constructor Detail

DeviceBatteryMetrics

public DeviceBatteryMetrics()

Method Detail

set

public DeviceBatteryMetrics set(DeviceBatteryMetrics metrics)

Description copied from class: SystemMetrics

Sets all fields in this to values from the SystemMetrics object passed in: a _deep_ copy that shouldn't share any values with other metrics objects.

Specified by:

set in class SystemMetrics<DeviceBatteryMetrics>

Returns:

this

sum

public DeviceBatteryMetrics sum(@Nullable
                                DeviceBatteryMetrics b,
                                @Nullable
                                DeviceBatteryMetrics output)

Description copied from class: SystemMetrics

Add values from the SystemMetrics object passed in and sets them on the output object, if available. Does not modify the original object. For convenience, this function accepts null values and will allocate an output object if none is passed in.

Specified by:

sum in class SystemMetrics<DeviceBatteryMetrics>

Returns:

output set to (this + b)

diff

public DeviceBatteryMetrics diff(@Nullable
                                 DeviceBatteryMetrics b,
                                 @Nullable
                                 DeviceBatteryMetrics output)

Description copied from class: SystemMetrics

Subtract the object passed in from the current object. Does not modify the original object. For convenience, this function accepts null values and will allocate an output object if none is passed in.

Specified by:

diff in class SystemMetrics<DeviceBatteryMetrics>

Returns:

output set to (this - b)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object