org.matsim.counts.Measurable Class Reference

Inheritance diagram for org.matsim.counts.Measurable:

Public Member Functions
void	setAtHour (int hour, double value)
void	setAtMinute (int minute, double value)
void	setAtSecond (int seconds, double value)
OptionalDouble	getDailyValue ()
void	setDailyValue (double value)
double	aggregateDaily ()
OptionalDouble	getAtHour (int hour)
boolean	supportsHourlyAggregate ()
OptionalDouble	aggregateAtHour (int hour)
OptionalDouble	getAtSecond (int second)
OptionalDouble	getAtMinute (int minutes)
String	getMode ()
String	getMeasurableType ()
int	getInterval ()
Iterator< Int2DoubleMap.Entry >	iterator ()
int	size ()
boolean	equals (Object o)
int	hashCode ()

Static Public Attributes
static final String	ANY_MODE = "any_vehicle"
static String	VOLUMES = "volumes"
static String	VELOCITIES = "velocities"
static String	PASSENGERS = "passengers"
static int	DAILY = 24 * 60 * 60
static int	HOURLY = 60 * 60
static int	QUARTER_HOURLY = 15 * 60

Private Attributes
final String	type
final String	mode
final Int2DoubleSortedMap	values
final int	interval

Detailed Description

A MeasurementLocation station can hold any kind of measurable data to calibrate a scenario provided as an implementation of this interface. A single instance holds values for only one transport mode. Average velocities and traffic volumes are already implemented.

Definition at line 16 of file Measurable.java.

Member Function Documentation

setAtHour()

void org.matsim.counts.Measurable.setAtHour	(	int	hour,
		double	value
	)

Adds a value observed at a certain hour.

Definition at line 64 of file Measurable.java.

References org.matsim.counts.Measurable.setAtSecond().

Referenced by org.matsim.counts.Measurable.setDailyValue().

                                                  {
        setAtSecond(hour * HOURLY, value);
    }

Here is the call graph for this function:

setAtMinute()

void org.matsim.counts.Measurable.setAtMinute	(	int	minute,
		double	value
	)

Adds a value observed at a certain minute. Note that the minute must match the given interval, for example if the intervall is set to 15 minutes the minute must be something like 15, 30, 45, 300 etc.

Definition at line 72 of file Measurable.java.

References org.matsim.counts.Measurable.setAtSecond().

                                                      {
        setAtSecond(minute * 60, value);
    }

Here is the call graph for this function:

setAtSecond()

void org.matsim.counts.Measurable.setAtSecond	(	int	seconds,
		double	value
	)

Definition at line 76 of file Measurable.java.

Referenced by org.matsim.counts.CountsReaderMatsimV2.addValuesToMeasurable(), org.matsim.counts.Measurable.setAtHour(), and org.matsim.counts.Measurable.setAtMinute().

                                                       {
        if (seconds < 0)
            throw new IllegalArgumentException("Time value starts at 0.");

        if (seconds % this.interval != 0)
            throw new IllegalArgumentException("Time value doesn't match the interval!");

        this.values.put(seconds, value);
    }

getDailyValue()

OptionalDouble org.matsim.counts.Measurable.getDailyValue

(

)

Returns the observed daily value.

Definition at line 89 of file Measurable.java.

References org.matsim.counts.Measurable.getAtHour().

                                          {
        if (interval != DAILY)
            throw new IllegalArgumentException("Does not contain daily values!");

        return getAtHour(0);
    }

Here is the call graph for this function:

setDailyValue()

void org.matsim.counts.Measurable.setDailyValue

(

double

value

)

Definition at line 96 of file Measurable.java.

References org.matsim.counts.Measurable.setAtHour().

                                            {
        if (interval != DAILY)
            throw new IllegalArgumentException("Does not contain daily values!");

        setAtHour(0, value);
    }

Here is the call graph for this function:

aggregateDaily()

double org.matsim.counts.Measurable.aggregateDaily

(

)

Return sum of values or daily value.

Definition at line 106 of file Measurable.java.

                                   {
        if (interval == DAILY)
            return values.get(0);

        return values.values().doubleStream().sum();
    }

getAtHour()

OptionalDouble org.matsim.counts.Measurable.getAtHour

(

int

hour

)

Returns the observed value at a certain hour.

Definition at line 116 of file Measurable.java.

References org.matsim.counts.Measurable.getAtSecond().

Referenced by org.matsim.counts.Measurable.aggregateAtHour(), and org.matsim.counts.Measurable.getDailyValue().

                                              {
        return getAtSecond(hour * HOURLY);
    }

Here is the call graph for this function:

supportsHourlyAggregate()

boolean org.matsim.counts.Measurable.supportsHourlyAggregate

(

)

Whether the interval allows for an hourly aggregation.

Definition at line 123 of file Measurable.java.

References org.matsim.counts.Measurable.interval.

Referenced by org.matsim.counts.Measurable.aggregateAtHour(), org.matsim.counts.Count< T >.Count(), and org.matsim.counts.Count< T >.getVolume().

                                             {
        return (interval <= HOURLY) && (HOURLY % interval) == 0;
    }

aggregateAtHour()

OptionalDouble org.matsim.counts.Measurable.aggregateAtHour

(

int

hour

)

Returns the aggregate for an specific hour. If the resolution does not allow this aggregation an error is thrpwn.

Definition at line 130 of file Measurable.java.

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

Referenced by org.matsim.counts.Count< T >.getVolume().

                                                    {
        if (!supportsHourlyAggregate())
            throw new IllegalArgumentException("Can not aggregate hourly values.");

        if (interval == HOURLY)
            return getAtHour(hour);

        Int2DoubleSortedMap values = this.values.subMap(hour * HOURLY, (hour + 1) * HOURLY);
        if (values.isEmpty())
            return OptionalDouble.empty();

        return OptionalDouble.of(values.values().doubleStream().sum());
    }

