/*
 * Geopaparazzi - Digital field mapping on Android based devices
 * Copyright (C) 2016  HydroloGIS (www.hydrologis.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package eu.geopaparazzi.library.gps;

/**
 * Enum defining possible status of the {@link GpsService}.
 * 
 * @author Andrea Antonello (www.hydrologis.com)
 */
public enum GpsLoggingStatus {
    /**
     * GPS is not logging data to the database.
     */
    GPS_DATABASELOGGING_OFF(0),
    /**
     * GPS is logging data to the database.
     */
    GPS_DATABASELOGGING_ON(1);

    private int code;

    private GpsLoggingStatus( int code ) {
        this.code = code;
    }

    /**
     * @return the code of this status.
     */
    public int getCode() {
        return code;
    }

    /**
     * Get the {@link GpsLoggingStatus} for a given code.
     * 
     * @param code the code to check.
     * @return the status.
     */
    public static GpsLoggingStatus getStatusForCode( int code ) {
        GpsLoggingStatus[] values = values();
        for( GpsLoggingStatus gpsServiceStatus : values ) {
            if (code == gpsServiceStatus.getCode()) {
                return gpsServiceStatus;
            }
        }
        throw new IllegalArgumentException("No service status available for code: " + code); //$NON-NLS-1$
    }
}