org.matsim.counts.Count< T > Class Template Reference

Inheritance diagram for org.matsim.counts.Count< T >:

Public Member Functions
final Volume	createVolume (final int h, final double val)
final void	setCsId (final String cs_id)
final Id< T >	getId ()
final String	getCsLabel ()
final Volume	getMaxVolume ()
final Volume	getVolume (final int h)
final HashMap< Integer, Volume >	getVolumes ()
Coord	getCoord ()
void	setCoord (final Coord coord)
final String	toString ()

Protected Member Functions
	Count (MeasurementLocation< T > v)

Private Attributes
final MeasurementLocation< T >	location
final Measurable	volume

Static Private Attributes
static final Logger	log = LogManager.getLogger(Counts.class)

Detailed Description

This class is a wrapper around the newer MeasurementLocation.

Parameters

<T>

Definition at line 40 of file Count.java.

Constructor & Destructor Documentation

Count()

org.matsim.counts.Count< T >.Count ( MeasurementLocation< T >  v )

protected

Definition at line 48 of file Count.java.

References org.matsim.counts.Measurable.ANY_MODE, org.matsim.api.core.v01.TransportMode.car, org.matsim.counts.MeasurementLocation< T >.createVolume(), org.matsim.counts.Measurable.getInterval(), org.matsim.counts.MeasurementLocation< T >.hasMeasurableForMode(), org.matsim.counts.Measurable.HOURLY, org.matsim.counts.Measurable.supportsHourlyAggregate(), and org.matsim.counts.Measurable.VOLUMES.

                                              {
        this.location = v;

        String mode;
        if (location.hasMeasurableForMode(Measurable.VOLUMES, Measurable.ANY_MODE))
            mode = Measurable.ANY_MODE;
        else
            mode = TransportMode.car;

        // Counts only support hourly volumes
        this.volume = location.createVolume(mode, Measurable.HOURLY);

        if (!this.volume.supportsHourlyAggregate()) {
            log.warn("Unsupported counts interval '" + this.volume.getInterval() + "' for analysis functionality. " +
                "Interval should be able to aggregate hourly, otherwise counts will be empty");
        }
    }

Here is the call graph for this function:

Member Function Documentation

createVolume()

final Volume org.matsim.counts.Count< T >.createVolume	(	final int	h,
		final double	val
	)

Creates and adds a Volume to the Counting station.

Parameters

h	indicating the hour-of-day. Note: the hours for a counting station must be from 1-24, and not from 0-23, otherwise the MatsimCountsReader will throw an error.
val	the total number of vehicles counted during hour h.

Returns

the Counting station's Volume.

Definition at line 76 of file Count.java.

Referenced by org.matsim.counts.CountsReaderMatsimV1.startVolume().

                                                                    {
        if (h < 1) {
            throw new RuntimeException("counts start at 1, not at 0.  If you have a use case where you need to go below one, "
                + "let us know and we think about it, but so far we had numerous debugging sessions because someone inserted counts at 0.");
        }

        Volume v = new Volume(h, val);

        // Only hourly volumes can be set
        if (this.volume.getInterval() == Measurable.HOURLY)
            this.volume.setAtHour(h - 1, val);
        else
            log.warn("Unsupported counts '" + this.volume.getInterval() + "' for setting values. Resolution must be hourly.");

        return v;
    }

setCsId()

final void org.matsim.counts.Count< T >.setCsId

(

final String

cs_id

)

Definition at line 93 of file Count.java.

References org.matsim.counts.MeasurementLocation< T >.setStationName().

                                                  {
        location.setStationName(cs_id);
    }

Here is the call graph for this function:

getId()

final Id<T> org.matsim.counts.Count< T >.getId

(

)

Implements org.matsim.api.core.v01.Identifiable< T >.

Definition at line 98 of file Count.java.

References org.matsim.counts.MeasurementLocation< T >.getRefId().

Referenced by org.matsim.counts.algorithms.CountsComparisonAlgorithm.setDistanceFilter().

                               {
        return location.getRefId();
    }