Here is the call graph for this function:

getAtSecond()

OptionalDouble org.matsim.counts.Measurable.getAtSecond

(

int

second

)

Definition at line 144 of file Measurable.java.

Referenced by org.matsim.counts.Measurable.getAtHour(), and org.matsim.counts.Measurable.getAtMinute().

                                                  {
        if (values.containsKey(second))
            return OptionalDouble.of(values.get(second));

        return OptionalDouble.empty();
    }

getAtMinute()

OptionalDouble org.matsim.counts.Measurable.getAtMinute

(

int

minutes

)

Returns the observed value at a certain minute.

Definition at line 154 of file Measurable.java.

References org.matsim.counts.Measurable.getAtSecond().

                                                   {
        return getAtSecond(minutes * 60);
    }

Here is the call graph for this function:

getMode()

String org.matsim.counts.Measurable.getMode

(

)

Returns the transport mode of the observed data.

Definition at line 161 of file Measurable.java.

References org.matsim.counts.Measurable.mode.

                            {
        return mode;
    }

getMeasurableType()

String org.matsim.counts.Measurable.getMeasurableType

(

)

Returns the name of the implementation. Information is needed for data writing.

Definition at line 168 of file Measurable.java.

References org.matsim.counts.Measurable.type.

                                      {
        return type;
    }

getInterval()

int org.matsim.counts.Measurable.getInterval

(

)

Definition at line 172 of file Measurable.java.

References org.matsim.counts.Measurable.interval.

Referenced by org.matsim.counts.Count< T >.Count().

                             {
        return interval;
    }

iterator()

Iterator<Int2DoubleMap.Entry> org.matsim.counts.Measurable.iterator

(

)

Iterate over all values as seconds-value pairs.

Definition at line 180 of file Measurable.java.

                                                    {
        return values.int2DoubleEntrySet().iterator();
    }

size()

int org.matsim.counts.Measurable.size

(

)

Number of entries.

Definition at line 187 of file Measurable.java.

Referenced by org.matsim.counts.Count< T >.toString().

                      {
        return values.size();
    }

equals()

boolean org.matsim.counts.Measurable.equals

(

Object

o

)

Definition at line 192 of file Measurable.java.

References org.matsim.counts.Measurable.interval, org.matsim.counts.Measurable.mode, org.matsim.counts.Measurable.type, and org.matsim.counts.Measurable.values.

                                    {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Measurable entries = (Measurable) o;
        return interval == entries.interval && Objects.equals(type, entries.type) && Objects.equals(mode, entries.mode) && Objects.equals(values, entries.values);
    }

hashCode()

int org.matsim.counts.Measurable.hashCode

(

)

Definition at line 200 of file Measurable.java.

                          {
        return Objects.hash(type, mode, values, interval);
    }

Member Data Documentation

ANY_MODE

final String org.matsim.counts.Measurable.ANY_MODE = "any_vehicle"

static

String to denote that the mode includes all vehicles.

Definition at line 21 of file Measurable.java.

Referenced by org.matsim.counts.Count< T >.Count().

VOLUMES

String org.matsim.counts.Measurable.VOLUMES = "volumes"

static

Definition at line 23 of file Measurable.java.

Referenced by org.matsim.counts.Count< T >.Count(), org.matsim.counts.MeasurementLocation<?>.createVolume(), and org.matsim.counts.MeasurementLocation<?>.getVolumesForMode().

VELOCITIES

String org.matsim.counts.Measurable.VELOCITIES = "velocities"

static

Definition at line 24 of file Measurable.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.createVelocity().

PASSENGERS

String org.matsim.counts.Measurable.PASSENGERS = "passengers"

static

Definition at line 25 of file Measurable.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.createPassengerCounts().

DAILY

int org.matsim.counts.Measurable.DAILY = 24 * 60 * 60

static

Daily interval in seconds.

Definition at line 30 of file Measurable.java.

HOURLY

int org.matsim.counts.Measurable.HOURLY = 60 * 60

static

Hourly interval in seconds.

Definition at line 34 of file Measurable.java.

Referenced by org.matsim.counts.Count< T >.Count(), org.matsim.counts.MeasurementLocation<?>.createVolume(), org.matsim.counts.Count< T >.getMaxVolume(), and org.matsim.counts.Count< T >.getVolumes().

QUARTER_HOURLY

int org.matsim.counts.Measurable.QUARTER_HOURLY = 15 * 60

static

Quarter hourly interval in seconds.

Definition at line 38 of file Measurable.java.

type

final String org.matsim.counts.Measurable.type

private

Definition at line 40 of file Measurable.java.

Referenced by org.matsim.counts.Measurable.equals(), and org.matsim.counts.Measurable.getMeasurableType().

mode

final String org.matsim.counts.Measurable.mode

private

Definition at line 41 of file Measurable.java.

Referenced by org.matsim.counts.Measurable.equals(), and org.matsim.counts.Measurable.getMode().

values

final Int2DoubleSortedMap org.matsim.counts.Measurable.values

private

Definition at line 43 of file Measurable.java.

Referenced by org.matsim.counts.Measurable.equals().

interval

final int org.matsim.counts.Measurable.interval

private

Measurement interval in minutes.

Definition at line 48 of file Measurable.java.

Referenced by org.matsim.counts.Measurable.equals(), org.matsim.counts.Measurable.getInterval(), and org.matsim.counts.Measurable.supportsHourlyAggregate().

---

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

• counts/Measurable.java