org.opentripplanner.model.BoardingArea Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of otp Show documentation

The OpenTripPlanner multimodal journey planning system

There is a newer version: 2.5.0

/* This file is based on code copied from project OneBusAway, see the LICENSE file for further information. */
package org.opentripplanner.model;

/**
 * A place along a platform, where the vehicle van be boarded. Equivalent to GTFS stop location.
 */
public final class BoardingArea extends StationElement {

  private static final long serialVersionUID = 2L;

  private Stop parentStop;

  public BoardingArea(
          FeedScopedId id,
          String name,
          String code,
          String description,
          WgsCoordinate coordinate,
          WheelChairBoarding wheelchairBoarding,
          StopLevel level
  ) {
    super(
            id,
            name,
            code,
            description,
            coordinate,
            wheelchairBoarding,
            level
    );
  }

  /**
   * Center point/location for the boarding area. Returns the coordinate of the parent stop,
   * if the coordinate is not defined for this boarding area.
   */
  public WgsCoordinate getCoordinate() {
    return isCoordinateSet() ? super.getCoordinate() : parentStop.getCoordinate();
  }

  /**
   * Returns the parent stop this boarding area belongs to.
   */
  public Stop getParentStop() {
    return parentStop;
  }

  public void setParentStop(Stop parentStop) {
    this.parentStop = parentStop;
  }

  @Override
  public String toString() {
    return "";
  }
}