Class MultiCapableAgent<TLayer>

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Inheritance
System.Object
MultimodalAgent<TLayer>
MultiCapableAgent<TLayer>
Citizen
Traveler<TLayer>
Implements
IAgent<TLayer>
SOHTrainModel.Steering.ITrainPassenger
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SOHMultimodalModel.Model
Assembly: SOHMultimodalModel.dll
Syntax
public abstract class MultiCapableAgent<TLayer> : MultimodalAgent<TLayer>, IAgent<TLayer>, IModalCapabilitiesAgent, IAgent, ITickClient, IEntity, IModelObject, IWalkingCapable, ICarSteeringCapable, IBicycleSteeringAndRentalCapable, IBicycleSteeringCapable, ISteeringCapable, IPassengerCapable, IPositionable, ICarRentalCapable, IFerryPassenger, ITrainPassenger where TLayer : IMultimodalLayer
Type Parameters
Name Description
TLayer

Properties

| Improve this Doc View Source

ActiveCapability

The currently active modal type.
Declaration
public ModalChoice ActiveCapability { get; }
Property Value
Type Description
ModalChoice
| Improve this Doc View Source

ActualTravelTime

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public int ActualTravelTime { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

AgentCapabilities

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public string AgentCapabilities { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Bearing

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double Bearing { get; set; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

Bicycle

Holds a personal Bicycle if the agent possesses one.
Declaration
public Bicycle Bicycle { get; protected set; }
Property Value
Type Description
Bicycle
| Improve this Doc View Source

BicycleRentalLayer

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public IBicycleRentalLayer BicycleRentalLayer { get; set; }
Property Value
Type Description
IBicycleRentalLayer
| Improve this Doc View Source

BrakingActivated

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public bool BrakingActivated { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Capabilities

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public IEnumerable<ModalChoice> Capabilities { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ModalChoice>
| Improve this Doc View Source

CapabilityCycling

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public bool CapabilityCycling { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CapabilityDrivingOwnCar

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public bool CapabilityDrivingOwnCar { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Car

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public Car Car { get; set; }
Property Value
Type Description
Car
| Improve this Doc View Source

CarParkingLayer

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public ICarParkingLayer CarParkingLayer { get; set; }
Property Value
Type Description
ICarParkingLayer
| Improve this Doc View Source

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
| Improve this Doc View Source

CarRentalLayer

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public ICarRentalLayer CarRentalLayer { get; set; }
Property Value
Type Description
ICarRentalLayer
| Improve this Doc View Source

CurrentlyCarDriving

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public bool CurrentlyCarDriving { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CyclingPower

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double CyclingPower { get; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

DriverRandom

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double DriverRandom { get; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

DriverType

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public DriverType DriverType { get; }
Property Value
Type Description
DriverType
| Improve this Doc View Source

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
| Improve this Doc View Source

ExpectedTravelTime

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public int ExpectedTravelTime { get; protected set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

FerryStationLayer

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public IFerryStationLayer FerryStationLayer { get; set; }
Property Value
Type Description
IFerryStationLayer
| Improve this Doc View Source

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
| Improve this Doc View Source

Gradient

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double Gradient { get; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

Mass

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double Mass { get; set; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

OvertakingActivated

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public bool OvertakingActivated { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

PerceptionInMeter

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double PerceptionInMeter { get; set; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

PreferredSpeed

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public double PreferredSpeed { get; protected set; }
Property Value
Type Description
System.Double
| Improve this Doc View Source

RentalBicycle

Holds a RentalBicycle if one is leased.
Declaration
public RentalBicycle RentalBicycle { get; }
Property Value
Type Description
RentalBicycle
| Improve this Doc View Source

RouteMainModalActualTravelTime

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public int RouteMainModalActualTravelTime { get; protected set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RouteMainModality

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public string RouteMainModality { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RouteMainModalRouteLength

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public int RouteMainModalRouteLength { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RouteModalities

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public string RouteModalities { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

RouteModalityCount

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public int RouteModalityCount { get; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

StartPosition

Initial position at that the agent is placed.
Declaration
public Position StartPosition { get; set; }
Property Value
Type Description
Position
| Improve this Doc View Source

StoreTickResult

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public bool StoreTickResult { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

TrainStationLayer

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public ITrainStationLayer TrainStationLayer { get; set; }
Property Value
Type Description
SOHTrainModel.Station.ITrainStationLayer
| Improve this Doc View Source

WalkingShoes

The shoes are the physical representation of the multimodal agent within the environment.
Declaration
public WalkingShoes WalkingShoes { get; }
Property Value
Type Description
WalkingShoes

Methods

| Improve this Doc View Source

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.
| Improve this Doc View Source

EnterModalType(ModalChoice, Route)

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
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(Mars.Interfaces.Environments.ModalChoice, Mars.Interfaces.Environments.Route)
| Improve this Doc View Source

Init(TLayer)

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public override void Init(TLayer layer)
Parameters
Type Name Description
TLayer layer
Overrides
SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.Init(TLayer)
| Improve this Doc View Source

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
| Improve this Doc View Source

LeaveModalType(ModalChoice)

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
protected override bool LeaveModalType(ModalChoice modalChoice)
Parameters
Type Name Description
ModalChoice modalChoice
Returns
Type Description
System.Boolean
Overrides
SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.LeaveModalType(Mars.Interfaces.Environments.ModalChoice)
| Improve this Doc View Source

Move()

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public override void Move()
Overrides
SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.Move()
| Improve this Doc View Source

Notify(PassengerMessage)

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public override void Notify(PassengerMessage passengerMessage)
Parameters
Type Name Description
PassengerMessage passengerMessage
Overrides
SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.Notify(SOHDomain.Steering.Common.PassengerMessage)
| Improve this Doc View Source

RentBicycle(Position)

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
protected RentalBicycle RentBicycle(Position position)
Parameters
Type Name Description
Position position
Returns
Type Description
RentalBicycle
| Improve this Doc View Source

ResetOutputProperties()

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
protected override void ResetOutputProperties()
Overrides
SOHMultimodalModel.Multimodal.MultimodalAgent<TLayer>.ResetOutputProperties()
| Improve this Doc View Source

SetRunning()

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public void SetRunning()
| Improve this Doc View Source

SetWalking()

This MultiCapableAgent<TLayer> implements different capabilities for instance: WALK, DRIVE and CYCLE
Declaration
public void SetWalking()

Implements

SOHTrainModel.Steering.ITrainPassenger