pgrouting::vrp::Tw_node Class Reference

Extends the Node class to create a Node with time window attributes. More...

#include "tw_node.h"

Inheritance diagram for pgrouting::vrp::Tw_node:

Collaboration diagram for pgrouting::vrp::Tw_node:

Public Types
enum	NodeType {   kStart = 0, kPickup, kDelivery, kDump,   kLoad, kEnd }

Public Member Functions
	Tw_node ()=default
	Tw_node (const Tw_node &)=default
	Tw_node (size_t id, PickDeliveryOrders_t data, NodeType type)
	Tw_node (size_t id, Vehicle_t data, NodeType type)
double	distance (const Dnode &other) const
int64_t	id () const
size_t	idx () const
void	reset_id (int64_t)

Static Protected Member Functions
static Pgr_messages &	msg ()

Static Protected Attributes
static Pgr_pickDeliver *	problem
	The problem. More...

Private Attributes
double	m_closes
	closing time of the node More...
double	m_demand
	The demand for the Node. More...
int64_t	m_id
size_t	m_idx
double	m_opens
	opening time of the node More...
int64_t	m_order
	order to which it belongs More...
double	m_service_time
NodeType	m_type
	The demand for the Node. More...
friend	PD_problem

Friends
std::ostream &	operator<< (std::ostream &log, const Tw_node &node)
	Print the contents of a Twnode object. More...

Detailed Description

Extends the Node class to create a Node with time window attributes.

A Time Window node is a Node with addition attributes and methods to to support Time Windows and to model a more complex Node need in many vehicle routing problems.

Most application specific code will extend this class and define the specific values and requirements for type and streetid.

Definition at line 57 of file tw_node.h.

Member Enumeration Documentation

NodeType

enum pgrouting::vrp::Tw_node::NodeType

Enumerator
kStart	starting site
kPickup	pickup site
kDelivery	delivery site
kDump	dump site, empties truck
kLoad	load site, fills the truck
kEnd	ending site

Definition at line 59 of file tw_node.h.

                  {
         kStart = 0,  
         kPickup,  
         kDelivery,  
         kDump,  
         kLoad,  
         kEnd        
     } NodeType;

Constructor & Destructor Documentation

Tw_node() [1/4]

pgrouting::vrp::Tw_node::Tw_node ( )

default

Tw_node() [2/4]

pgrouting::vrp::Tw_node::Tw_node ( const Tw_node &  )

default

Tw_node() [3/4]

pgrouting::vrp::Tw_node::Tw_node	(	size_t	id,
		PickDeliveryOrders_t	data,
		NodeType	type
	)

Definition at line 151 of file tw_node.cpp.

                       :
    Dnode(id, data.pick_node_id),
    m_order(data.id),
    m_opens(data.pick_open_t),
    m_closes(data.pick_close_t),
    m_service_time(data.pick_service_t),
    m_demand(data.demand),
    m_type(type)  {
        if (m_type == kDelivery) {
            reset_id(data.deliver_node_id);
            m_opens = data.deliver_open_t;
            m_closes = data.deliver_close_t;
            m_service_time = data.deliver_service_t;
            m_demand *= -1;
        }
    }

References PickDeliveryOrders_t::deliver_close_t, PickDeliveryOrders_t::deliver_node_id, PickDeliveryOrders_t::deliver_open_t, PickDeliveryOrders_t::deliver_service_t, kDelivery, m_closes, m_demand, m_opens, m_service_time, m_type, and pgrouting::Identifier::reset_id().

Tw_node() [4/4]

pgrouting::vrp::Tw_node::Tw_node	(	size_t	id,
		Vehicle_t	data,
		NodeType	type
	)

Definition at line 171 of file tw_node.cpp.

                       :
    Dnode(id, data.start_node_id),
    m_opens(data.start_open_t),
    m_closes(data.start_close_t),
    m_service_time(data.start_service_t),
    m_demand(0),
    m_type(type) {
        if (m_type == kEnd) {
            reset_id(data.end_node_id);
            m_opens = data.end_open_t;
            m_closes = data.end_close_t;
            m_service_time = data.end_service_t;
        }
    }

References Vehicle_t::end_close_t, Vehicle_t::end_node_id, Vehicle_t::end_open_t, Vehicle_t::end_service_t, kEnd, m_closes, m_opens, m_service_time, m_type, and pgrouting::Identifier::reset_id().

Member Function Documentation

arrival_j_opens_i()

double pgrouting::vrp::Tw_node::arrival_j_opens_i	(	const Tw_node &	I,
		double	speed
	)		const

