Class Tour

A Tour is an enumeration of Trips that starts and ends at home.
Inheritance
System.Object
Tour
Implements
System.Collections.Generic.IEnumerator<Trip>
System.Collections.IEnumerator
System.IDisposable
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.Planning
Assembly: SOHMultimodalModel.dll
Syntax
public class Tour : IEnumerator<Trip>, IEnumerator, IDisposable

Constructors

| Improve this Doc View Source

Tour()

A Tour is an enumeration of Trips that starts and ends at home.
Declaration
public Tour()
| Improve this Doc View Source

Tour(ISimulationContext, Boolean, Boolean)

Creates a new Tour for and working, part-time working or unemployed agent.
Declaration
public Tour(ISimulationContext context, bool worker, bool partTimeWorker)
Parameters
Type Name Description
ISimulationContext context The simulation clock with current tick, step and realtime.
System.Boolean worker The flag indicating that this plan is for a working agent.
System.Boolean partTimeWorker The flag indicating that this is for an agent, only working in noon.

Properties

| Improve this Doc View Source

ActionOrder

A Tour is an enumeration of Trips that starts and ends at home.
Declaration
public TripReason[] ActionOrder { get; set; }
Property Value
Type Description
TripReason[]
| Improve this Doc View Source

Current

Gets the current Trip for the current simulation time.
Declaration
public Trip Current { get; }
Property Value
Type Description
Trip
| Improve this Doc View Source

Trips

Gets the ordered sequence of trips.
Declaration
public List<Trip> Trips { get; }
Property Value
Type Description
System.Collections.Generic.List<Trip>

Methods

| Improve this Doc View Source

Dispose()

A Tour is an enumeration of Trips that starts and ends at home.
Declaration
public void Dispose()
| Improve this Doc View Source

MoveNext()

Moves to the next Trip when the time is coming and actions are available.
Declaration
public bool MoveNext()
Returns
Type Description
System.Boolean Returns true, when the cursor moved to the next trip.
| Improve this Doc View Source

Reset()

Resets the day plan iterator.
Declaration
public void Reset()

Explicit Interface Implementations

| Improve this Doc View Source

IEnumerator.Current

Gets the current object of the enumerator
Declaration
object IEnumerator.Current { get; }
Returns
Type Description
System.Object

Implements

System.Collections.Generic.IEnumerator<T>
System.Collections.IEnumerator
System.IDisposable