Inheritance diagram for org.matsim.pt.routes.ExperimentalTransitRoute:

[legend]

Public Member Functions
	ExperimentalTransitRoute (final TransitStopFacility accessFacility, final TransitStopFacility egressFacility, final Id< TransitLine > lineId, final Id< TransitRoute > routeId)

	ExperimentalTransitRoute (final TransitStopFacility accessFacility, final TransitLine line, final TransitRoute route, final TransitStopFacility egressFacility)

ExperimentalTransitRoute	clone ()

Id< TransitStopFacility >	getAccessStopId ()

Id< TransitStopFacility >	getEgressStopId ()

Id< TransitLine >	getLineId ()

Id< TransitRoute >	getRouteId ()

void	setRouteDescription (final String routeDescription)

String	getRouteDescription ()

String	getRouteType ()

String	toString ()

OptionalTime	getBoardingTime ()

final double	getDistance ()

final void	setDistance (final double dist)

final OptionalTime	getTravelTime ()

final void	setTravelTime (final double travTime)

void	setTravelTimeUndefined ()

final void	setEndLinkId (final Id< Link > linkId)

final void	setStartLinkId (final Id< Link > linkId)

final Id< Link >	getStartLinkId ()

final Id< Link >	getEndLinkId ()

final void	setLocked ()

Static Protected Member Functions
static OptionalTime	asOptionalTime (double seconds)

Protected Attributes
double	travTime = UNDEFINED_TIME

Static Protected Attributes
static final double	UNDEFINED_TIME = Double.NEGATIVE_INFINITY

Private Attributes
Id< TransitStopFacility >	accessStopId = null

Id< TransitStopFacility >	egressStopId = null

Id< TransitLine >	lineId = null

Id< TransitRoute >	routeId = null

String	description = null

String	routeDescription

Static Private Attributes
static final String	SEPARATOR = "==="

static final String	IDENTIFIER_1 = "PT1" + SEPARATOR

Detailed Description

Definition at line 32 of file ExperimentalTransitRoute.java.

Constructor & Destructor Documentation

◆ ExperimentalTransitRoute() [1/2]

org.matsim.pt.routes.ExperimentalTransitRoute.ExperimentalTransitRoute	(	final TransitStopFacility	accessFacility,
		final TransitStopFacility	egressFacility,
		final Id< TransitLine >	lineId,
		final Id< TransitRoute >	routeId
	)

Definition at line 50 of file ExperimentalTransitRoute.java.

References org.matsim.api.core.v01.Identifiable< T >.getId(), org.matsim.facilities.Facility.getLinkId(), org.matsim.pt.routes.ExperimentalTransitRoute.lineId, and org.matsim.pt.routes.ExperimentalTransitRoute.routeId.

                                                                                                                                                                                       {
         this(accessFacility.getLinkId(), egressFacility.getLinkId());
         this.accessStopId = accessFacility.getId();
         this.lineId = lineId;
         this.routeId = routeId;
         this.egressStopId = egressFacility.getId();
     }

Here is the call graph for this function:

◆ ExperimentalTransitRoute() [2/2]

org.matsim.pt.routes.ExperimentalTransitRoute.ExperimentalTransitRoute	(	final TransitStopFacility	accessFacility,
		final TransitLine	line,
		final TransitRoute	route,
		final TransitStopFacility	egressFacility
	)

Why do we need this constructor, if we only keep the id of the line/route?

Definition at line 61 of file ExperimentalTransitRoute.java.

References org.matsim.api.core.v01.Identifiable< T >.getId().

                                                                                                                                                                           {
         this(accessFacility, egressFacility, (line == null ? null : line.getId()), (route == null ? null : route.getId()));
     }

Here is the call graph for this function:

Member Function Documentation

◆ clone()

ExperimentalTransitRoute org.matsim.pt.routes.ExperimentalTransitRoute.clone ( )

make the clone method public, but do NOT extend Cloneable so that implementations can decide on their own if they support Cloneable or use some other way to make a copy..

Design comments:

Do we really want this? Martin ("Clean code") argues for the difference between data objects and behavioral objects. Data objects should only be accessed via the interface methods. I think that "route" is a data object. In consequence, "copy" and/or "deepCopy" should, in my view, be static methods. (The argument against this is, I guess, that one might want to add Route implementations that are not part of the standard. Yet given that we want to be able to read/write them in xml, I am not sure how far this carries.) kai, jan'13
In our particular situation, "clone" may be considered as a useful approach to our problem (first clone the plan or its elements, then mutate the contents). Having clone but not Cloneable in the API leaves implementing classes the choice to implement it via Cloneable or via other means. kai, dec'15

