LegImpl.java

Go to the documentation of this file.

/* *********************************************************************** *
 * project: org.matsim.*
 * Leg.java
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 * copyright       : (C) 2007, 2008 by the members listed in the COPYING,  *
 *                   LICENSE and WARRANTY file.                            *
 * email           : info at matsim dot org                                *
 *                                                                         *
 * *********************************************************************** *
 *                                                                         *
 *   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.                                   *
 *   See also COPYING, LICENSE and WARRANTY file                           *
 *                                                                         *
 * *********************************************************************** */

package org.matsim.core.population;

import org.matsim.api.core.v01.population.Leg;
import org.matsim.api.core.v01.population.Route;
import org.matsim.core.router.TripStructureUtils;
import org.matsim.core.utils.misc.OptionalTime;
import org.matsim.core.utils.misc.Time;
import org.matsim.utils.objectattributes.attributable.Attributes;
import org.matsim.utils.objectattributes.attributable.LazyAllocationAttributes;

/* deliberately package */ final class LegImpl implements Leg {

    private static final double UNDEFINED_TIME = Double.NEGATIVE_INFINITY;

    private Route route = null;

    private double depTime = UNDEFINED_TIME;
    private double travTime = UNDEFINED_TIME;
    private String mode;
    private String routingMode;

    private Attributes attributes = null;

    /* deliberately package */ LegImpl(final String transportMode) {
        this.mode = transportMode;
    }


    private static OptionalTime asOptionalTime(double seconds) {
        return seconds == UNDEFINED_TIME ? OptionalTime.undefined() : OptionalTime.defined(seconds);
    }

    @Override
    public String getMode() {
        return this.mode;
    }

    @Override
    public final void setMode(String transportMode) {
        this.mode = transportMode == null ? null : transportMode.intern();
        TripStructureUtils.setRoutingMode( this, null );
//      TripStructureUtils.setRoutingMode( this, null ); // setting routingMode to null leads to exceptions in AttributesXmlWriterDelegate.writeAttributes() : Class<?> clazz = objAttribute.getValue().getClass();
        // (yyyy or maybe "transportMode" instead of "null"?? kai, oct'19)
    }

    @Override
    public final String getRoutingMode() {
        return this.routingMode;
    }

    @Override
    public final void setRoutingMode(String routingMode) {
        this.routingMode = routingMode == null ? null : routingMode.intern();
    }

    @Override
    public OptionalTime getDepartureTime() {
        return asOptionalTime(this.depTime);
    }

    @Override
    public void setDepartureTime(final double depTime) {
        OptionalTime.assertDefined(depTime);
        this.depTime = depTime;
    }

    @Override
    public void setDepartureTimeUndefined() {
        this.depTime = UNDEFINED_TIME;
    }

    @Override
    public OptionalTime getTravelTime() {
        return asOptionalTime(this.travTime);
    }

    @Override
    public void setTravelTime(final double travTime) {
        OptionalTime.assertDefined(travTime);
        this.travTime = travTime;
    }

    @Override
    public void setTravelTimeUndefined() {
        this.travTime = UNDEFINED_TIME;
    }

    @Override
    public Route getRoute() {
        return this.route;
    }

    @Override
    public void setRoute(Route route) {
        this.route = route;
    }

    @Override
    public String toString() {
        return "leg [mode="
                + this.getMode()
                + "]"
                + "[depTime="
                + Time.writeTime(this.getDepartureTime())
                + "]"
                + "[travTime="
                + Time.writeTime(this.getTravelTime())
                + "]"
                + "[arrTime="
                + (getDepartureTime().isDefined() && getTravelTime().isDefined() ?
                Time.writeTime(getDepartureTime().seconds() + getTravelTime().seconds()) :
                Time.writeTime(OptionalTime.undefined()))
                + "]"
                + "[route="
                + this.route
                + "]";
    }


    @Override
    public Attributes getAttributes() {
        if (this.attributes != null) {
            return this.attributes;
        }
        return new LazyAllocationAttributes(attributes -> this.attributes = attributes, () -> this.attributes);
    }

    //  private boolean locked;
//
//  public void setLocked() {
//      this.locked = true ;
//  }
//  private void testForLocked() {
//      if ( this.locked ) {
//          throw new RuntimeException("too late to change this") ;
//      }
//  }

}