Skip to content
CARP Documentation

BatteryState

Battery level and charging status of the phone.

Collected by BatteryProbe for the DeviceSamplingPackage.BATTERY_STATE measure. batteryStatus holds one of the STATE_* constants.

Inheritance
Annotations

Constructors

BatteryState.fromBatteryState

BatteryState.fromBatteryState(
  1. int level,
  2. BatteryState state
)

Creates a BatteryState from a battery level and a battery_plus state.

BatteryState.fromJson

BatteryState.fromJson(
  1. Map<String, dynamic> json
)

BatteryState

BatteryState([
  1. int? batteryLevel,
  2. String? batteryStatus
])

Constants

STATE_CHARGING

String const STATE_CHARGING

STATE_CONNECTED_NOT_CHARGING

String const STATE_CONNECTED_NOT_CHARGING

STATE_DISCHARGING

String const STATE_DISCHARGING

STATE_FULL

String const STATE_FULL

STATE_UNKNOWN

String const STATE_UNKNOWN

Properties

batteryLevel

int? batteryLevel
getter/setter pair

The battery level in percent (0-100).

batteryStatus

String? batteryStatus
getter/setter pair

The charging status of the battery:

  • full
  • charging
  • discharging
  • connectedNotCharging
  • unknown

fromJsonFunction

Function get fromJsonFunction
override

The function which can convert a JSON string to an object of this type.

hashCode

int get hashCode
override

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Methods

equivalentTo

bool equivalentTo(
  1. Data other
)
override

Returns true if the batteryLevel is equal.

toJson

Map<String, dynamic> toJson()
override

Return a JSON encoding of this object.

Operators

operator ==

bool operator ==(
  1. Object other
)
override

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

  • Total: It must return a boolean for all arguments. It should never throw.

  • Reflexive: For all objects o, o == o must be true.

  • Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

  • Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.