Implements org.matsim.api.core.v01.population.Route.

Definition at line 66 of file ExperimentalTransitRoute.java.

References org.matsim.pt.routes.ExperimentalTransitRoute.clone().

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.clone().

                                             {
         return (ExperimentalTransitRoute) super.clone();
     }

Here is the call graph for this function:

◆ getAccessStopId()

Id<TransitStopFacility> org.matsim.pt.routes.ExperimentalTransitRoute.getAccessStopId ( )

Implements org.matsim.pt.routes.TransitPassengerRoute.

Definition at line 70 of file ExperimentalTransitRoute.java.

References org.matsim.pt.routes.ExperimentalTransitRoute.accessStopId.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute().

                                                      {
         return this.accessStopId;
     }

◆ getEgressStopId()

Id<TransitStopFacility> org.matsim.pt.routes.ExperimentalTransitRoute.getEgressStopId ( )

Implements org.matsim.pt.routes.TransitPassengerRoute.

Definition at line 74 of file ExperimentalTransitRoute.java.

References org.matsim.pt.routes.ExperimentalTransitRoute.egressStopId.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute().

                                                      {
         return this.egressStopId;
     }

◆ getLineId()

Id<TransitLine> org.matsim.pt.routes.ExperimentalTransitRoute.getLineId ( )

Implements org.matsim.pt.routes.TransitPassengerRoute.

Definition at line 78 of file ExperimentalTransitRoute.java.

References org.matsim.pt.routes.ExperimentalTransitRoute.lineId.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute().

                                        {
         return this.lineId;
     }

◆ getRouteId()

Id<TransitRoute> org.matsim.pt.routes.ExperimentalTransitRoute.getRouteId ( )

Implements org.matsim.pt.routes.TransitPassengerRoute.

Definition at line 82 of file ExperimentalTransitRoute.java.

References org.matsim.pt.routes.ExperimentalTransitRoute.routeId.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute().

                                          {
         return this.routeId;
     }

◆ setRouteDescription()

void org.matsim.pt.routes.ExperimentalTransitRoute.setRouteDescription ( final String routeDescription )

Sets the state of the route based on it's description

Parameters

routeDescription

Implements org.matsim.api.core.v01.population.Route.

Definition at line 87 of file ExperimentalTransitRoute.java.

References org.matsim.api.core.v01.Id< T >.create(), and org.matsim.pt.routes.ExperimentalTransitRoute.routeDescription.

                                                                    {
 //      super.setRouteDescription(routeDescription);
         this.routeDescription = routeDescription;
         if (routeDescription.startsWith(IDENTIFIER_1)) {
             String[] parts = routeDescription.split(SEPARATOR, 6);// StringUtils.explode(routeDescription, '\t', 6);
             this.accessStopId = Id.create(parts[1], TransitStopFacility.class);
             this.lineId = Id.create(parts[2], TransitLine.class);
             this.routeId = Id.create(parts[3], TransitRoute.class);
             this.egressStopId = Id.create(parts[4], TransitStopFacility.class);
             if (parts.length > 5) {
                 this.description = parts[5];
             } else {
                 this.description = null;
             }
         } else {
             this.accessStopId = null;
             this.lineId = null;
             this.egressStopId = null;
         }
     }

Here is the call graph for this function:

◆ getRouteDescription()

String org.matsim.pt.routes.ExperimentalTransitRoute.getRouteDescription ( )

Returns: a serialization of this routes state as a String. Used to write the route to files.

Implements org.matsim.api.core.v01.population.Route.

Definition at line 109 of file ExperimentalTransitRoute.java.

References org.matsim.pt.routes.ExperimentalTransitRoute.description, and org.matsim.pt.routes.ExperimentalTransitRoute.routeDescription.

                                         {
         if (this.accessStopId == null) {
 //          return super.getRouteDescription();
             return this.routeDescription;
         }
         String str = IDENTIFIER_1 + this.accessStopId.toString() + SEPARATOR + this.lineId.toString() + SEPARATOR
                 + this.routeId.toString() + SEPARATOR + this.egressStopId.toString();
         if (this.description != null) {
             str = str + SEPARATOR + this.description;
         }
         return str;
     }

◆ getRouteType()

String org.matsim.pt.routes.ExperimentalTransitRoute.getRouteType ( )

Returns: an identifier describing the type of this route uniquely. Used when writing the route to files.

Implements org.matsim.api.core.v01.population.Route.

