AbstractAnalysisModule (vsp 12.0 API)

java.lang.Object
- playground.vsp.analysis.modules.AbstractAnalysisModule

Direct Known Subclasses:

ActivityToModeAnalysis, AgentId2PersonEnterLeaveVehicleAnalyzer, AgentId2PersonEnterLeaveVehicleAnalyzer, BoardingAlightingCountAnalyzer, CarDistanceAnalyzer, EmissionEventsWriter, EmissionsAnalyzer, EnterLeaveVehicle2ActivityAnalyzer, GetPlansSubset, GetStuckEvents, GetStuckEventsAndPlans, LegModeDistanceDistribution, MonetaryPaymentsAnalyzer, NetworkAnalyzer, PtAccessibility, PtCircuityAnalyzer, PtDriverIdAnalyzer, PtLines2PaxAnalysis, PtOperatorAnalyzer, PtPaxVolumesAnalyzer, PtRoutes2PaxAnalysis, PtTripTravelTimeTransfersAnalyzer, SimpleTripAnalyzerModule, StopId2DelayOfLine24hAnalyzer, StopId2DelayOfLine24hAnalyzer, StopId2LineId2PulkAnalyzer, StopId2PersonEnterLeaveVehicleAnalyzer, StopId2RouteId2DelayAtStopAnalyzer, TaxiTravelStatsAnalyzer, TransitSchedule2Shp, TransitScheduleAnalyser, TransitVehicleVolumeAnalyzer, TravelStatsAnalyzer, TravelTimeAnalyzer, TTtripAnalysis, UserBenefitsAnalyzer, VehDelayAtStopHistogramAnalyzer, VehId2DelayAtStopAnalyzer, VehId2PersonEnterLeaveVehicleAnalyzer, WaitingTimesAnalyzer, WelfareAnalyzer
```
public abstract class AbstractAnalysisModule
extends Object
```
Some common methods for analysis modules.

Author:

aneumann

Constructor Summary

Constructors
Constructor Description

AbstractAnalysisModule(String name)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract List<org.matsim.core.events.handler.EventHandler>`	`getEventHandler()`
`String`	`getName()`
`abstract void`	`postProcessData()`	Hook after the events stream is processed.
`abstract void`	`preProcessData()`	Hook called before the events stream is processed.
`abstract void`	`writeResults(String outputFolder)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAnalysisModule
```
public AbstractAnalysisModule(String name)
```
    Parameters:
    
    name - The name of the module.
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    The name of that module
  - getEventHandler
```
public abstract List<org.matsim.core.events.handler.EventHandler> getEventHandler()
```
    Returns:
    
    A list of all the event handler of the module, if necessary, otherwise an empty List.
  - preProcessData
```
public abstract void preProcessData()
```
    Hook called before the events stream is processed.
  - postProcessData
```
public abstract void postProcessData()
```
    Hook after the events stream is processed.
  - writeResults
```
public abstract void writeResults(String outputFolder)
```