/*
* Copyright (C) 2012 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.telephony;
import android.os.Parcel;
import android.os.Parcelable;
import android.telephony.Rlog;
/**
* Wcdma signal strength related information.
*/
public final class CellSignalStrengthWcdma extends CellSignalStrength implements Parcelable {
private static final String LOG_TAG = "CellSignalStrengthWcdma";
private static final boolean DBG = false;
private static final int WCDMA_SIGNAL_STRENGTH_GREAT = 12;
private static final int WCDMA_SIGNAL_STRENGTH_GOOD = 8;
private static final int WCDMA_SIGNAL_STRENGTH_MODERATE = 5;
private int mSignalStrength; // Valid values are (0-31, 99) as defined in TS 27.007 8.5
private int mBitErrorRate; // bit error rate (0-7, 99) as defined in TS 27.007 8.5
/**
* Empty constructor
*
* @hide
*/
public CellSignalStrengthWcdma() {
setDefaultValues();
}
/**
* Constructor
*
* @hide
*/
public CellSignalStrengthWcdma(int ss, int ber) {
initialize(ss, ber);
}
/**
* Copy constructors
*
* @param s Source SignalStrength
*
* @hide
*/
public CellSignalStrengthWcdma(CellSignalStrengthWcdma s) {
copyFrom(s);
}
/**
* Initialize all the values
*
* @param ss SignalStrength as ASU value
* @param ber is Bit Error Rate
*
* @hide
*/
public void initialize(int ss, int ber) {
mSignalStrength = ss;
mBitErrorRate = ber;
}
/**
* @hide
*/
protected void copyFrom(CellSignalStrengthWcdma s) {
mSignalStrength = s.mSignalStrength;
mBitErrorRate = s.mBitErrorRate;
}
/**
* @hide
*/
@Override
public CellSignalStrengthWcdma copy() {
return new CellSignalStrengthWcdma(this);
}
/** @hide */
@Override
public void setDefaultValues() {
mSignalStrength = Integer.MAX_VALUE;
mBitErrorRate = Integer.MAX_VALUE;
}
/**
* Get signal level as an int from 0..4
*/
@Override
public int getLevel() {
int level;
// ASU ranges from 0 to 31 - TS 27.007 Sec 8.5
// asu = 0 (-113dB or less) is very weak
// signal, its better to show 0 bars to the user in such cases.
// asu = 99 is a special case, where the signal strength is unknown.
int asu = mSignalStrength;
if (asu <= 2 || asu == 99) level = SIGNAL_STRENGTH_NONE_OR_UNKNOWN;
else if (asu >= WCDMA_SIGNAL_STRENGTH_GREAT) level = SIGNAL_STRENGTH_GREAT;
else if (asu >= WCDMA_SIGNAL_STRENGTH_GOOD) level = SIGNAL_STRENGTH_GOOD;
else if (asu >= WCDMA_SIGNAL_STRENGTH_MODERATE) level = SIGNAL_STRENGTH_MODERATE;
else level = SIGNAL_STRENGTH_POOR;
if (DBG) log("getLevel=" + level);
return level;
}
/**
* Get the signal strength as dBm
*/
@Override
public int getDbm() {
int dBm;
int level = mSignalStrength;
int asu = (level == 99 ? Integer.MAX_VALUE : level);
if (asu != Integer.MAX_VALUE) {
dBm = -113 + (2 * asu);
} else {
dBm = Integer.MAX_VALUE;
}
if (DBG) log("getDbm=" + dBm);
return dBm;
}
/**
* Get the signal level as an asu value between 0..31, 99 is unknown
* Asu is calculated based on 3GPP RSRP. Refer to 3GPP 27.007 (Ver 10.3.0) Sec 8.69
*/
@Override
public int getAsuLevel() {
// ASU ranges from 0 to 31 - TS 27.007 Sec 8.5
// asu = 0 (-113dB or less) is very weak
// signal, its better to show 0 bars to the user in such cases.
// asu = 99 is a special case, where the signal strength is unknown.
int level = mSignalStrength;
if (DBG) log("getAsuLevel=" + level);
return level;
}
@Override
public int hashCode() {
int primeNum = 31;
return (mSignalStrength * primeNum) + (mBitErrorRate * primeNum);
}
@Override
public boolean equals (Object o) {
CellSignalStrengthWcdma s;
try {
s = (CellSignalStrengthWcdma) o;
} catch (ClassCastException ex) {
return false;
}
if (o == null) {
return false;
}
return mSignalStrength == s.mSignalStrength && mBitErrorRate == s.mBitErrorRate;
}
/**
* @return string representation.
*/
@Override
public String toString() {
return "CellSignalStrengthWcdma:"
+ " ss=" + mSignalStrength
+ " ber=" + mBitErrorRate;
}
/** Implement the Parcelable interface */
@Override
public void writeToParcel(Parcel dest, int flags) {
if (DBG) log("writeToParcel(Parcel, int): " + toString());
dest.writeInt(mSignalStrength);
dest.writeInt(mBitErrorRate);
}
/**
* Construct a SignalStrength object from the given parcel
* where the token is already been processed.
*/
private CellSignalStrengthWcdma(Parcel in) {
mSignalStrength = in.readInt();
mBitErrorRate = in.readInt();
if (DBG) log("CellSignalStrengthWcdma(Parcel): " + toString());
}
/** Implement the Parcelable interface */
@Override
public int describeContents() {
return 0;
}
/** Implement the Parcelable interface */
@SuppressWarnings("hiding")
public static final Parcelable.Creator<CellSignalStrengthWcdma> CREATOR =
new Parcelable.Creator<CellSignalStrengthWcdma>() {
@Override
public CellSignalStrengthWcdma createFromParcel(Parcel in) {
return new CellSignalStrengthWcdma(in);
}
@Override
public CellSignalStrengthWcdma[] newArray(int size) {
return new CellSignalStrengthWcdma[size];
}
};
/**
* log
*/
private static void log(String s) {
Rlog.w(LOG_TAG, s);
}
}