Here is the call graph for this function:

getCsLabel()

final String org.matsim.counts.Count< T >.getCsLabel

(

)

Definition at line 102 of file Count.java.

References org.matsim.counts.MeasurementLocation< T >.getStationName().

                                     {
        return location.getStationName();
    }

Here is the call graph for this function:

getMaxVolume()

final Volume org.matsim.counts.Count< T >.getMaxVolume

(

)

Definition at line 106 of file Count.java.

References org.matsim.counts.Measurable.HOURLY.

                                       {
        int hour = -1;
        double max = -1.0;
        for (Int2DoubleMap.Entry e : this.volume) {
            if (e.getDoubleValue() > max) {
                max = e.getDoubleValue();
                hour = e.getIntKey() / Measurable.HOURLY;
            }
        }
        return hour >= 0 ? new Volume(hour + 1, max) : null;
    }

getVolume()

final Volume org.matsim.counts.Count< T >.getVolume

(

final int

h

)

Definition at line 118 of file Count.java.

References org.matsim.counts.Measurable.aggregateAtHour(), and org.matsim.counts.Measurable.supportsHourlyAggregate().

                                               {
        if (this.volume.supportsHourlyAggregate()) {
            // Uses old format where hours starts at 1
            OptionalDouble v = this.volume.aggregateAtHour(h - 1);
            return v.isPresent() ? new Volume(h, v.getAsDouble()) : null;
        }

        return null;
    }

Here is the call graph for this function:

getVolumes()

final HashMap<Integer, Volume> org.matsim.counts.Count< T >.getVolumes

(

)

Definition at line 128 of file Count.java.

References org.matsim.counts.Measurable.HOURLY.

                                                       {
        HashMap<Integer, Volume> res = new HashMap<>();
        for (Int2DoubleMap.Entry e : volume) {
            // Offset for old API
            int h = (e.getIntKey() / Measurable.HOURLY) + 1;
            res.put(h, new Volume(h, e.getDoubleValue()));
        }

        return res;
    }

getCoord()

Coord org.matsim.counts.Count< T >.getCoord

(

)

Returns

Returns the exact coordinate, where this counting station is located, or null if no exact location is available.

Definition at line 143 of file Count.java.

References org.matsim.counts.MeasurementLocation< T >.getCoordinates().

Referenced by org.matsim.counts.algorithms.CountsComparisonAlgorithm.setCountCoordUsingDistanceFilter().

                            {
        return location.getCoordinates();
    }

Here is the call graph for this function:

setCoord()

void org.matsim.counts.Count< T >.setCoord

(

final Coord

coord

)

Definition at line 147 of file Count.java.

References org.matsim.counts.MeasurementLocation< T >.setCoordinates().

Referenced by org.matsim.counts.CountsReaderMatsimV1.startCount().

                                            {
        location.setCoordinates(coord);
    }

Here is the call graph for this function:

toString()

final String org.matsim.counts.Count< T >.toString

(

)

Definition at line 152 of file Count.java.

References org.matsim.counts.MeasurementLocation< T >.getId(), org.matsim.counts.MeasurementLocation< T >.getStationName(), and org.matsim.counts.Measurable.size().

                                   {
        return "[Loc_id=" + this.location.getId() + "]" +
            "[cs_id=" + this.location.getStationName() + "]" +
            "[nof_volumes=" + this.volume.size() + "]";
    }

Here is the call graph for this function:

Member Data Documentation

log

final Logger org.matsim.counts.Count< T >.log = LogManager.getLogger(Counts.class)

staticprivate

Definition at line 43 of file Count.java.

location

final MeasurementLocation<T> org.matsim.counts.Count< T >.location

private

Definition at line 45 of file Count.java.

volume

final Measurable org.matsim.counts.Count< T >.volume

private

Definition at line 46 of file Count.java.

---

The documentation for this class was generated from the following file:

• counts/Count.java