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

Public Member Functions
Id< T >	getRefId ()

String	getId ()

Attributes	getAttributes ()

Measurable	createMeasurable (String typeOfMeasurableData, String mode, int interval)

boolean	deleteMeasurable (String typeOfMeasurableData, String mode)

Measurable	createVolume ()

Measurable	createVolume (String mode)

Measurable	createVolume (String mode, int interval)

Measurable	createVelocity (String mode, int interval)

Measurable	createPassengerCounts (String mode, int interval)

String	getDescription ()

void	setDescription (String description)

String	getStationName ()

String	getDisplayName ()

void	setId (String id)

void	setStationName (String stationName)

Coord	getCoordinates ()

void	setCoordinates (Coord coordinates)

Measurable	getVolumesForMode (String mode)

boolean	hasMeasurableForMode (String measurableType, String mode)

Measurable	getMeasurableForMode (String measurableType, String mode)

String	toString ()

Iterator< TypeAndMode >	iterator ()

final record	TypeAndMode (String type, String mode)

Private Attributes
final Id< T >	refId

final Map< TypeAndMode, Measurable >	measurables = new LinkedHashMap<>()

final Attributes	attributes = new AttributesImpl()

String	id

String	stationName

String	description

Coord	coordinates

Detailed Description

A MeasurementLocation can hold measurable traffic stats (traffic volumes or velocities e.g.) for a single matsim infrastructure object. Measurable values are provided as Measurable instances for a certain mode. It is possible to assign the same kind of value to several transport modes. A single MeasurementLocation instance for example can hold traffic volumes for the mode 'car' and average velocities for the mode 'freight'.

Definition at line 21 of file MeasurementLocation.java.

Member Function Documentation

◆ getRefId()

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

Id reference to the matsim infrastructure object.

Definition at line 42 of file MeasurementLocation.java.

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

                             {
         return refId;
     }

◆ getId()

String org.matsim.counts.MeasurementLocation< T >.getId ( )

Id that may be used internally, not corresponding to matsim ids.

Definition at line 49 of file MeasurementLocation.java.

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

                           {
         return id;
     }

◆ getAttributes()

Attributes org.matsim.counts.MeasurementLocation< T >.getAttributes ( )

Implements org.matsim.utils.objectattributes.attributable.Attributable.

Definition at line 54 of file MeasurementLocation.java.

Referenced by org.matsim.counts.CountsReaderMatsimV2.startMeasurementLocation().

                                       {
         return attributes;
     }

◆ createMeasurable()

Measurable org.matsim.counts.MeasurementLocation< T >.createMeasurable	(	String	typeOfMeasurableData,
		String	mode,
		int	interval
	)

Create arbitrary measurable for certain mode and minute interval. If this measurable exists already, it is returned.

Definition at line 61 of file MeasurementLocation.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.createPassengerCounts(), org.matsim.counts.MeasurementLocation<?>.createVelocity(), org.matsim.counts.MeasurementLocation<?>.createVolume(), and org.matsim.counts.CountsReaderMatsimV2.startMeasurable().

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

◆ deleteMeasurable()

boolean org.matsim.counts.MeasurementLocation< T >.deleteMeasurable	(	String	typeOfMeasurableData,
		String	mode
	)

Delete measurable for certain mode.

Definition at line 69 of file MeasurementLocation.java.

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

◆ createVolume() [1/3]

Measurable org.matsim.counts.MeasurementLocation< T >.createVolume ( )

Create hourly volumes for car mode.

Definition at line 76 of file MeasurementLocation.java.

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

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

◆ createVolume() [2/3]

Measurable org.matsim.counts.MeasurementLocation< T >.createVolume ( String mode )

Create hourly values for certain mode.

Definition at line 83 of file MeasurementLocation.java.

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

◆ createVolume() [3/3]

Measurable org.matsim.counts.MeasurementLocation< T >.createVolume	(	String	mode,
		int	interval
	)

Definition at line 87 of file MeasurementLocation.java.

                                                               {
         return createMeasurable(Measurable.VOLUMES, mode, interval);
     }

◆ createVelocity()

Measurable org.matsim.counts.MeasurementLocation< T >.createVelocity	(	String	mode,
		int	interval
	)

Definition at line 91 of file MeasurementLocation.java.

                                                                 {
         return createMeasurable(Measurable.VELOCITIES, mode, interval);
     }

◆ createPassengerCounts()

Measurable org.matsim.counts.MeasurementLocation< T >.createPassengerCounts	(	String	mode,
		int	interval
	)

Definition at line 95 of file MeasurementLocation.java.

                                                                        {
         return createMeasurable(Measurable.PASSENGERS, mode, interval);
     }

◆ getDescription()

String org.matsim.counts.MeasurementLocation< T >.getDescription ( )

Definition at line 99 of file MeasurementLocation.java.

                                    {
         return description;
     }

◆ setDescription()

void org.matsim.counts.MeasurementLocation< T >.setDescription ( String description )

Definition at line 103 of file MeasurementLocation.java.

                                                    {
         this.description = description;
     }

◆ getStationName()

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

Definition at line 107 of file MeasurementLocation.java.

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

                                    {
         return stationName;
     }

◆ getDisplayName()

String org.matsim.counts.MeasurementLocation< T >.getDisplayName ( )

Returns the display name of this location. If the station name is set, it is returned. Otherwise the id is returned.

Definition at line 114 of file MeasurementLocation.java.

                                    {
         if (stationName != null)
             return stationName;
         if (id != null)
             return id;
 
         return description;
     }

◆ setId()

void org.matsim.counts.MeasurementLocation< T >.setId ( String id )

