Dynamical system model
Loading...
Searching...
No Matches
dsf::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
 
Itineraryoperator= (Itinerary &&)=default
 
 Itinerary (const Itinerary &)=delete
 
Itineraryoperator= (const Itinerary &)=delete
 
void load (const std::string &fileName)
 
void setPath (std::unordered_map< Id, std::vector< Id > > path)
 Set the itinerary's path.
 
Id id () const
 Get the itinerary's id.
 
Id destination () const
 Get the itinerary's destination.
 
std::unordered_map< Id, std::vector< Id > > const & path () const
 Get the itinerary's path.
 
void save (const std::string &fileName) const
 

Detailed Description

The Itinerary class represents an itinerary in the network.

Template Parameters
IdThe type of the itinerary's id. It must be an unsigned integral type.

Constructor & Destructor Documentation

◆ Itinerary()

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

Construct a new Itinerary object.

Parameters
destinationThe itinerary's destination

Member Function Documentation

◆ destination()

Id dsf::Itinerary::destination ( ) const

Get the itinerary's destination.

Returns
Id, The itinerary's destination

◆ id()

Id dsf::Itinerary::id ( ) const

Get the itinerary's id.

Returns
Id, The itinerary's id

◆ path()

std::unordered_map< Id, std::vector< Id > > const & dsf::Itinerary::path ( ) const

Get the itinerary's path.

Returns
std::unordered_map<Id, std::vector<Id>> const&, The itinerary's path

◆ setPath()

void dsf::Itinerary::setPath ( std::unordered_map< Id, std::vector< Id > > path)

Set the itinerary's path.

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

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