Package org.goplanit.utils.service.routed.modifier

Interface RoutedServicesLayerModifier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void consolidateIdenticallyScheduledTrips​(Mode mode)
      Consolidate all PLANit RoutedTrips with identical relative timing schedules (but different departure times) into a single PLANit Routed trip.
      void recreateManagedEntitiesIds()
      This method will recreate all ids of the routed services' components, but only when the containers used for them are the primary ManagedIdEntities containers, i.e., when the routed services layer is responsible for uniquely tracking all entities by their managed id.
      void recreateRoutedServicesIds()
      Recreate the ids of the routed services layer routedModeServices across all modes
      void recreateRoutedTripScheduleDepartureIds()
      Recreate the ids of the routed services layer's routed trip departure ids across all scheduled trips across all modes
      void recreateRoutedTripsIds()
      Recreate the ids of the routed services layer's routed trips (scheduled and frequency based) across all modes
      void removeDuplicateTripDepartures​(boolean recreateManagedDepartureIds)
      Remove all duplicate scheduled trip departures from the layer.
      void removeEmptyRoutedServicesByMode​(boolean recreateRoutedServicesManagedEntitiesIds)
      Remove all RoutedServicesByMode instances from the layer in case they no longer have any services associated with them
      void removeRoutedServicesWithoutTrips​(boolean recreateManagedEntitiesIds, Mode... modes)
      Remove all routed services from the layer in case they no longer have any trips associated with them for the given modes
      void removeScheduledTripsWithoutLegs​(boolean recreateManagedEntitiesIds, Mode... modes)
      Remove all scheduled trips from the layer (for the given modes) in case they have no relative leg timings.
      void truncateToServiceNetwork()
      Method that will truncate all routed entities to available service network entities in its parent in case the parent service network has been altered for some reason, i.e., the service network entities might still exist as references on the routed services but no longer exist in the related service layer.

    • Method Detail

      • removeEmptyRoutedServicesByMode

        void removeEmptyRoutedServicesByMode​(boolean recreateRoutedServicesManagedEntitiesIds)
        Remove all RoutedServicesByMode instances from the layer in case they no longer have any services associated with them

        When recreateRoutedServicesManagedEntitiesIds is true, event for recreating routed services ids is fired for which a listener can be attached

        Parameters:
        recreateRoutedServicesManagedEntitiesIds - when true recreate routed services ids, otherwise do not

      • removeRoutedServicesWithoutTrips

        void removeRoutedServicesWithoutTrips​(boolean recreateManagedEntitiesIds,
                                      Mode... modes)
        Remove all routed services from the layer in case they no longer have any trips associated with them for the given modes

        When managed id entities are recreated, it will do so for routed services

        Parameters:
        recreateManagedEntitiesIds - when true recreate all managed ids on the layer, otherwise do not
        modes - to do this for

      • removeScheduledTripsWithoutLegs

        void removeScheduledTripsWithoutLegs​(boolean recreateManagedEntitiesIds,
                                     Mode... modes)
        Remove all scheduled trips from the layer (for the given modes) in case they have no relative leg timings. this might occur when only a single stop has been identified for a trip based on a parsed external data source for example, e.g., GTFS with a time period filter.

        When managed id entities are recreated, it will do so for trips and departure ids

        Parameters:
        recreateManagedEntitiesIds - when true recreate all managed ids on the layer, otherwise do not
        modes - to do this for

      • removeDuplicateTripDepartures

        void removeDuplicateTripDepartures​(boolean recreateManagedDepartureIds)
        Remove all duplicate scheduled trip departures from the layer. This might occur when there are duplicates in the exogenous data source for example

        When ids are recreated, it will do so for departure ids only

        Parameters:
        recreateManagedDepartureIds - when true recreate all departure ids on the layer, otherwise do not

      • truncateToServiceNetwork

        void truncateToServiceNetwork()
        Method that will truncate all routed entities to available service network entities in its parent in case the parent service network has been altered for some reason, i.e., the service network entities might still exist as references on the routed services but no longer exist in the related service layer. To be used - for example - in tandem with ServiceNetworkLayerModifier.removeUnmappedServiceNetworkEntities() which removes service network entities that are not attached to underlying physical network entities. this type of modification is useful for example when a parsed (routed) service network covers a larger area than the underlying physical network chosen, in which case some or many of the service routes are mapped to a service network that in turn could not be mapped to the physical network available. In those cases this method truncates all routes for which its service network elements are missing from its parent service layer (because they were fully or partially detached from a physical network and were removed because of it)

        Note that invoking this method will recreate all managed ids across the routed services due to gaps occurring after removal of unmapped entries

      • consolidateIdenticallyScheduledTrips

        void consolidateIdenticallyScheduledTrips​(Mode mode)
        Consolidate all PLANit RoutedTrips with identical relative timing schedules (but different departure times) into a single PLANit Routed trip. Redundant trips are removed. Not that Ids are not updated when these entries are removed from their respective containers. This is left to the user to do manually afterwards if desired.
        Parameters:
        mode - to do this for

      • recreateManagedEntitiesIds

        void recreateManagedEntitiesIds()
        This method will recreate all ids of the routed services' components, but only when the containers used for them are the primary ManagedIdEntities containers, i.e., when the routed services layer is responsible for uniquely tracking all entities by their managed id. If not, it will not recreate the ids.

        The reasoning is that if we would recreate ids of the container while the container does not contain all = let's say - routes, their managedId is no longer guaranteed to be unique which can lead to issues

        Method can be used in conjunctions with the removal of parts of the routed services and the result is required to have unique contiguous ids

      • recreateRoutedServicesIds

        void recreateRoutedServicesIds()
        Recreate the ids of the routed services layer routedModeServices across all modes

      • recreateRoutedTripScheduleDepartureIds

        void recreateRoutedTripScheduleDepartureIds()
        Recreate the ids of the routed services layer's routed trip departure ids across all scheduled trips across all modes

      • recreateRoutedTripsIds

        void recreateRoutedTripsIds()
        Recreate the ids of the routed services layer's routed trips (scheduled and frequency based) across all modes