CoreConfig

java.lang.Object
- org.transitime.configData.CoreConfig

```
public class CoreConfig
extends java.lang.Object
```
Handles the core configuration data file. Allows parameters to be read in from the file at startup and, in the future, while program is running. Goal is for the accessing of the data to be fast so don't want to do any work then. But also need to make sure that it is thread safe since might be reading data while it is being updated.

Author:

SkiBu Smith

Constructor Summary

Constructors
Constructor and Description

CoreConfig()

Constructors
Constructor and Description
`CoreConfig()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`exclusiveBlockAssignments()` True if block assignments should be exclusive.
`static double`	`getAfterStopDistance()` How far a vehicle can be past a stop in meters and still be considered at the stop.
`static int`	`getAllowableEarlyDepartureTimeForLoggingEvent()` How early in seconds a vehicle can departure a terminal before it registers a VehicleEvent indicating a problem.
`static int`	`getAllowableEarlyForLayoverSeconds()` How early a vehicle can be and still be matched to a layover.
`static int`	`getAllowableEarlySeconds()` How early a vehicle can be and still be matched to its block assignment.
`static int`	`getAllowableEarlySecondsForInitialMatching()` How early a vehicle can be and still be matched to its block assignment.
`static int`	`getAllowableEarlyTimeForEarlyDepartureSecs()` How early in seconds a vehicle can have left terminal and have it be considered an early departure instead of just moving around within the layover.
`static int`	`getAllowableLateAtTerminalForLoggingEvent()` If a vehicle is just sitting at a terminal and provides another GPS report indicating that it is more than this much later, in seconds, than the configured departure time then a VehicleEvent is created to record the problem.
`static int`	`getAllowableLateDepartureTimeForLoggingEvent()` How late in seconds a vehicle can departure a terminal before it registers a VehicleEvent indicating a problem.
`static int`	`getAllowableLateSeconds()` How late a vehicle can be and still be matched to its block assignment.
`static int`	`getAllowableLateSecondsForInitialMatching()` How late a vehicle can be and still be matched to its block assignment.
`static int`	`getAllowableNumberOfBadMatches()` How many bad spatial/temporal matches a predictable vehicle can have in a row before the vehicle is made unpredictable.
`static int`	`getAvlHistoryMaxSize()`
`static double`	`getBeforeStopDistance()` How far a vehicle can be before a stop in meters and be considered to have arrived.
`static float`	`getDeadheadingShortVersusLongDistance()` For determining if enough time to deadhead to beginning of a trip.
`static int`	`getDefaultBreakTimeSec()` How far a vehicle can be past a stop in meters and still be considered at the stop.
`static double`	`getDistanceBetweenAvlsForInitialMatchingWithoutHeading()` For initial matching vehicle to assignment when there isn't any heading information.
`static double`	`getDistanceFromEndOfBlockForInitialMatching()` For initial matching of vehicle to block assignment.
`static double`	`getDistanceFromLastStopForEndMatching()` How close vehicle needs to be from the last stop of the block such that the next AVL report should possibly be considered to match to the end of the block.
`static double`	`getDistanceFromLayoverForEarlyDeparture()` How far along path past a layover stop a vehicle needs to be in order for it to be considered an early departure instead of just moving around within the layover.
`static double`	`getEarlyToLateRatio()` How much worse it is for a vehicle to be early as opposed to late when determining schedule adherence.
`static double`	`getLayoverDistance()` How far vehicle can be away from layover stop and still match to it.
`static float`	`getLongDistanceDeadheadingSpeed()`
`static int`	`getMatchHistoryMaxSize()`
`static double`	`getMaxDistanceFromSegment()` How far a location can be from a path segment and still be considered a match.
`static float`	`getMaxHeadingOffsetFromSegment()` How far heading in degrees of vehicle can be away from path segment and still be considered a match.
`static int`	`getMaxPredictionsTimeForDbSecs()` For determining if prediction should be stored in db.
`static double`	`getMinDistanceForDelayed()` transitime.core.minDistanceForDelayed
`static double`	`getMinDistanceForNoProgress()`
`static java.util.List<java.lang.String>`	`getOptionalModules()` The semicolon separated list of names of all of the modules that should be automatically started.
`static java.lang.String`	`getPidFileDirectory()`
`static float`	`getShortDistanceDeadheadingSpeed()`
`static int`	`getTimeForDeterminingDelayedSecs()` transitime.core.timeForDeterminingDelayedSecs
`static int`	`getTimeForDeterminingNoProgress()`
`static boolean`	`onlyNeedArrivalDepartures()` When batching large amount of AVL data through system to generate improved schedule time (as has been done for Zhengzhou) it takes huge amount of time to process everything.
`static boolean`	`pauseIfDbQueueFilling()` When in batch mode can flood db with lots of objects.
`static boolean`	`storeDataInDatabase()` When in playback mode or some other situations don't want to store generated data such as arrivals/departures, events, and such to the database because only debugging.

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

- Constructor Detail
  - CoreConfig
```
public CoreConfig()
```
- Method Detail
  - storeDataInDatabase
```
public static boolean storeDataInDatabase()
```
    When in playback mode or some other situations don't want to store generated data such as arrivals/departures, events, and such to the database because only debugging.
    
    Returns:
  - onlyNeedArrivalDepartures
```
public static boolean onlyNeedArrivalDepartures()
```
    When batching large amount of AVL data through system to generate improved schedule time (as has been done for Zhengzhou) it takes huge amount of time to process everything. To speed things up you can set -Dtransitime.core.onlyNeedArrivalDepartures=true such that the system will be sped up by not generating nor logging predictions, not logging AVL data nor storing it in db, and not logging nor storing match data in db.
    
    Returns:
  - pauseIfDbQueueFilling
```
public static boolean pauseIfDbQueueFilling()
```
    When in batch mode can flood db with lots of objects. If transitime.core.pauseIfDbQueueFilling is set to true then when objects are put into the DataDbLogger queue the calling thread will be temporarily suspended so that the separate thread can run to write to the db and thereby empty out the queue.
    
    Returns:
  - getOptionalModules
```
public static java.util.List<java.lang.String> getOptionalModules()
```
    The semicolon separated list of names of all of the modules that should be automatically started.
    
    Returns:
  - getMaxDistanceFromSegment
```
public static double getMaxDistanceFromSegment()
```
    How far a location can be from a path segment and still be considered a match.
    
    Returns:
  - getAllowableNumberOfBadMatches
```
public static int getAllowableNumberOfBadMatches()
```
    How many bad spatial/temporal matches a predictable vehicle can have in a row before the vehicle is made unpredictable.
    
    Returns:
  - getMaxHeadingOffsetFromSegment
```
public static float getMaxHeadingOffsetFromSegment()
```
    How far heading in degrees of vehicle can be away from path segment and still be considered a match. Needs to be pretty lenient because stopPaths and heading might not be that accurate.
    
    Returns:
  - getDistanceFromEndOfBlockForInitialMatching
```
public static double getDistanceFromEndOfBlockForInitialMatching()
```
    For initial matching of vehicle to block assignment. If vehicle is closer than this distance from the end of the block then the spatial match will not be used. This is to prevent a vehicle that has already completed its block from wrongly being assigned to that block again.
    
    Returns:
  - getDistanceFromLastStopForEndMatching
```
public static double getDistanceFromLastStopForEndMatching()
```
    How close vehicle needs to be from the last stop of the block such that the next AVL report should possibly be considered to match to the end of the block. This is important for determining the arrival time at the last stop of the block even if don't get an AVL report near that stop.
    
    Returns:
  - getDeadheadingShortVersusLongDistance
```
public static float getDeadheadingShortVersusLongDistance()
```
    For determining if enough time to deadhead to beginning of a trip. If vehicles are far away then they are more likely to be able to travel faster because they could take a freeway or other fast road. But when get closer then will be on regular streets and will travel more slowly. The parameters should be set in a conservative way such that the travel time is underestimated by using slower speeds than will actually encounter. This way the vehicle will arrive after the predicted time which means that passenger won't miss the bus.
    
    Returns:
  - getShortDistanceDeadheadingSpeed
```
public static float getShortDistanceDeadheadingSpeed()
```
  - getLongDistanceDeadheadingSpeed
```
public static float getLongDistanceDeadheadingSpeed()
```
  - getMaxPredictionsTimeForDbSecs
```
public static int getMaxPredictionsTimeForDbSecs()
```
    For determining if prediction should be stored in db. Set to 0 to never store predictions. A very large number of predictions is created so be careful with this value so that the db doesn't get filled up too quickly.
    
    Returns:
  - getAllowableEarlyForLayoverSeconds
```
public static int getAllowableEarlyForLayoverSeconds()
```
    How early a vehicle can be and still be matched to a layover. Needs to be pretty large because sometimes vehicles will be assigned to a layover quite early, and want to be able to make the vehicle predictable and generate predictions far in advance. Don't want it to be too large, like 90 minutes, though because then could match incorrectly if vehicle simply stays at terminal.
    
    Returns:
  - getAllowableEarlySeconds
```
public static int getAllowableEarlySeconds()
```
    How early a vehicle can be and still be matched to its block assignment. If when a new AVL report is received for a predictable vehicle and it is found with respect to the real-time schedule adherence to be earlier than this value the vehicle will be made unpredictable.
    
    Returns:
  - getAllowableLateSeconds
```
public static int getAllowableLateSeconds()
```
    How late a vehicle can be and still be matched to its block assignment. If when a new AVL report is received for a predictable vehicle and it is found with respect to the real-time schedule adherence to be later than this value the vehicle will be made unpredictable.
    
    Returns:
  - getAllowableEarlySecondsForInitialMatching
```
public static int getAllowableEarlySecondsForInitialMatching()
```
    How early a vehicle can be and still be matched to its block assignment.
    
    Returns:
    
    time in seconds
  - getAllowableLateSecondsForInitialMatching
```
public static int getAllowableLateSecondsForInitialMatching()
```
    How late a vehicle can be and still be matched to its block assignment.
    
    Returns:
    
    time in seconds
  - getDistanceBetweenAvlsForInitialMatchingWithoutHeading
```
public static double getDistanceBetweenAvlsForInitialMatchingWithoutHeading()
```
    For initial matching vehicle to assignment when there isn't any heading information. In that case also want to match to previous AVL report. This parameter specifies how far, as the crow flies, the previous AVL report to be used from the VehicleState AvlReport history is from the current AvlReport.
    
    Returns:
  - getDistanceFromLayoverForEarlyDeparture
```
public static double getDistanceFromLayoverForEarlyDeparture()
```
    How far along path past a layover stop a vehicle needs to be in order for it to be considered an early departure instead of just moving around within the layover. Needs to be a decent distance since the stop locations are not always accurate.
    Related to getAllowableEarlyTimeForEarlyDeparture().
    
    Returns:
  - getLayoverDistance
```
public static double getLayoverDistance()
```
    How far vehicle can be away from layover stop and still match to it. For when not deadheading to a trip. This can be useful to determine when a vehicle is pulled out of service when it is expected to be at a layover and start the next trip. Should usually be a pretty large value so that vehicles are not taken out of service just because they drive a bit away from the stop for the layover, which is pretty common.
    
    Returns:
  - getAllowableEarlyTimeForEarlyDepartureSecs
```
public static int getAllowableEarlyTimeForEarlyDepartureSecs()
```
    How early in seconds a vehicle can have left terminal and have it be considered an early departure instead of just moving around within the layover. Don't want to mistakingly think that vehicles moving around during layover have started their trip early. Therefore this value should be limited to just a few minutes since vehicles usually don't leave early.
    Related to getDistanceFromLayoverForEarlyDeparture()
    
    Returns:
    
    Time in msec
  - getAllowableEarlyDepartureTimeForLoggingEvent
```
public static int getAllowableEarlyDepartureTimeForLoggingEvent()
```
    How early in seconds a vehicle can departure a terminal before it registers a VehicleEvent indicating a problem.
    
    Returns:
  - getAllowableLateDepartureTimeForLoggingEvent
```
public static int getAllowableLateDepartureTimeForLoggingEvent()
```
    How late in seconds a vehicle can departure a terminal before it registers a VehicleEvent indicating a problem.
    
    Returns:
  - getAllowableLateAtTerminalForLoggingEvent
```
public static int getAllowableLateAtTerminalForLoggingEvent()
```
    If a vehicle is just sitting at a terminal and provides another GPS report indicating that it is more than this much later, in seconds, than the configured departure time then a VehicleEvent is created to record the problem.
    
    Returns:
  - getBeforeStopDistance
```
public static double getBeforeStopDistance()
```
    How far a vehicle can be before a stop in meters and be considered to have arrived.
    
    Returns:
  - getAfterStopDistance
```
public static double getAfterStopDistance()
```
    How far a vehicle can be past a stop in meters and still be considered at the stop.
    
    Returns:
  - getDefaultBreakTimeSec
```
public static int getDefaultBreakTimeSec()
```
    How far a vehicle can be past a stop in meters and still be considered at the stop.
    
    Returns:
  - getEarlyToLateRatio
```
public static double getEarlyToLateRatio()
```
    How much worse it is for a vehicle to be early as opposed to late when determining schedule adherence.
    
    Returns:
  - exclusiveBlockAssignments
```
public static boolean exclusiveBlockAssignments()
```
    True if block assignments should be exclusive. If set to true then when a vehicle is assigned to a block the system will unassign any other vehicles that were assigned to the block. Important for when AVL system doesn't always provide logout info.
    
    Returns:
  - getTimeForDeterminingNoProgress
```
public static int getTimeForDeterminingNoProgress()
```
  - getMinDistanceForNoProgress
```
public static double getMinDistanceForNoProgress()
```
  - getTimeForDeterminingDelayedSecs
```
public static int getTimeForDeterminingDelayedSecs()
```
    transitime.core.timeForDeterminingDelayedSecs
    
    Returns:
  - getMinDistanceForDelayed
```
public static double getMinDistanceForDelayed()
```
    transitime.core.minDistanceForDelayed
    
    Returns:
  - getMatchHistoryMaxSize
```
public static int getMatchHistoryMaxSize()
```
  - getAvlHistoryMaxSize
```
public static int getAvlHistoryMaxSize()
```
  - getPidFileDirectory
```
public static java.lang.String getPidFileDirectory()
```

Class CoreConfig

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CoreConfig

Method Detail

storeDataInDatabase

onlyNeedArrivalDepartures

pauseIfDbQueueFilling

getOptionalModules

getMaxDistanceFromSegment

getAllowableNumberOfBadMatches

getMaxHeadingOffsetFromSegment

getDistanceFromEndOfBlockForInitialMatching

getDistanceFromLastStopForEndMatching

getDeadheadingShortVersusLongDistance

getShortDistanceDeadheadingSpeed

getLongDistanceDeadheadingSpeed

getMaxPredictionsTimeForDbSecs

getAllowableEarlyForLayoverSeconds

getAllowableEarlySeconds

getAllowableLateSeconds

getAllowableEarlySecondsForInitialMatching

getAllowableLateSecondsForInitialMatching

getDistanceBetweenAvlsForInitialMatchingWithoutHeading

getDistanceFromLayoverForEarlyDeparture

getLayoverDistance

getAllowableEarlyTimeForEarlyDepartureSecs

getAllowableEarlyDepartureTimeForLoggingEvent

getAllowableLateDepartureTimeForLoggingEvent

getAllowableLateAtTerminalForLoggingEvent

getBeforeStopDistance

getAfterStopDistance

getDefaultBreakTimeSec

getEarlyToLateRatio

exclusiveBlockAssignments

getTimeForDeterminingNoProgress

getMinDistanceForNoProgress

getTimeForDeterminingDelayedSecs

getMinDistanceForDelayed

getMatchHistoryMaxSize

getAvlHistoryMaxSize

getPidFileDirectory