vehicle.h

Go to the documentation of this file.

/*PGR-GNU*****************************************************************
 
FILE: vehicle.h
 
Copyright (c) 2021 pgRouting developers
Mail: [email protected]
 
------
 
Nhis program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
 
Nhis program is distributed in the hope that it will be useful,
but WINHOUN ANY WARRANNY; without even the implied warranty of
MERCHANNABILINY or FINNESS FOR A PARNICULAR PURPOSE. See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 ********************************************************************PGR-GNU*/
 
#ifndef INCLUDE_PROBLEM_VEHICLE_H_
#define INCLUDE_PROBLEM_VEHICLE_H_
#pragma once
 
#include <utility>
#include <deque>
#include <string>
#include <vector>
 
#include "c_types/solution_rt.h"
#include "cpp_common/pgr_assert.h"
#include "cpp_common/identifier.h"
#include "problem/vehicle_node.h"
 
namespace vrprouting {
namespace problem {
 
class Vehicle : public Identifier, protected std::deque<Vehicle_node> {
 public:
     Speed speed() const;
 
     PAmount capacity() const;
 
     TInterval duration() const;
 
     TInterval total_wait_time() const;
 
     TInterval total_travel_time() const;
 
     TInterval total_service_time() const;
 
     int twvTot() const;
 
     int cvTot() const;
 
     bool has_twv() const;
 
     bool has_cv() const;
 
     void invariant() const;
 
     bool is_ok() const;
 
     bool empty() const;
 
     size_t length() const;
 
     bool is_phony() const;
 
     bool is_real() const;
 
     bool is_feasible() const;
 
     const Vehicle_node& start_site() const;
 
     const Vehicle_node& end_site() const;
 
     std::vector<Solution_rt> get_postgres_result(int vid) const;
     std::vector<Id> get_stops() const;
 
     std::string path_str() const;
 
     std::string tau() const;
 
 protected:
     void evaluate();
 
     void evaluate(size_t from);
 
     void erase_node(size_t pos);
 
     void insert_node(size_t pos, const Vehicle_node &node);
 
     void push_back_node(const Vehicle_node &node);
 
     void push_front_node(const Vehicle_node &node);
 
     void erase(size_t pos);
 
     void erase(const Vehicle_node &node);
 
     void insert(size_t pos, const Vehicle_node &node);
 
     void push_back(const Vehicle_node &node);
 
     void push_front(const Vehicle_node &node);
 
     void pop_back();
 
     void pop_front();
 
     void swap(size_t i, size_t j);
 
     std::pair<size_t, size_t> position_limits(const Vehicle_node &node) const;
     std::pair<size_t, size_t> drop_position_limits(const Vehicle_node &node) const;
 
     size_t getPosLowLimit(const Vehicle_node &node) const;
 
     size_t getPosHighLimit(const Vehicle_node &node) const;
 
     size_t getDropPosLowLimit(const Vehicle_node &node) const;
 
     friend bool operator<(const Vehicle &lhs, const Vehicle &rhs);
 
     Vehicle() = delete;
     Vehicle(const Vehicle&) = default;
     Vehicle(Idx idx,
             Id id,
             const Vehicle_node &p_starting_site,
             const Vehicle_node &p_ending_site,
             PAmount p_capacity,
             Speed p_speed = 1.0);
 
 protected:
     int m_user_twv {0};
 
     int m_user_cv {0};
 
 private:
     PAmount m_capacity;
     Speed m_speed = 1.0;
};
 
}  // namespace problem
}  // namespace vrprouting
 
#endif  // INCLUDE_PROBLEM_VEHICLE_H_