• 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

    Class MultiCapableAgent<TLayer>

    This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
    Inheritance
    IAgent<TLayer>
    MultimodalAgent<TLayer>
    MultiCapableAgent<TLayer>
    Citizen
    Traveler<TLayer>
    Implements
    IModalCapabilitiesAgent
    IPassengerCapable
    IWalkingCapable
    ICarSteeringCapable
    IBicycleSteeringAndRentalCapable
    IBicycleSteeringCapable
    ISteeringCapable
    ICarRentalCapable
    IFerryPassenger
    SOHTrainModel.Steering.ITrainPassenger
    Inherited Members
    MultimodalAgent<TLayer>.Velocity
    MultimodalAgent<TLayer>.Offside
    MultimodalAgent<TLayer>.MultimodalLayer
    MultimodalAgent<TLayer>.Tick()
    MultimodalAgent<TLayer>.ID
    MultimodalAgent<TLayer>.Position
    MultimodalAgent<TLayer>.ReRouteToGoal()
    MultimodalAgent<TLayer>.TryEnterVehicleAsDriver<TSteeringCapable, TSteeringHandle, TPassengerHandle>(Vehicle<TSteeringCapable, IPassengerCapable, TSteeringHandle, TPassengerHandle>, TSteeringCapable)
    MultimodalAgent<TLayer>.TryEnterVehicleAsPassenger<TSteeringCapable, TSteeringHandle, TPassengerHandle>(Vehicle<TSteeringCapable, IPassengerCapable, TSteeringHandle, TPassengerHandle>, ISteeringCapable)
    MultimodalAgent<TLayer>.TryLeaveVehicle(IPassengerCapable)
    MultimodalAgent<TLayer>.ModalChoices
    MultimodalAgent<TLayer>.Context
    MultimodalAgent<TLayer>.SimulationTime
    MultimodalAgent<TLayer>.StableId
    MultimodalAgent<TLayer>.RouteLength
    MultimodalAgent<TLayer>.RouteMainModalChoice
    MultimodalAgent<TLayer>.Notify(PassengerMessage)
    MultimodalAgent<TLayer>.OnSidewalk
    MultimodalAgent<TLayer>.Whereabouts
    Namespace: SOHMultimodalModel.Model
    Assembly: SOHMultimodalModel.dll
    Syntax
    public abstract class MultiCapableAgent<TLayer> : MultimodalAgent<TLayer>, IModalCapabilitiesAgent, IPassengerCapable, IWalkingCapable, ICarSteeringCapable, IBicycleSteeringAndRentalCapable, IBicycleSteeringCapable, ISteeringCapable, ICarRentalCapable, IFerryPassenger, ITrainPassenger where TLayer : IMultimodalLayer
    Type Parameters
    Name Description
    TLayer

    Properties

    ActualTravelTime

    Declaration
    public int ActualTravelTime { get; }
    Property Value
    Type Description
    System.Int32

    AgentCapabilities

    Declaration
    public string AgentCapabilities { get; }
    Property Value
    Type Description
    System.String

    Bearing

    Declaration
    public double Bearing { get; set; }
    Property Value
    Type Description
    System.Double

    Capabilities

    Declaration
    public IEnumerable<ModalChoice> Capabilities { get; }
    Property Value
    Type Description
    IEnumerable<ModalChoice>

    CapabilityCycling

    Declaration
    public bool CapabilityCycling { get; set; }
    Property Value
    Type Description
    System.Boolean

    CapabilityDrivingOwnCar

    Declaration
    public bool CapabilityDrivingOwnCar { get; set; }
    Property Value
    Type Description
    System.Boolean

    CarRadiusToStartPosition

    Defines the radius from the start position within that the car is placed. Takes the closest parking space if not set or smaller equal zero.
    Declaration
    public double CarRadiusToStartPosition { get; set; }
    Property Value
    Type Description
    System.Double

    EnvironmentLayer

    Gets or initializes the whole network environment where this agent is moving on.
    Declaration
    public SpatialGraphMediatorLayer EnvironmentLayer { get; set; }
    Property Value
    Type Description
    SpatialGraphMediatorLayer

    ExpectedTravelTime

    Declaration
    public int ExpectedTravelTime { get; protected set; }
    Property Value
    Type Description
    System.Int32

    Gender

    Gets or set the gender type of this entity, affecting the walking and running speed
    Declaration
    public GenderType Gender { get; set; }
    Property Value
    Type Description
    GenderType

    PerceptionInMeter

    Declaration
    public double PerceptionInMeter { get; set; }
    Property Value
    Type Description
    System.Double

    PreferredSpeed

    Declaration
    public double PreferredSpeed { get; protected set; }
    Property Value
    Type Description
    System.Double

    RouteMainModalActualTravelTime

    Declaration
    public int RouteMainModalActualTravelTime { get; protected set; }
    Property Value
    Type Description
    System.Int32

    RouteMainModality

    Declaration
    public string RouteMainModality { get; }
    Property Value
    Type Description
    System.String

    RouteMainModalRouteLength

    Declaration
    public int RouteMainModalRouteLength { get; }
    Property Value
    Type Description
    System.Int32

    RouteModalities

    Declaration
    public string RouteModalities { get; }
    Property Value
    Type Description
    System.String

    RouteModalityCount

    Declaration
    public int RouteModalityCount { get; }
    Property Value
    Type Description
    System.Int32

    StartPosition

    Initial position at that the agent is placed.
    Declaration
    public Position StartPosition { get; set; }
    Property Value
    Type Description
    Position

    StoreTickResult

    Declaration
    public bool StoreTickResult { get; set; }
    Property Value
    Type Description
    System.Boolean

    Methods

    EnableCapability(ModalChoice, Boolean)

    Sets the capability of this agent with given params.
    Declaration
    protected void EnableCapability(ModalChoice modalChoice, bool active = true)
    Parameters
    Type Name Description
    ModalChoice modalChoice Identifies the capability.
    System.Boolean active Determines if the agent has the capability or not.

    EnterModalType(ModalChoice, Route)

    Declaration
    protected override bool EnterModalType(ModalChoice modalChoice, Route route)
    Parameters
    Type Name Description
    ModalChoice modalChoice
    Route route
    Returns
    Type Description
    System.Boolean
    Overrides
    SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.EnterModalType(ModalChoice, Route)

    Init(TLayer)

    Declaration
    public override void Init(TLayer layer)
    Parameters
    Type Name Description
    TLayer layer
    Overrides
    SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.Init(TLayer)

    IsCapabilityEnabled(ModalChoice)

    Determines if given capability is active.
    Declaration
    protected bool IsCapabilityEnabled(ModalChoice modalChoice)
    Parameters
    Type Name Description
    ModalChoice modalChoice Identifies the capability.
    Returns
    Type Description
    System.Boolean True, if capability is active, false otherwise

    LeaveModalType(ModalChoice)

    Declaration
    protected override bool LeaveModalType(ModalChoice modalChoice)
    Parameters
    Type Name Description
    ModalChoice modalChoice
    Returns
    Type Description
    System.Boolean
    Overrides
    SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.LeaveModalType(ModalChoice)

    Move()

    Declaration
    public override void Move()
    Overrides
    SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.Move()

    ResetOutputProperties()

    Declaration
    protected override void ResetOutputProperties()

    SetRunning()

    Declaration
    public void SetRunning()

    SetWalking()

    Declaration
    public void SetWalking()

    Implements

    IModalCapabilitiesAgent
    IPassengerCapable
    IWalkingCapable
    ICarSteeringCapable
    IBicycleSteeringAndRentalCapable
    IBicycleSteeringCapable
    ISteeringCapable
    ICarRentalCapable
    IFerryPassenger
    SOHTrainModel.Steering.ITrainPassenger
    Back to top Copyright © MARS GROUP.
    HAW Hamburg