Inheritance diagram for org.matsim.counts.Counts< T extends Identifiable< T >:

[legend]

Public Member Functions
	Counts ()

MeasurementLocation< T >	createAndAddMeasureLocation (final Id< T > id, String stationName)

String	getName ()

void	setName (String name)

String	getDescription ()

void	setDescription (String description)

String	getSource ()

void	setSource (String source)

int	getYear ()

void	setYear (int year)

Set< String >	getMeasurableTypes ()

Map< Id< T >, MeasurementLocation< T > >	getMeasureLocations ()

MeasurementLocation< T >	getMeasureLocation (Id< T > id)

final Count< T >	createAndAddCount (final Id< T > linkId, final String stationName)
	Old API. More...

final TreeMap< Id< T >, Count< T > >	getCounts ()

Count< T >	getCount (final Id< T > locId)

Attributes	getAttributes ()

String	toString ()

MatsimFactory	getFactory ()

Static Public Attributes
static final String	ELEMENT_NAME = "counts"

Private Attributes
final Map< Id< T >, MeasurementLocation< T > >	locations = new TreeMap<>()

final Attributes	attributes = new AttributesImpl()

String	name

String	description

String	source

int	year

Detailed Description

This class provides count object, that can assign any measurable values (traffic volumes, velocities e.g.) for any matsim transport mode to an identifiable object (links, nodes, transit stations e.g) Structure is similar to regular counts, but more flexible to use.

Definition at line 21 of file Counts.java.

Constructor & Destructor Documentation

◆ Counts()

org.matsim.counts.Counts< T extends Identifiable< T >.Counts ( )

Definition at line 31 of file Counts.java.

31 {

32 }

Member Function Documentation

◆ createAndAddMeasureLocation()

MeasurementLocation<T> org.matsim.counts.Counts< T extends Identifiable< T >.createAndAddMeasureLocation	(	final Id< T >	id,
		String	stationName
	)

Creates a MeasurementLocation object and adds to count tree map. Argument has to be an id for an matsim Identifiable object (link, node, pt station e.g).

Definition at line 37 of file Counts.java.

Referenced by org.matsim.counts.Counts<?>.createAndAddCount(), and org.matsim.counts.CountsReaderMatsimV2.startMeasurementLocation().

                                                                                                   {
 
         if (this.locations.containsKey(id)) {
             throw new RuntimeException("There is already a measurement object for location " + id.toString());
         }
 
         MeasurementLocation<T> loc = new MeasurementLocation<T>(id, stationName);
         this.locations.put(id, loc);
 
         return loc;
     }

◆ getName()

String org.matsim.counts.Counts< T extends Identifiable< T >.getName ( )

Definition at line 49 of file Counts.java.

                             {
         return name;
     }

◆ setName()

void org.matsim.counts.Counts< T extends Identifiable< T >.setName ( String name )

Definition at line 53 of file Counts.java.

Referenced by org.matsim.counts.CountsReaderMatsimV1.startCounts(), and org.matsim.counts.CountsReaderMatsimV2.startMultiModeCounts().

                                      {
         this.name = name;
     }

◆ getDescription()

String org.matsim.counts.Counts< T extends Identifiable< T >.getDescription ( )

Definition at line 57 of file Counts.java.

                                    {
         return description;
     }

◆ setDescription()

void org.matsim.counts.Counts< T extends Identifiable< T >.setDescription ( String description )

Definition at line 61 of file Counts.java.

Referenced by org.matsim.counts.CountsReaderMatsimV1.startCounts(), and org.matsim.counts.CountsReaderMatsimV2.startMultiModeCounts().

                                                    {
         this.description = description;
     }

◆ getSource()

String org.matsim.counts.Counts< T extends Identifiable< T >.getSource ( )

Definition at line 65 of file Counts.java.

                               {
         return source;
     }

◆ setSource()

void org.matsim.counts.Counts< T extends Identifiable< T >.setSource ( String source )

Definition at line 69 of file Counts.java.

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

                                          {
         this.source = source;
     }

◆ getYear()

int org.matsim.counts.Counts< T extends Identifiable< T >.getYear ( )

Definition at line 73 of file Counts.java.

                          {
         return year;
     }

◆ setYear()

void org.matsim.counts.Counts< T extends Identifiable< T >.setYear ( int year )