Definition at line 123 of file ExperimentalTransitRoute.java.

                                  {
         return ROUTE_TYPE;
     }

◆ toString()

String org.matsim.pt.routes.ExperimentalTransitRoute.toString ( )

Definition at line 128 of file ExperimentalTransitRoute.java.

                              {
         return "[ExpTransitRoute: access=" + this.accessStopId.toString() + " egress=" + this.egressStopId + " line="
                 + this.lineId + " route=" + this.routeId + " ]";
     }

◆ getBoardingTime()

OptionalTime org.matsim.pt.routes.ExperimentalTransitRoute.getBoardingTime ( )

Implements org.matsim.pt.routes.TransitPassengerRoute.

Definition at line 134 of file ExperimentalTransitRoute.java.

References org.matsim.core.utils.misc.OptionalTime.undefined().

                                           {
         return OptionalTime.undefined();
     }

Here is the call graph for this function:

◆ asOptionalTime()

static OptionalTime org.matsim.core.population.routes.AbstractRoute.asOptionalTime ( double seconds )

staticprotectedinherited

Definition at line 54 of file AbstractRoute.java.

References org.matsim.core.utils.misc.OptionalTime.defined(), and org.matsim.core.utils.misc.OptionalTime.undefined().

Referenced by org.matsim.pt.routes.DefaultTransitPassengerRoute.getBoardingTime(), and org.matsim.core.population.routes.AbstractRoute.getTravelTime().

                                                                  {
         return seconds == UNDEFINED_TIME ? OptionalTime.undefined() : OptionalTime.defined(seconds);
     }

Here is the call graph for this function:

◆ getDistance()

final double org.matsim.core.population.routes.AbstractRoute.getDistance ( )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 59 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.dist.

Referenced by org.matsim.pt.routes.DefaultTransitPassengerRoute.clone().

                                       {
         return dist;
     }

◆ setDistance()

final void org.matsim.core.population.routes.AbstractRoute.setDistance ( final double dist )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 64 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.dist.

Referenced by org.matsim.pt.routes.DefaultTransitPassengerRoute.clone(), ch.sbb.matsim.routing.pt.raptor.RaptorUtils.convertRouteToLegs(), and org.matsim.core.scoring.EventsToLegs.handleEvent().

                                                      {
         this.dist = dist;
     }

◆ getTravelTime()

final OptionalTime org.matsim.core.population.routes.AbstractRoute.getTravelTime ( )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 69 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.asOptionalTime().

Referenced by org.matsim.pt.routes.DefaultTransitPassengerRoute.clone().

                                               {
         return asOptionalTime(this.travTime);
     }

Here is the call graph for this function:

◆ setTravelTime()

final void org.matsim.core.population.routes.AbstractRoute.setTravelTime ( final double travTime )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 74 of file AbstractRoute.java.

References org.matsim.core.utils.misc.OptionalTime.assertDefined(), and org.matsim.core.population.routes.AbstractRoute.travTime.

Referenced by ch.sbb.matsim.routing.pt.raptor.RaptorUtils.convertRouteToLegs(), and org.matsim.core.scoring.EventsToLegs.handleEvent().

                                                            {
         OptionalTime.assertDefined(travTime);
         this.travTime = travTime;
     }

Here is the call graph for this function:

◆ setTravelTimeUndefined()

void org.matsim.core.population.routes.AbstractRoute.setTravelTimeUndefined ( )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 80 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.UNDEFINED_TIME.

                                          {
         this.travTime = UNDEFINED_TIME;
     }

◆ setEndLinkId()

final void org.matsim.core.population.routes.AbstractRoute.setEndLinkId ( final Id< Link > linkId )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 85 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.testForLocked().

                                                           {
         testForLocked();
         this.endLinkId = linkId;
     }

Here is the call graph for this function:

◆ setStartLinkId()

final void org.matsim.core.population.routes.AbstractRoute.setStartLinkId ( final Id< Link > linkId )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 91 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.testForLocked().

                                                             {
         testForLocked();
         this.startLinkId = linkId;
     }

Here is the call graph for this function:

◆ getStartLinkId()

final Id<Link> org.matsim.core.population.routes.AbstractRoute.getStartLinkId ( )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 97 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.startLinkId.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute(), and org.matsim.pt.routes.DefaultTransitPassengerRoute.clone().

                                            {
         return this.startLinkId;
     }

◆ getEndLinkId()

final Id<Link> org.matsim.core.population.routes.AbstractRoute.getEndLinkId ( )

inherited

