Laptime.java

/**
 * Copyright (C) 2009-2014 Cars and Tracks Development Project (CTDP).
 * 
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
package net.ctdp.rfdynhud.gamedata;

/**
 * Model for a lap time for a single lap.
 * 
 * @author Marvin Froehlich (CTDP)
 */
public class Laptime
{
    /**
     * The type of a lap.
     * 
     * @author Marvin Froehlich
     */
    public static enum LapType
    {
        UNKNOWN,
        NORMAL,
        HOTLAP,
        QUALIFY,
        RACE,
        ;
    }
    
    private final int driverId;
    
    private LapType type = LapType.UNKNOWN;
    int lap;
    float sector1 = -1f;
    float sector2 = -1f;
    float sector3 = -1f;
    float laptime = -1f;
    
    boolean isOutLap = false;
    Boolean isInLap = null;
    boolean finished = false;
    
    public final int getDriverId()
    {
        return ( driverId );
    }
    
    void setType( LapType type )
    {
        this.type = type;
    }
    
    public final LapType getType()
    {
        return ( type );
    }
    
    public final int getLap()
    {
        return ( lap );
    }
    
    void updateLaptimeFromSectors()
    {
        if ( ( sector1 < 0f ) || ( sector2 < 0f ) || ( sector3 < 0f ) )
            laptime = -1f;
        else
            laptime = sector1 + sector2 + sector3;
    }
    
    public final float getSector1()
    {
        return ( sector1 );
    }
    
    public final float getSector2()
    {
        return ( sector2 );
    }
    
    public final float getSector1And2()
    {
        if ( ( sector1 <= 0f ) || ( sector2 <= 0f ) )
            return ( -1f );
        
        return ( sector1 + sector2 );
    }
    
    public final float getSector2( boolean includingSector1 )
    {
        if ( includingSector1 )
            return ( getSector1And2() );
        
        return ( getSector2() );
    }
    
    public final float getSector3()
    {
        return ( sector3 );
    }
    
    public final float getLapTime()
    {
        return ( laptime );
    }
    
    /**
     * Gets whether this lap is an outlap. If this information is not yet available, null is returned.
     * 
     * @return whether this lap is an outlap. If this information is not yet available, null is returned.
     */
    public final Boolean isOutlap()
    {
        return ( isOutLap );
    }
    
    /**
     * Gets whether this lap is an inlap. If this information is not yet available, null is returned.
     * 
     * @return whether this lap is an inlap. If this information is not yet available, null is returned.
     */
    public final Boolean isInlap()
    {
        return ( isInLap );
    }
    
    public final boolean isFinished()
    {
        return ( finished );
    }
    
    /**
     * {@inheritDoc}
     */
    @Override
    public String toString()
    {
        return ( "lap: " + getLap() + ", sec1: " + getSector1() + ", sec2: " + getSector2() + ", sec3: " + getSector3() + ", laptime: " + getLapTime() + ( isOutlap() == Boolean.TRUE ? ", OUTLAP" : ( isOutlap() == null ? ", UNKNOWN" : ", REGULAR" ) ) + ( isInlap() == Boolean.TRUE ? ", INLAP" : ( isInlap() == null ? ", UNKNOWN" : ", REGULAR" ) ) );
    }
    
    public Laptime( int driverId, int lap )
    {
        this.driverId = driverId;
        this.lap = lap;
    }
    
    public Laptime( int driverId, int lap, float sector1, float sector2, float sector3, boolean isOutLap, boolean isInLap, boolean finished )
    {
        this.driverId = driverId;
        this.lap = lap;
        this.sector1 = sector1;
        this.sector2 = sector2;
        this.sector3 = sector3;
        this.isOutLap = isOutLap;
        this.isInLap = isInLap;
        this.finished = finished;
        
        updateLaptimeFromSectors();
    }
    
    static final boolean isHotlap( LiveGameData gameData )
    {
        float fuelUsage = ( gameData.getTelemetryData().getFuelUsageLastLapL() > 0f ) ? gameData.getTelemetryData().getFuelUsageLastLapL() : gameData.getTelemetryData().getFuelUsageAverageL();
        
        return ( ( fuelUsage > 0f ) && gameData.getSetup().isUpdatedInTimeScope() && ( gameData.getSetup().getGeneral().getFuel( 0 ) / fuelUsage < 7.0f ) );
    }
}