Definition at line 77 of file Counts.java.

Referenced by org.matsim.counts.CountsReaderMatsimV1.startCounts(), and org.matsim.counts.CountsReaderMatsimV2.startMultiModeCounts().

                                   {
         this.year = year;
     }

◆ getMeasurableTypes()

Set<String> org.matsim.counts.Counts< T extends Identifiable< T >.getMeasurableTypes ( )

Returns all measured types of observations for all modes.

Definition at line 84 of file Counts.java.

                                             {
         return locations.values().stream()
             .map(MeasurementLocation::getMeasurables)
             .flatMap(e -> e.keySet().stream())
             .map(MeasurementLocation.TypeAndMode::type)
             .collect(Collectors.toSet());
     }

◆ getMeasureLocations()

Map<Id<T>, MeasurementLocation<T> > org.matsim.counts.Counts< T extends Identifiable< T >.getMeasureLocations ( )

Definition at line 92 of file Counts.java.

                                                                     {
         return locations;
     }

◆ getMeasureLocation()

MeasurementLocation<T> org.matsim.counts.Counts< T extends Identifiable< T >.getMeasureLocation ( Id< T > id )

Definition at line 96 of file Counts.java.

Referenced by org.matsim.counts.Counts<?>.getCount().

                                                                {
         return this.locations.get(id);
     }

◆ createAndAddCount()

final Count<T> org.matsim.counts.Counts< T extends Identifiable< T >.createAndAddCount	(	final Id< T >	linkId,
		final String	stationName
	)

Old API.

Old style API to create a measurement for car volumes at one station. Consider using createAndAddMeasureLocation(Id, String) instead.

Parameters

linkId	the link to which the counting station is assigned, must be unique
stationName	some additional identifier for humans, e.g. the original name/id of the counting station

Returns: the created Count object, or RuntimeException} if it could not be created because it already exists

Deprecated:: use createAndAddMeasureLocation(Id, String) instead

Definition at line 114 of file Counts.java.

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

                                                                                           {
         MeasurementLocation<T> location = createAndAddMeasureLocation(linkId, stationName);
         return new Count<>(location);
     }

◆ getCounts()

final TreeMap<Id<T>, Count<T> > org.matsim.counts.Counts< T extends Identifiable< T >.getCounts ( )

Retrieve map of all counts. This will be inefficient because all intermediate objects for the old API will be created.

Deprecated:: use getMeasureLocations() instead

Definition at line 125 of file Counts.java.

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

                                                       {
         TreeMap<Id<T>, Count<T>> result = new TreeMap<>();
 
         for (Map.Entry<Id<T>, MeasurementLocation<T>> e : locations.entrySet()) {
             result.put(e.getKey(), new Count<>(e.getValue()));
         }
 
         return result;
     }

◆ getCount()

Count<T> org.matsim.counts.Counts< T extends Identifiable< T >.getCount ( final Id< T > locId )

Use getMeasureLocation(Id) instead.

Definition at line 139 of file Counts.java.

                                                 {
         MeasurementLocation<T> loc = getMeasureLocation(locId);
         return loc == null ? null : new Count<>(loc);
     }

◆ getAttributes()

Attributes org.matsim.counts.Counts< T extends Identifiable< T >.getAttributes ( )

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

Definition at line 146 of file Counts.java.

Referenced by org.matsim.counts.CountsReaderMatsimV2.endTag(), and org.matsim.counts.CountsReaderMatsimV2.startMultiModeCounts().

                                       {
         return attributes;
     }

◆ toString()

String org.matsim.counts.Counts< T extends Identifiable< T >.toString ( )

Definition at line 151 of file Counts.java.

                              {
         return "[name=" + this.name + "]" + "[nof_locations=" + this.locations.size() + "]";
     }

◆ getFactory()

MatsimFactory org.matsim.counts.Counts< T extends Identifiable< T >.getFactory ( )

Implements org.matsim.core.api.internal.MatsimToplevelContainer.

Definition at line 155 of file Counts.java.

                                                {
         throw new RuntimeException( "not implemented" );
         // yy I need this to fulfill MatsimToplevelContainer.  Which I need to be able to use ProjectionUtils.putCRS(...) in the readers/writers.  kai, feb'24
     }