trip_list.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Elisabeth Kluth, Khoa Nguyen
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef MIO_ABM_TRIP_LIST_H
#define MIO_ABM_TRIP_LIST_H
 
#include "abm/location_id.h"
#include "abm/mobility_data.h"
#include "abm/person.h"
#include "abm/person_id.h"
#include "abm/time.h"
#include "abm/location_type.h"
#include "memilio/io/io.h"
#include "memilio/io/default_serialize.h"
#include <cstdint>
#include <vector>
 
namespace mio
{
namespace abm
{
 
struct Trip {
    PersonId person_id; 
    TimePoint trip_time; 
    LocationId destination; 
    int destination_model_id; 
    TransportMode trip_mode; 
    std::vector<uint32_t> cells; 
    Trip(PersonId id, const TimePoint time, const LocationId dest, const int dest_model_id = 0,
         const TransportMode mode_of_transport    = mio::abm::TransportMode::Unknown,
         const std::vector<uint32_t>& input_cells = {})
        : person_id(id)
        , trip_time(mio::abm::TimePoint(time.time_since_midnight().seconds()))
        , destination(dest)
        , destination_model_id(dest_model_id)
        , trip_mode(mode_of_transport)
        , cells(input_cells)
 
    {
    }
 
    bool operator==(const Trip& other) const
    {
        return (person_id == other.person_id) && (trip_time == other.trip_time) && (destination == other.destination) &&
               (destination_model_id == other.destination_model_id) && (trip_mode == other.trip_mode);
    }
 
    auto default_serialize()
    {
        return Members("Trip")
            .add("person_id", person_id)
            .add("trip_time", trip_time)
            .add("destination", destination)
            .add("model_id", destination_model_id)
            .add("trip_mode", trip_mode);
    }
};
 
class TripList
{
public:
    TripList() = default;
 
    const Trip& get_next_trip() const;
 
    TimePoint get_next_trip_time() const;
 
    void add_trips(std::vector<Trip> trip);
 
    void increase_index()
    {
        m_current_index++;
    }
 
    void reset_index()
    {
        m_current_index = 0;
    }
 
    size_t num_trips() const
    {
        return m_trips.size();
    }
 
    uint32_t get_current_index() const
    {
        return m_current_index;
    }
 
    auto default_serialize()
    {
        return Members("TestingScheme").add("trips", m_trips).add("index", m_current_index);
    }
 
private:
    std::vector<Trip> m_trips; 
    uint32_t m_current_index = 0; 
};
 
} // namespace abm
 
template <>
struct DefaultFactory<abm::Trip> {
    static abm::Trip create()
    {
        return abm::Trip{abm::PersonId{}, abm::TimePoint{}, abm::LocationId{}};
    }
};
 
} // namespace mio
 
#endif