@ {

The actual arrival time at This node, given that: this node is visited directly after other node and that the actual arrival time at other node was opens(other)

Definition at line 50 of file tw_node.cpp.

                                                               {
    if (m_type == kStart) return (std::numeric_limits<double>::max)();
    return I.opens() + I.service_time() + I.travel_time_to(*this, speed);
}

References kStart, m_type, opens(), service_time(), and travel_time_to().

Referenced by is_compatible_IJ().

closes()

double pgrouting::vrp::Tw_node::closes ( ) const

inline

Returns the closing time.

Definition at line 79 of file tw_node.h.

{return m_closes;}

References m_closes.

Referenced by pgrouting::vrp::Fleet::add_vehicle(), is_delivery(), is_dump(), is_end(), pgrouting::vrp::Vehicle::is_ok(), is_pickup(), is_start(), and pgrouting::vrp::Vehicle::Vehicle().

demand() [1/2]

double pgrouting::vrp::Tw_node::demand ( ) const

inline

Returns the demand associated with this node.

Definition at line 82 of file tw_node.h.

{return m_demand;}

References m_demand.

Referenced by pgrouting::vrp::Vehicle_node::evaluate(), is_delivery(), is_dump(), is_end(), is_pickup(), and is_start().

demand() [2/2]

void pgrouting::vrp::Tw_node::demand ( double  value )

inline

Definition at line 83 of file tw_node.h.

{m_demand = value;}

References m_demand.

distance()

double pgrouting::vrp::Dnode::distance ( const Dnode &  other ) const

inherited

Definition at line 43 of file dnode.cpp.

                                        {
    return problem->get_cost_matrix().distance(
            problem->get_cost_matrix().get_index(id()),
            problem->get_cost_matrix().get_index(other.id()));
}

References pgrouting::tsp::Dmatrix::distance(), pgrouting::vrp::Pgr_pickDeliver::get_cost_matrix(), pgrouting::tsp::Dmatrix::get_index(), pgrouting::Identifier::id(), and pgrouting::vrp::Dnode::problem.

Referenced by travel_time_to().

id()

int64_t pgrouting::Identifier::id ( ) const

inherited

Definition at line 42 of file identifier.cpp.

                     {
    return m_id;
}

References pgrouting::Identifier::m_id.

Referenced by pgrouting::vrp::Dnode::distance(), pgrouting::vrp::Vehicle::get_postgres_result(), pgrouting::vrp::Vehicle::is_phony(), pgrouting::vrp::operator<<(), pgrouting::operator<<(), operator==(), pgrouting::vrp::Vehicle::tau(), and pgrouting::vrp::Vehicle::Vehicle().

idx()

size_t pgrouting::Identifier::idx ( ) const

inherited

Definition at line 37 of file identifier.cpp.

                      {
    return m_idx;
}

References pgrouting::Identifier::m_idx.

Referenced by pgrouting::vrp::Vehicle::erase(), pgrouting::vrp::Vehicle_pickDeliver::erase(), pgrouting::vrp::Vehicle_pickDeliver::has_order(), pgrouting::vrp::Vehicle_pickDeliver::insert(), pgrouting::vrp::Vehicle::insert(), pgrouting::vrp::operator<<(), pgrouting::operator<<(), operator==(), pgrouting::vrp::Vehicle_pickDeliver::push_back(), pgrouting::vrp::Vehicle_pickDeliver::push_front(), pgrouting::vrp::Vehicle_pickDeliver::semiLIFO(), pgrouting::vrp::Order::set_compatibles(), pgrouting::vrp::Vehicle::tau(), and pgrouting::vrp::Vehicle::Vehicle().

is_compatible_IJ()

bool pgrouting::vrp::Tw_node::is_compatible_IJ	(	const Tw_node &	I,
		double	speed
	)		const

Definition at line 60 of file tw_node.cpp.

                                                              {
    /*
     * I /->  kStart
     */
    if (m_type == kStart) return false;
    /*
     * kEnd /-> (*this)
     */
    if (I.m_type == kEnd) return false;
 
    return !is_late_arrival(arrival_j_opens_i(I, speed));
}

References arrival_j_opens_i(), is_late_arrival(), kEnd, kStart, and m_type.

Referenced by pgrouting::vrp::Vehicle::getPosHighLimit(), pgrouting::vrp::Order::is_valid(), and pgrouting::vrp::Order::isCompatibleIJ().

is_delivery()

bool pgrouting::vrp::Tw_node::is_delivery

(

)

const

is_delivery

To be a delivery node:

• type is kDelivery
• demand < 0

Definition at line 106 of file tw_node.cpp.

                           {
    return m_type == kDelivery
        && (opens() < closes())
        && (service_time() >= 0)
        && (demand() < 0);
}

References closes(), demand(), kDelivery, m_type, opens(), and service_time().

Referenced by pgrouting::vrp::Order::is_valid().

is_dump()

bool pgrouting::vrp::Tw_node::is_dump

(

)

const

is_dump

To be a dump node:

• type is kDump
• demand <= 0

Definition at line 115 of file tw_node.cpp.

                       {
    return m_type == kDump
        && (opens() < closes())
        && (service_time() >= 0)
        && (demand() <= 0);
}

References closes(), demand(), kDump, m_type, opens(), and service_time().

Referenced by pgrouting::vrp::Vehicle_node::evaluate().

is_early_arrival()

bool pgrouting::vrp::Tw_node::is_early_arrival ( double  arrival_time ) const

inline

True when arrivalTime is before it opens.

Definition at line 179 of file tw_node.h.

                                                             {
         return arrival_time < m_opens;
     }

References m_opens.

Referenced by pgrouting::vrp::Vehicle_node::evaluate().

is_end()

bool pgrouting::vrp::Tw_node::is_end

(

)

const

is_end

To be a End node:

• type is kEnd
• demand == 0

Definition at line 126 of file tw_node.cpp.

                      {
    return m_type == kEnd
        && (opens() < closes())
        && (service_time() >= 0)
        && (demand() == 0);
}

References closes(), demand(), kEnd, m_type, opens(), and service_time().

Referenced by pgrouting::vrp::Fleet::add_vehicle(), and pgrouting::vrp::Vehicle_node::has_cv().

is_late_arrival()

bool pgrouting::vrp::Tw_node::is_late_arrival ( double  arrival_time ) const

inline

True when arrivalTime is after it closes.

Definition at line 184 of file tw_node.h.

                                                            {
         return arrival_time > m_closes;
     }

References m_closes.

Referenced by pgrouting::vrp::Vehicle_node::has_twv(), and is_compatible_IJ().

is_pickup()

bool pgrouting::vrp::Tw_node::is_pickup

(

)

const

is_pickup

To be a pickup node:

• type is kPickup
• demand > 0

Definition at line 97 of file tw_node.cpp.

                         {
    return m_type == kPickup
        && (opens() < closes())
        && (service_time() >= 0)
        && (demand() > 0);
}

References closes(), demand(), kPickup, m_type, opens(), and service_time().

Referenced by pgrouting::vrp::Order::is_valid().

is_start()

bool pgrouting::vrp::Tw_node::is_start

(

)

const

@ {

is_start

To be a start node:

• type is kStart
• demand == 0

Definition at line 88 of file tw_node.cpp.

                        {
    return
        m_type == kStart
        && (opens() < closes())
        && (service_time() >= 0)
        && (demand() == 0);
}

References closes(), demand(), kStart, m_type, opens(), and service_time().

Referenced by pgrouting::vrp::Fleet::add_vehicle(), pgrouting::vrp::Vehicle_node::evaluate(), and pgrouting::vrp::Vehicle_node::has_cv().

msg()

static Pgr_messages& pgrouting::vrp::Dnode::msg ( )

staticprotectedinherited

opens()

double pgrouting::vrp::Tw_node::opens ( ) const

inline

Returns the opening time.

Definition at line 76 of file tw_node.h.

{return m_opens;}

References m_opens.

Referenced by pgrouting::vrp::Fleet::add_vehicle(), arrival_j_opens_i(), pgrouting::vrp::Vehicle_node::evaluate(), is_delivery(), is_dump(), is_end(), pgrouting::vrp::Vehicle::is_ok(), is_pickup(), is_start(), and pgrouting::vrp::Vehicle::Vehicle().

operator==()

bool pgrouting::vrp::Tw_node::operator==

(

const Tw_node &

rhs

)

const

Definition at line 135 of file tw_node.cpp.

                                               {
    if (&other == this) return true;
    return m_order == other.m_order
        && m_opens == other.m_opens
        && m_closes == other.m_closes
        && m_service_time == other.m_service_time
        && m_demand == other.m_demand
        && m_type == other.m_type
        && id() == other.id()
        && idx() == other.idx();
}

References pgrouting::Identifier::id(), pgrouting::Identifier::idx(), m_closes, m_demand, m_opens, m_order, m_service_time, and m_type.

order()

int64_t pgrouting::vrp::Tw_node::order ( ) const

inline

@ {

Returns the opening time.

Definition at line 73 of file tw_node.h.

{return m_order;}

References m_order.

reset_id()

void pgrouting::Identifier::reset_id ( int64_t  _id )

inherited

Definition at line 47 of file identifier.cpp.

                                {
    m_id = _id;
}

References pgrouting::Identifier::m_id.

Referenced by Tw_node().

service_time()

double pgrouting::vrp::Tw_node::service_time ( ) const

inline

Returns the service time for this node.

Definition at line 86 of file tw_node.h.

{return m_service_time;}

References m_service_time.

Referenced by arrival_j_opens_i(), pgrouting::vrp::Vehicle_node::evaluate(), is_delivery(), is_dump(), is_end(), is_pickup(), is_start(), and pgrouting::vrp::operator<<().

travel_time_to()

double pgrouting::vrp::Tw_node::travel_time_to	(	const Tw_node &	other,
		double	speed
	)		const

time = distance / speed.

Definition at line 40 of file tw_node.cpp.

                                                             {
    pgassert(speed != 0);
    return distance(to) / speed;
}

References pgrouting::vrp::Dnode::distance(), and pgassert.

Referenced by arrival_j_opens_i(), and pgrouting::vrp::operator<<().

type()

NodeType pgrouting::vrp::Tw_node::type ( ) const

inline

Returns the type of this node.

Definition at line 89 of file tw_node.h.

{return m_type;}

References m_type.

Referenced by type_str().

type_str()

std::string pgrouting::vrp::Tw_node::type_str

(

)

const

Definition at line 75 of file tw_node.cpp.

                                  {
    switch (type()) {
        case kStart: return "START"; break;
        case kEnd: return "END"; break;
        case kDump: return "DUMP"; break;
        case kLoad: return "LOAD"; break;
        case kPickup: return "PICKUP"; break;
        case kDelivery: return "DELIVERY"; break;
        default: return "UNKNOWN";
    }
}

References kDelivery, kDump, kEnd, kLoad, kPickup, kStart, and type().

Referenced by pgrouting::vrp::operator<<().

window_length()

double pgrouting::vrp::Tw_node::window_length ( ) const

inline

Returns the length of time between the opening and closing.

Definition at line 92 of file tw_node.h.

{return m_closes - m_opens;}

References m_closes, and m_opens.

Friends And Related Function Documentation

operator<<

std::ostream& operator<< ( std::ostream &  log, const Tw_node &  node  )

friend

Print the contents of a Twnode object.

Definition at line 191 of file tw_node.cpp.

                                                            {
    log << n.id()
        << "[opens = " << n.m_opens
        << "\tcloses = " << n.m_closes
        << "\tservice = " << n.m_service_time
        << "\tdemand = " << n.m_demand
        << "\ttype = " << n.type_str()
        << "]"
        << "\n";
    return log;
}

Member Data Documentation

m_closes

double pgrouting::vrp::Tw_node::m_closes

private

closing time of the node

Definition at line 227 of file tw_node.h.

Referenced by closes(), is_late_arrival(), pgrouting::vrp::operator<<(), operator==(), Tw_node(), and window_length().

m_demand

double pgrouting::vrp::Tw_node::m_demand

private

The demand for the Node.

Definition at line 229 of file tw_node.h.

Referenced by demand(), pgrouting::vrp::operator<<(), operator==(), and Tw_node().

m_id

int64_t pgrouting::Identifier::m_id

privateinherited

Definition at line 53 of file identifier.h.

Referenced by pgrouting::Identifier::id(), and pgrouting::Identifier::reset_id().

m_idx

size_t pgrouting::Identifier::m_idx

privateinherited

Definition at line 52 of file identifier.h.

Referenced by pgrouting::Identifier::idx().

m_opens

double pgrouting::vrp::Tw_node::m_opens

private

opening time of the node

Definition at line 226 of file tw_node.h.

Referenced by is_early_arrival(), opens(), pgrouting::vrp::operator<<(), operator==(), Tw_node(), and window_length().

m_order

int64_t pgrouting::vrp::Tw_node::m_order

private

order to which it belongs

Definition at line 225 of file tw_node.h.

Referenced by operator==(), and order().

m_service_time

double pgrouting::vrp::Tw_node::m_service_time

private

Definition at line 228 of file tw_node.h.

Referenced by pgrouting::vrp::operator<<(), operator==(), service_time(), and Tw_node().

m_type

NodeType pgrouting::vrp::Tw_node::m_type

private

The demand for the Node.

Definition at line 230 of file tw_node.h.

Referenced by arrival_j_opens_i(), is_compatible_IJ(), is_delivery(), is_dump(), is_end(), is_pickup(), is_start(), operator==(), Tw_node(), and type().

PD_problem

friend pgrouting::vrp::Dnode::PD_problem

privateinherited

Definition at line 49 of file dnode.h.

problem

Pgr_pickDeliver * pgrouting::vrp::Dnode::problem

staticprotectedinherited

The problem.

Definition at line 70 of file dnode.h.

Referenced by pgrouting::vrp::Dnode::distance(), and pgrouting::vrp::PD_problem::PD_problem().

---

The documentation for this class was generated from the following files:

• tw_node.h
• tw_node.cpp