Implements org.matsim.api.core.v01.population.Route.

Definition at line 102 of file AbstractRoute.java.

References org.matsim.core.population.routes.AbstractRoute.endLinkId.

Referenced by org.matsim.core.population.algorithms.PersonPrepareForSim.adaptRoute(), and org.matsim.pt.routes.DefaultTransitPassengerRoute.clone().

                                          {
         return this.endLinkId;
     }

◆ setLocked()

final void org.matsim.core.population.routes.AbstractRoute.setLocked ( )

inherited

Definition at line 106 of file AbstractRoute.java.

                                   {
         locked = true ;
     }

Member Data Documentation

◆ SEPARATOR

final String org.matsim.pt.routes.ExperimentalTransitRoute.SEPARATOR = "==="

staticprivate

Definition at line 34 of file ExperimentalTransitRoute.java.

◆ IDENTIFIER_1

final String org.matsim.pt.routes.ExperimentalTransitRoute.IDENTIFIER_1 = "PT1" + SEPARATOR

staticprivate

Definition at line 35 of file ExperimentalTransitRoute.java.

◆ accessStopId

Id<TransitStopFacility> org.matsim.pt.routes.ExperimentalTransitRoute.accessStopId = null

private

Definition at line 39 of file ExperimentalTransitRoute.java.

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.getAccessStopId().

◆ egressStopId

Id<TransitStopFacility> org.matsim.pt.routes.ExperimentalTransitRoute.egressStopId = null

private

Definition at line 40 of file ExperimentalTransitRoute.java.

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.getEgressStopId().

◆ lineId

Id<TransitLine> org.matsim.pt.routes.ExperimentalTransitRoute.lineId = null

private

Definition at line 41 of file ExperimentalTransitRoute.java.

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.ExperimentalTransitRoute(), and org.matsim.pt.routes.ExperimentalTransitRoute.getLineId().

◆ routeId

Id<TransitRoute> org.matsim.pt.routes.ExperimentalTransitRoute.routeId = null

private

Definition at line 42 of file ExperimentalTransitRoute.java.

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.ExperimentalTransitRoute(), and org.matsim.pt.routes.ExperimentalTransitRoute.getRouteId().

◆ description

String org.matsim.pt.routes.ExperimentalTransitRoute.description = null

private

Definition at line 43 of file ExperimentalTransitRoute.java.

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.getRouteDescription().

◆ routeDescription

String org.matsim.pt.routes.ExperimentalTransitRoute.routeDescription

private

Definition at line 44 of file ExperimentalTransitRoute.java.

Referenced by org.matsim.pt.routes.ExperimentalTransitRoute.getRouteDescription(), and org.matsim.pt.routes.ExperimentalTransitRoute.setRouteDescription().

◆ UNDEFINED_TIME

final double org.matsim.core.population.routes.AbstractRoute.UNDEFINED_TIME = Double.NEGATIVE_INFINITY

staticprotectedinherited

Definition at line 38 of file AbstractRoute.java.

Referenced by org.matsim.pt.routes.DefaultTransitPassengerRoute.RouteDescription.setBoardingTime(), and org.matsim.core.population.routes.AbstractRoute.setTravelTimeUndefined().

◆ travTime

double org.matsim.core.population.routes.AbstractRoute.travTime = UNDEFINED_TIME

protectedinherited

Definition at line 44 of file AbstractRoute.java.

Referenced by org.matsim.core.population.routes.AbstractRoute.setTravelTime(), and org.matsim.core.population.routes.AbstractRoute.toString().

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

pt/routes/ExperimentalTransitRoute.java

Public Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ExperimentalTransitRoute() [1/2]

◆ ExperimentalTransitRoute() [2/2]

Member Function Documentation

◆ clone()

◆ getAccessStopId()

◆ getEgressStopId()

◆ getLineId()

◆ getRouteId()

◆ setRouteDescription()

◆ getRouteDescription()

◆ getRouteType()

◆ toString()

◆ getBoardingTime()

◆ asOptionalTime()

◆ getDistance()

◆ setDistance()

◆ getTravelTime()

◆ setTravelTime()

◆ setTravelTimeUndefined()

◆ setEndLinkId()

◆ setStartLinkId()

◆ getStartLinkId()

◆ getEndLinkId()

◆ setLocked()

Member Data Documentation

◆ SEPARATOR

◆ IDENTIFIER_1

◆ accessStopId

◆ egressStopId

◆ lineId

◆ routeId

◆ description

◆ routeDescription

◆ UNDEFINED_TIME

◆ travTime