Definition at line 123 of file MeasurementLocation.java.

Referenced by org.matsim.counts.CountsReaderMatsimV2.startMeasurementLocation().

                                  {
         this.id = id;
     }

◆ setStationName()

void org.matsim.counts.MeasurementLocation< T >.setStationName ( String stationName )

Definition at line 127 of file MeasurementLocation.java.

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

                                                    {
         this.stationName = stationName;
     }

◆ getCoordinates()

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

Definition at line 131 of file MeasurementLocation.java.

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

                                   {
         return coordinates;
     }

◆ setCoordinates()

void org.matsim.counts.MeasurementLocation< T >.setCoordinates ( Coord coordinates )

Definition at line 135 of file MeasurementLocation.java.

Referenced by org.matsim.counts.Count< T >.setCoord(), and org.matsim.counts.CountsReaderMatsimV2.startMeasurementLocation().

                                                   {
         this.coordinates = coordinates;
     }

◆ getVolumesForMode()

Measurable org.matsim.counts.MeasurementLocation< T >.getVolumesForMode ( String mode )

Definition at line 139 of file MeasurementLocation.java.

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

◆ hasMeasurableForMode()

boolean org.matsim.counts.MeasurementLocation< T >.hasMeasurableForMode	(	String	measurableType,
		String	mode
	)

Return whether this location has measurable data for certain mode.

Definition at line 146 of file MeasurementLocation.java.

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

                                                                             {
         return this.measurables.containsKey(new TypeAndMode(measurableType, mode));
     }

◆ getMeasurableForMode()

Measurable org.matsim.counts.MeasurementLocation< T >.getMeasurableForMode	(	String	measurableType,
		String	mode
	)

Definition at line 151 of file MeasurementLocation.java.

                                                                                {
         return this.measurables.get(new TypeAndMode(measurableType, mode));
     }

◆ toString()

String org.matsim.counts.MeasurementLocation< T >.toString ( )

Definition at line 160 of file MeasurementLocation.java.

                              {
         return "MeasurementLocation{" +
             "id=" + refId +
             ", stationName='" + stationName + '\'' +
             '}';
     }

◆ iterator()

Iterator<TypeAndMode> org.matsim.counts.MeasurementLocation< T >.iterator ( )

Definition at line 168 of file MeasurementLocation.java.

                                             {
         return this.measurables.keySet().iterator();
     }

◆ TypeAndMode()

final record org.matsim.counts.MeasurementLocation< T >.TypeAndMode	(	String	type,
		String	mode
	)

Stores the measurable type and mode of a Measurable.

Definition at line 175 of file MeasurementLocation.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.createMeasurable(), org.matsim.counts.MeasurementLocation<?>.deleteMeasurable(), org.matsim.counts.MeasurementLocation<?>.getMeasurableForMode(), org.matsim.counts.MeasurementLocation<?>.getVolumesForMode(), and org.matsim.counts.MeasurementLocation<?>.hasMeasurableForMode().

175 {

176 }

Member Data Documentation

◆ refId

final Id<T> org.matsim.counts.MeasurementLocation< T >.refId

private

Definition at line 25 of file MeasurementLocation.java.

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

◆ measurables

final Map<TypeAndMode, Measurable> org.matsim.counts.MeasurementLocation< T >.measurables = new LinkedHashMap<>()

private

Definition at line 26 of file MeasurementLocation.java.

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

◆ attributes

final Attributes org.matsim.counts.MeasurementLocation< T >.attributes = new AttributesImpl()

private

Definition at line 27 of file MeasurementLocation.java.

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

◆ id

String org.matsim.counts.MeasurementLocation< T >.id

private

Definition at line 29 of file MeasurementLocation.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.getDisplayName(), org.matsim.counts.MeasurementLocation<?>.getId(), and org.matsim.counts.MeasurementLocation<?>.setId().

◆ stationName

String org.matsim.counts.MeasurementLocation< T >.stationName

private

Definition at line 30 of file MeasurementLocation.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.getDisplayName(), org.matsim.counts.MeasurementLocation<?>.getStationName(), and org.matsim.counts.MeasurementLocation<?>.setStationName().

◆ description

String org.matsim.counts.MeasurementLocation< T >.description

private

Definition at line 31 of file MeasurementLocation.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.getDescription(), org.matsim.counts.MeasurementLocation<?>.getDisplayName(), and org.matsim.counts.MeasurementLocation<?>.setDescription().

◆ coordinates

Coord org.matsim.counts.MeasurementLocation< T >.coordinates

private

Definition at line 32 of file MeasurementLocation.java.

Referenced by org.matsim.counts.MeasurementLocation<?>.getCoordinates(), and org.matsim.counts.MeasurementLocation<?>.setCoordinates().

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

counts/MeasurementLocation.java

Public Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ getRefId()

◆ getId()

◆ getAttributes()

◆ createMeasurable()

◆ deleteMeasurable()

◆ createVolume() [1/3]

◆ createVolume() [2/3]

◆ createVolume() [3/3]

◆ createVelocity()

◆ createPassengerCounts()

◆ getDescription()

◆ setDescription()

◆ getStationName()

◆ getDisplayName()

◆ setId()

◆ setStationName()

◆ getCoordinates()

◆ setCoordinates()

◆ getVolumesForMode()

◆ hasMeasurableForMode()

◆ getMeasurableForMode()

◆ toString()

◆ iterator()

◆ TypeAndMode()

Member Data Documentation

◆ refId

◆ measurables

◆ attributes

◆ id

◆ stationName

◆ description

◆ coordinates