MeasurementLocation.java

Go to the documentation of this file.

package org.matsim.counts;

import org.matsim.api.core.v01.Coord;
import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.TransportMode;
import org.matsim.utils.objectattributes.attributable.Attributable;
import org.matsim.utils.objectattributes.attributable.Attributes;
import org.matsim.utils.objectattributes.attributable.AttributesImpl;

import javax.annotation.Nullable;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;

public final class MeasurementLocation<T> implements Attributable, Iterable<MeasurementLocation.TypeAndMode> {

    static final String ELEMENT_NAME = "location";

    private final Id<T> refId;
    private final Map<TypeAndMode, Measurable> measurables = new LinkedHashMap<>();
    private final Attributes attributes = new AttributesImpl();

    private String id;
    private String stationName;
    private String description;
    private Coord coordinates;

    MeasurementLocation(final Id<T> refId, String stationName) {
        this.refId = refId;
        this.stationName = stationName;
    }

    public Id<T> getRefId() {
        return refId;
    }

    public String getId() {
        return id;
    }

    @Override
    public Attributes getAttributes() {
        return attributes;
    }

    public Measurable createMeasurable(String typeOfMeasurableData, String mode, int interval) {
        return measurables.computeIfAbsent(new TypeAndMode(typeOfMeasurableData, mode),
            k -> new Measurable(mode, typeOfMeasurableData, interval));
    }

    public boolean deleteMeasurable(String typeOfMeasurableData, String mode) {
        return this.measurables.remove(new TypeAndMode(typeOfMeasurableData, mode)) != null;
    }

    public Measurable createVolume() {
        return createMeasurable(Measurable.VOLUMES, TransportMode.car, Measurable.HOURLY);
    }

    public Measurable createVolume(String mode) {
        return createMeasurable(Measurable.VOLUMES, mode, Measurable.HOURLY);
    }

    public Measurable createVolume(String mode, int interval) {
        return createMeasurable(Measurable.VOLUMES, mode, interval);
    }

    public Measurable createVelocity(String mode, int interval) {
        return createMeasurable(Measurable.VELOCITIES, mode, interval);
    }

    public Measurable createPassengerCounts(String mode, int interval) {
        return createMeasurable(Measurable.PASSENGERS, mode, interval);
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    public String getStationName() {
        return stationName;
    }

    public String getDisplayName() {
        if (stationName != null)
            return stationName;
        if (id != null)
            return id;

        return description;
    }

    public void setId(String id) {
        this.id = id;
    }

    public void setStationName(String stationName) {
        this.stationName = stationName;
    }

    public Coord getCoordinates() {
        return coordinates;
    }

    public void setCoordinates(Coord coordinates) {
        this.coordinates = coordinates;
    }

    public Measurable getVolumesForMode(String mode) {
        return this.measurables.get(new TypeAndMode(Measurable.VOLUMES, mode));
    }

    public boolean hasMeasurableForMode(String measurableType, String mode) {
        return this.measurables.containsKey(new TypeAndMode(measurableType, mode));
    }

    @Nullable
    public Measurable getMeasurableForMode(String measurableType, String mode) {
        return this.measurables.get(new TypeAndMode(measurableType, mode));
    }

    Map<TypeAndMode, Measurable> getMeasurables() {
        return this.measurables;
    }

    @Override
    public String toString() {
        return "MeasurementLocation{" +
            "id=" + refId +
            ", stationName='" + stationName + '\'' +
            '}';
    }

    @Override
    public Iterator<TypeAndMode> iterator() {
        return this.measurables.keySet().iterator();
    }

    public final record TypeAndMode(String type, String mode) {
    }

}