dsm::Itinerary Class Reference

The Itinerary class represents an itinerary in the network. More...

#include <Itinerary.hpp>

Public Member Functions
	Itinerary (Id id, Id destination)
	Construct a new Itinerary object.
	Itinerary (Itinerary &&)=default
Itinerary &	operator= (Itinerary &&)=default
	Itinerary (const Itinerary &)=delete
Itinerary &	operator= (const Itinerary &)=delete
void	setPath (AdjacencyMatrix path)
	Set the itinerary's path.
Id	id () const
	Get the itinerary's id.
Id	destination () const
	Get the itinerary's destination.
std::unique_ptr< AdjacencyMatrix > const &	path () const
	Get the itinerary's path.

Detailed Description

The Itinerary class represents an itinerary in the network.

Template Parameters

Id	The type of the itinerary's id. It must be an unsigned integral type.

Constructor & Destructor Documentation

Itinerary()

dsm::Itinerary::Itinerary	(	Id	id,
		Id	destination )

Construct a new Itinerary object.

Parameters

destination

The itinerary's destination

Member Function Documentation

destination()

Id dsm::Itinerary::destination

(

)

const

Get the itinerary's destination.

Returns

Id, The itinerary's destination

id()

Id dsm::Itinerary::id

(

)

const

Get the itinerary's id.

Returns

Id, The itinerary's id

path()

std::unique_ptr< AdjacencyMatrix > const & dsm::Itinerary::path

(

)

const

Get the itinerary's path.

Returns

AdjacencyMatrix An adjacency matrix representing the itinerary's path

setPath()

void dsm::Itinerary::setPath

(

AdjacencyMatrix

path

)

Set the itinerary's path.

Parameters

path	An adjacency matrix made by a SparseMatrix representing the itinerary's path

Exceptions

std::invalid_argument,if

the itinerary's source or destination is not in the path's

---

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

• src/dsm/headers/Itinerary.hpp