• Documentation
  • Core API
  • SmartOpenHamburg API
  • Model Components API
  • Common API

    Show / Hide Table of Contents
    • SOHBicycleModel.Common
      • BicycleConstants
      • BicycleType
      • DriverType
      • HandleBicycleType
      • HandleDriverType
    • SOHBicycleModel.Model
      • Bicycle
    • SOHBicycleModel.Parking
      • BicycleParkingLayer
      • BicycleParkingLot
      • IBicycleParkingLayer
    • SOHBicycleModel.Rental
      • BicycleRentalLayer
      • BicycleRentalStation
      • IBicycleRentalLayer
      • IBicycleSteeringAndRentalCapable
      • IRentalBicycle
      • RentalBicycle
    • SOHBicycleModel.Steering
      • BicyclePassengerHandle
      • BicycleSteeringHandle
      • IBicycleSteeringCapable
      • WiedemannAccelerator
      • WiedemannAccelerator.WiedemannAcceleratorParameters
    • SOHCarModel.Common
      • CarRouteFinder
    • SOHCarModel.Model
      • Car
      • CarDriver
      • CarLayer
      • Golf
      • ICarLayer
      • RentalCar
    • SOHCarModel.Parking
      • CarParkingLayer
      • CarParkingSpace
      • ICarParkingLayer
      • IParkingCar
    • SOHCarModel.Rental
      • CarRentalLayer
      • ICarRentalCapable
      • ICarRentalLayer
    • SOHCarModel.Steering
      • CarPassengerHandle
      • CarSteeringHandle
      • ICarSteeringCapable
    • SOHDomain.Common
      • HumanVelocityConstants
      • NormalDist
      • OsmFeatureCodes
      • OsmGroups
      • VehicleConstants
    • SOHDomain.Graph
      • ISpatialGraphLayer
      • SidewalkLayer
      • SpatialGraphMediatorLayer
      • StreetLayer
    • SOHDomain.Model
      • IModalLayer
      • IVehicleEntrance<TDriver, TPassenger, TSteeringHandle, TPassengerHandle>
      • RoadUser
      • Vehicle<TSteeringCapable, TPassengerCapable, TSteeringHandle, TPassengerHandle>
      • WalkingShoes
    • SOHDomain.Steering.Acceleration
      • IntelligentDriverAccelerator
      • IVehicleAccelerator
      • WalkingAccelerator
    • SOHDomain.Steering.Capables
      • IPassengerCapable
      • ISteeringCapable
      • IWalkingCapable
    • SOHDomain.Steering.Common
      • PassengerMessage
    • SOHDomain.Steering.Handles
      • IdlePassengerSteeringHandle
      • IPassengerHandle
      • ISteeringHandle
      • VehiclePassengerHandle<TSteeringCapable, TPassengerCapable, TSteeringHandle, TPassengerHandle>
      • VehicleSteeringHandle<TSteeringCapable, TPassengerCapable, TSteeringHandle, TPassengerHandle>
      • WalkingSteeringHandle
    • SOHDomain.Steering.Handles.Intersection
      • AbstractIntersectionHandle<TSteeringCapable, TPassengerCapable, TSteeringHandle, TPassengerHandle>
      • FifoIntersectionHandle<TSteeringCapable, TPassengerCapable, TSteeringHandle, TPassengerHandle>
      • IIntersectionTrafficCode
      • RightBeforeLeftIntersectionHandle<TSteeringCapable, TPassengerCapable, TSteeringHandle, TPassengerHandle>
    • SOHFerryModel.Model
      • Ferry
      • FerryDriver
      • FerryLayer
      • FerrySchedulerLayer
    • SOHFerryModel.Route
      • FerryRoute
      • FerryRoute.FerryRouteEnumerator
      • FerryRouteEntry
      • FerryRouteLayer
      • FerryRouteReader
    • SOHFerryModel.Station
      • FerryStation
      • FerryStationLayer
      • IFerryStationLayer
    • SOHFerryModel.Steering
      • FerryPassengerHandle
      • FerrySteeringHandle
      • IFerryPassenger
      • IFerrySteeringCapable
    • SOHMultimodalModel.Commons
      • PedestrianAverageSpeedGenerator
      • PointOfInterest
    • SOHMultimodalModel.Layers
      • MediatorLayer
      • VectorBuildingsLayer
      • VectorLanduseLayer
      • VectorPoiLayer
      • VectorServiceLayer
    • SOHMultimodalModel.Layers.TrafficLight
      • TrafficLight
      • TrafficLightController
      • TrafficLightLayer
    • SOHMultimodalModel.Model
      • Citizen
      • CitizenLayer
      • CitizenSchedulerLayer
      • CycleTraveler
      • CycleTravelerLayer
      • CycleTravelerSchedulerLayer
      • DockWorker
      • DockWorkerLayer
      • DockWorkerSchedulerLayer
      • GenderType
      • HumanTraveler
      • HumanTravelerLayer
      • ModalityChooser
      • MultiCapableAgent<TLayer>
      • PassengerTraveler
      • PassengerTravelerLayer
      • Traveler<TLayer>
      • TravelerConstants
      • WorkingType
    • SOHMultimodalModel.Multimodal
      • AbstractMultimodalLayer
      • IMultimodalLayer
      • IMultimodalRouteFinder
      • MultimodalAgent<TLayer>
      • Whereabouts
    • SOHMultimodalModel.Output.Route
      • MultimodalRouteOutputAdapter
    • SOHMultimodalModel.Output.Ticks
      • ITickOutputAgent
      • TickOutputAdapter
    • SOHMultimodalModel.Output.Trips
      • ITripSavingAgent
      • TripPositionCoordinateConverter
      • TripsLine
      • TripsLineConverter
      • TripsOutputAdapter
    • SOHMultimodalModel.Planning
      • DayPlanGenerator
      • Tour
      • Trip
      • TripReason
    • SOHMultimodalModel.Routing
      • GatewayLayer
      • GatewayPoint
      • MultimodalRouteCommons
      • MultimodalRouteFinder
      • WalkingCarDrivingRentalMultimodalRoute
      • WalkingDrivingMultimodalRoute
      • WalkingFerryDrivingMultimodalRoute
      • WalkingMultimodalRoute
      • WalkingTrainDrivingMultimodalRoute
    • SOHMultimodalModel.Steering
      • IWalkingRoadUser

    Interface IVehicleEntrance<TDriver, TPassenger, TSteeringHandle, TPassengerHandle>

    A vehicle entrance allows passenger to use vehicles in different roles (as driver or co-driver/passenger).
    Namespace: SOHDomain.Model
    Assembly: SOHDomain.dll
    Syntax
    public interface IVehicleEntrance<in TDriver, in TPassenger, TSteeringHandle, TPassengerHandle>
        where TDriver : ISteeringCapable where TPassenger : IPassengerCapable where TSteeringHandle : ISteeringHandle where TPassengerHandle : IPassengerHandle
    Type Parameters
    Name Description
    TDriver
    TPassenger
    TSteeringHandle
    TPassengerHandle

    Methods

    NotifyPassengers(PassengerMessage)

    Notifies all passengers and the driver.
    Declaration
    void NotifyPassengers(PassengerMessage passengerMessage)
    Parameters
    Type Name Description
    PassengerMessage passengerMessage Notification message for all passengers.

    TryEnterDriver(TDriver, out TSteeringHandle)

    The passenger tries to enter the vehicle in the driver role. On success the driver is able to steer the vehicle with the given handle. ATTENTION:This method only affects the vehicle parameters. The broader context (driver was probably a pedestrian in another environment) has to be taken into consideration and adjusted to the new modal context.
    Declaration
    bool TryEnterDriver(TDriver driver, out TSteeringHandle handle)
    Parameters
    Type Name Description
    TDriver driver That will drive the vehicle.
    TSteeringHandle handle The steering handle that can be used by the driver to control the vehicle.
    Returns
    Type Description
    System.Boolean Whether the driver could enter the vehicle or not.

    TryEnterPassenger(TPassenger, out TPassengerHandle)

    The passenger tries to enter the vehicle as co-driver. ATTENTION:This method only affects the vehicle parameters. The broader context (passenger was probably a pedestrian in another environment) has to be taken into consideration and adjusted to the new modal context.
    Declaration
    bool TryEnterPassenger(TPassenger passenger, out TPassengerHandle handle)
    Parameters
    Type Name Description
    TPassenger passenger That will board the vehicle for transportation.
    TPassengerHandle handle The passenger handle that provides the possibility to be moved.
    Returns
    Type Description
    System.Boolean Whether the passenger could enter the vehicle or not.
    Back to top Copyright © MARS GROUP.
    HAW Hamburg