SUMO - Simulation of Urban MObility
|
An O/D (origin/destination) matrix. More...
#include <ODMatrix.h>
Data Structures | |
class | cell_by_begin_sorter |
Used for sorting the cells by the begin time they describe. More... | |
class | descending_departure_comperator |
Used for sorting vehicles by their departure (latest first) More... | |
struct | ODVehicle |
An internal representation of a single vehicle. More... | |
Public Member Functions | |
void | add (SUMOReal vehicleNumber, SUMOTime begin, SUMOTime end, const std::string &origin, const std::string &destination, const std::string &vehicleType) |
Builds a single cell from the given values, verifying them. More... | |
void | applyCurve (const Distribution_Points &ps) |
Splits the stored cells dividing them on the given time line. More... | |
const std::vector< ODCell * > & | getCells () |
SUMOReal | getNoDiscarded () const |
Returns the number of discarded vehicles. More... | |
SUMOReal | getNoLoaded () const |
Returns the number of loaded vehicles. More... | |
SUMOReal | getNoWritten () const |
Returns the number of written vehicles. More... | |
void | loadMatrix (OptionsCont &oc) |
read a VISUM-matrix with the V Format More... | |
ODMatrix (const ODDistrictCont &dc) | |
Constructor. More... | |
Distribution_Points | parseTimeLine (const std::vector< std::string > &def, bool timelineDayInHours) |
split the given timeline More... | |
void | readO (LineReader &lr, SUMOReal scale, std::string vehType, bool matrixHasVehType) |
read a VISUM-matrix with the O Format More... | |
void | readV (LineReader &lr, SUMOReal scale, std::string vehType, bool matrixHasVehType) |
read a VISUM-matrix with the V Format More... | |
void | write (SUMOTime begin, const SUMOTime end, OutputDevice &dev, const bool uniform, const bool noVtype, const std::string &prefix, const bool stepLog) |
Writes the vehicles stored in the matrix assigning the sources and sinks. More... | |
void | writeDefaultAttrs (OutputDevice &dev, const bool noVtype, const ODCell *const cell) |
Helper function for flow and trip output writing the depart and arrival attributes. More... | |
void | writeFlows (const SUMOTime begin, const SUMOTime end, OutputDevice &dev, const bool noVtype, const std::string &prefix) |
Writes the flows stored in the matrix. More... | |
~ODMatrix () | |
Destructor. More... | |
Protected Member Functions | |
void | applyCurve (const Distribution_Points &ps, ODCell *cell, std::vector< ODCell * > &newCells) |
Splits the given cell dividing it on the given time line and storing the results in the given container. More... | |
SUMOReal | computeDeparts (ODCell *cell, size_t &vehName, std::vector< ODVehicle > &into, bool uniform, const std::string &prefix) |
Computes the vehicle departs stored in the given cell and saves them in "into". More... | |
Protected Attributes | |
std::vector< ODCell * > | myContainer |
The loaded cells. More... | |
const ODDistrictCont & | myDistricts |
The districts to retrieve sources/sinks from. More... | |
SUMOReal | myNoDiscarded |
Number of discarded vehicles. More... | |
SUMOReal | myNoLoaded |
Number of loaded vehicles. More... | |
SUMOReal | myNoWritten |
Number of written vehicles. More... | |
Private Member Functions | |
std::string | getNextNonCommentLine (LineReader &lr) |
ODMatrix (const ODMatrix &s) | |
invalid copy constructor More... | |
ODMatrix & | operator= (const ODMatrix &s) |
invalid assignment operator More... | |
SUMOTime | parseSingleTime (const std::string &time) |
SUMOReal | readFactor (LineReader &lr, SUMOReal scale) |
std::pair< SUMOTime, SUMOTime > | readTime (LineReader &lr) |
An O/D (origin/destination) matrix.
This class is the internal representation of a loaded O/D-matrix. Beside being the storage for ODCells, the matrix also contains information about the numbers of loaded, discarded, and written vehicles.
The matrix has a reference to the container of districts stored. This allows to validate added cell descriptions in means that using existing origins/ destinations only is assured.
In addition of being a storage, the matrix is also responsible for writing the results and contains methods for splitting the entries over time.
Definition at line 73 of file ODMatrix.h.
ODMatrix::ODMatrix | ( | const ODDistrictCont & | dc) |
Constructor.
[in] | dc | The district container to obtain referenced distrivts from |
Definition at line 58 of file ODMatrix.cpp.
ODMatrix::~ODMatrix | ( | ) |
|
private |
invalid copy constructor
void ODMatrix::add | ( | SUMOReal | vehicleNumber, |
SUMOTime | begin, | ||
SUMOTime | end, | ||
const std::string & | origin, | ||
const std::string & | destination, | ||
const std::string & | vehicleType | ||
) |
Builds a single cell from the given values, verifying them.
At first, the number of loaded vehicles (myNoLoaded) is incremented by vehicleNumber.
It is checked whether both the origin and the destination exist within the assigned district container (myDistricts). If one of them is missing, an error is generated, if both, a warning, because in the later case the described flow may lay completely beside the processed area. In both cases the given number of vehicles (vehicleNumber) is added to myNoDiscarded.
If the origin/destination districts are known, a cell is built using the given values. This cell is added to the list of known cells (myContainer).
[in] | vehicleNumber | The number of vehicles to store within the cell |
[in] | begin | The begin of the interval the cell is valid for |
[in] | end | The end of the interval the cell is valid for |
[in] | origin | The origin district to use for the cell's flows |
[in] | destination | The destination district to use for the cell's flows |
[in] | vehicleType | The vehicle type to use for the cell's flows |
Definition at line 71 of file ODMatrix.cpp.
References ODCell::begin, ODCell::destination, ODCell::end, NamedObjectCont< T >::get(), myContainer, myDistricts, myNoDiscarded, myNoLoaded, ODCell::origin, ODDistrict::sinkNumber(), ODDistrict::sourceNumber(), toString(), ODCell::vehicleNumber, ODCell::vehicleType, WRITE_ERROR, and WRITE_WARNING.
void ODMatrix::applyCurve | ( | const Distribution_Points & | ps) |
Splits the stored cells dividing them on the given time line.
Definition at line 460 of file ODMatrix.cpp.
References myContainer.
Referenced by main().
|
protected |
Splits the given cell dividing it on the given time line and storing the results in the given container.
For the given cell, a list of clones is generated. The number of these is equal to the number of "areas" within the given distribution description (time line in this case) and each clone's vehicleNumber is equal to the given cell's vehicle number multiplied with the area's probability. The clones are stored in the given cell vector.
[in] | ps | The time line to apply |
[in] | cell | The cell to split |
[out] | newCells | The storage to put generated cells into |
Definition at line 445 of file ODMatrix.cpp.
References ODCell::begin, ODCell::destination, ODCell::end, Distribution_Points::getAreaBegin(), Distribution_Points::getAreaEnd(), Distribution_Points::getAreaNo(), Distribution_Points::getAreaPerc(), ODCell::origin, TIME2STEPS, ODCell::vehicleNumber, and ODCell::vehicleType.
|
protected |
Computes the vehicle departs stored in the given cell and saves them in "into".
At first, the number of vehicles to insert is computed using the integer value of the vehicleNumber information from the given cell. In the case vehicleNumber has a fraction, an additional vehicle may be added in the case a chosen random number is lower than this fraction.
If uniform is true, the departure times of the generated vehicles are spread uniformly, otherwise the departure time are chosen randomly from the interval.
The vehicle names are generated by putting the value of vehName after the given prefix. The value of vehName is incremented with each generated vehicle.
The number of left vehicles (the fraction if no additional vehicle was generated) is returned.
[in] | cell | The cell to use |
[in,out] | vehName | An incremented index of the generated vehicle |
[out] | into | The storage to put generated vehicles into |
[in] | uniform | Information whether departure times shallbe uniformly spread or random |
[in] | prefix | A prefix for the vehicle names |
Definition at line 105 of file ODMatrix.cpp.
References ODCell::begin, ODMatrix::ODVehicle::cell, ODMatrix::ODVehicle::depart, ODCell::destination, ODCell::end, ODMatrix::ODVehicle::from, ODDistrictCont::getRandomSinkFromDistrict(), ODDistrictCont::getRandomSourceFromDistrict(), ODMatrix::ODVehicle::id, myDistricts, ODCell::origin, RandHelper::rand(), SUMOReal, ODMatrix::ODVehicle::to, toString(), and ODCell::vehicleNumber.
Referenced by write().
|
inline |
Definition at line 218 of file ODMatrix.h.
References myContainer.
|
private |
in the functions readV and readO
Definition at line 255 of file ODMatrix.cpp.
References LineReader::good(), LineReader::hasMore(), StringUtils::prune(), and LineReader::readLine().
Referenced by readFactor(), readO(), readTime(), and readV().
SUMOReal ODMatrix::getNoDiscarded | ( | ) | const |
Returns the number of discarded vehicles.
Returns the value of myNoDiscarded
Definition at line 439 of file ODMatrix.cpp.
References myNoDiscarded.
Referenced by main().
SUMOReal ODMatrix::getNoLoaded | ( | ) | const |
Returns the number of loaded vehicles.
Returns the value of myNoLoaded
Definition at line 427 of file ODMatrix.cpp.
References myNoLoaded.
Referenced by main().
SUMOReal ODMatrix::getNoWritten | ( | ) | const |
Returns the number of written vehicles.
Returns the value of myNoWritten
Definition at line 433 of file ODMatrix.cpp.
References myNoWritten.
Referenced by main().
void ODMatrix::loadMatrix | ( | OptionsCont & | oc) |
read a VISUM-matrix with the V Format
Definition at line 472 of file ODMatrix.cpp.
References OptionsCont::getFloat(), OptionsCont::getString(), OptionsCont::getStringVector(), LineReader::good(), LineReader::readLine(), readO(), and readV().
Referenced by main().
|
private |
in the functions readV and readO
Definition at line 268 of file ODMatrix.cpp.
References TplConvert::_2int(), and TIME2STEPS.
Referenced by readTime().
Distribution_Points ODMatrix::parseTimeLine | ( | const std::vector< std::string > & | def, |
bool | timelineDayInHours | ||
) |
split the given timeline
Definition at line 510 of file ODMatrix.cpp.
References TplConvert::_2int(), TplConvert::_2SUMOReal(), StringTokenizer::next(), PositionVector::push_back(), StringTokenizer::size(), SUMOReal, and toString().
Referenced by main().
|
private |
in the functions readV and readO
Definition at line 297 of file ODMatrix.cpp.
References TplConvert::_2SUMOReal(), getNextNonCommentLine(), and SUMOReal.
void ODMatrix::readO | ( | LineReader & | lr, |
SUMOReal | scale, | ||
std::string | vehType, | ||
bool | matrixHasVehType | ||
) |
read a VISUM-matrix with the O Format
Definition at line 377 of file ODMatrix.cpp.
References TplConvert::_2int(), TplConvert::_2SUMOReal(), add(), LineReader::getFileName(), getNextNonCommentLine(), LineReader::hasMore(), StringTokenizer::next(), PROGRESS_BEGIN_MESSAGE, PROGRESS_DONE_MESSAGE, StringUtils::prune(), readFactor(), readTime(), StringTokenizer::size(), SUMOReal, toString(), and StringTokenizer::WHITECHARS.
Referenced by loadMatrix().
|
private |
in the functions readV and readO
Definition at line 279 of file ODMatrix.cpp.
References getNextNonCommentLine(), StringTokenizer::next(), parseSingleTime(), and StringTokenizer::WHITECHARS.
void ODMatrix::readV | ( | LineReader & | lr, |
SUMOReal | scale, | ||
std::string | vehType, | ||
bool | matrixHasVehType | ||
) |
read a VISUM-matrix with the V Format
Definition at line 309 of file ODMatrix.cpp.
References TplConvert::_2int(), TplConvert::_2SUMOReal(), add(), LineReader::getFileName(), getNextNonCommentLine(), LineReader::hasMore(), StringTokenizer::hasNext(), StringTokenizer::next(), PROGRESS_BEGIN_MESSAGE, PROGRESS_DONE_MESSAGE, StringUtils::prune(), readFactor(), readTime(), SUMOReal, and StringTokenizer::WHITECHARS.
Referenced by loadMatrix().
void ODMatrix::write | ( | SUMOTime | begin, |
const SUMOTime | end, | ||
OutputDevice & | dev, | ||
const bool | uniform, | ||
const bool | noVtype, | ||
const std::string & | prefix, | ||
const bool | stepLog | ||
) |
Writes the vehicles stored in the matrix assigning the sources and sinks.
The cells stored in myContainer are sorted, first. Then, for each time step to generate vehicles for, it is checked whether the topmost cell is valid for this time step. If so, vehicles are generated from this cell's description using "computeDeparts" and stored in an internal vector. The pointer is moved and the check is repeated until the current cell is not valid for the current time or no further cells exist.
Then, for the current time step, the internal list of vehicles is sorted and all vehicles that start within this time step are written.
The left fraction of vehicles to insert is saved for each O/D-dependency over time and the number of vehicles to generate is increased as soon as this value is larger than 1, decrementing it.
[in] | begin | The begin time to generate vehicles for |
[in] | end | The end time to generate vehicles for |
[in] | dev | The stream to write the generated vehicle trips to |
[in] | uniform | Information whether departure times shallbe uniformly spread or random |
[in] | noVtype | Whether vtype information shall not be written |
[in] | prefix | A prefix for the vehicle names |
[in] | stepLog | Whether processed time shall be written |
Definition at line 165 of file ODMatrix.cpp.
References OutputDevice::closeTag(), computeDeparts(), DELTA_T, MAX2(), myContainer, myNoWritten, OutputDevice::openTag(), SUMO_ATTR_DEPART, SUMO_ATTR_FROM, SUMO_ATTR_ID, SUMO_ATTR_TO, SUMO_TAG_TRIP, SUMOReal, time2string(), OutputDevice::writeAttr(), and writeDefaultAttrs().
Referenced by main().
void ODMatrix::writeDefaultAttrs | ( | OutputDevice & | dev, |
const bool | noVtype, | ||
const ODCell *const | cell | ||
) |
Helper function for flow and trip output writing the depart and arrival attributes.
[in] | dev | The stream to write the generated vehicle trips to |
[in] | noVtype | Whether vtype information shall not be written |
[in] | cell | The OD cell containing the vtype |
Definition at line 136 of file ODMatrix.cpp.
References ODCell::destination, OptionsCont::getOptions(), OptionsCont::getString(), OptionsCont::isSet(), ODCell::origin, SUMO_ATTR_ARRIVALLANE, SUMO_ATTR_ARRIVALPOS, SUMO_ATTR_ARRIVALSPEED, SUMO_ATTR_DEPARTLANE, SUMO_ATTR_DEPARTPOS, SUMO_ATTR_DEPARTSPEED, SUMO_ATTR_FROM_TAZ, SUMO_ATTR_TO_TAZ, SUMO_ATTR_TYPE, ODCell::vehicleType, and OutputDevice::writeAttr().
Referenced by write(), and writeFlows().
void ODMatrix::writeFlows | ( | const SUMOTime | begin, |
const SUMOTime | end, | ||
OutputDevice & | dev, | ||
const bool | noVtype, | ||
const std::string & | prefix | ||
) |
Writes the flows stored in the matrix.
[in] | begin | The begin time to generate vehicles for |
[in] | end | The end time to generate vehicles for |
[in] | dev | The stream to write the generated vehicle trips to |
[in] | noVtype | Whether vtype information shall not be written |
[in] | prefix | A prefix for the flow names |
Definition at line 232 of file ODMatrix.cpp.
References ODCell::begin, OutputDevice::closeTag(), ODCell::end, myContainer, OutputDevice::openTag(), SUMO_ATTR_BEGIN, SUMO_ATTR_END, SUMO_ATTR_ID, SUMO_ATTR_NUMBER, SUMO_TAG_FLOW, time2string(), toString(), ODCell::vehicleNumber, OutputDevice::writeAttr(), and writeDefaultAttrs().
Referenced by main().
|
protected |
The loaded cells.
Definition at line 314 of file ODMatrix.h.
Referenced by add(), applyCurve(), getCells(), write(), writeFlows(), and ~ODMatrix().
|
protected |
The districts to retrieve sources/sinks from.
Definition at line 317 of file ODMatrix.h.
Referenced by add(), and computeDeparts().
|
protected |
Number of discarded vehicles.
Definition at line 326 of file ODMatrix.h.
Referenced by add(), and getNoDiscarded().
|
protected |
Number of loaded vehicles.
Definition at line 320 of file ODMatrix.h.
Referenced by add(), and getNoLoaded().
|
protected |
Number of written vehicles.
Definition at line 323 of file ODMatrix.h.
Referenced by getNoWritten(), and write().