LogLocationInformation Struct Reference

CPP API: mio::abm::LogLocationInformation Struct Reference
mio::abm::LogLocationInformation Struct Reference

Logger to log the LocationInformation of the simulation. More...

#include <common_abm_loggers.h>

Inheritance diagram for mio::abm::LogLocationInformation:
Collaboration diagram for mio::abm::LogLocationInformation:

Public Types

using Type = std::vector< std::tuple< mio::abm::LocationId, mio::abm::LocationType, mio::geo::GeographicalLocation, size_t, int > >
 

Static Public Member Functions

static Type log (const mio::abm::Simulation<> &sim)
 Log the LocationInformation of the simulation. More...
 

Additional Inherited Members

- Public Member Functions inherited from mio::LogOnce
template<class T >
bool should_log (const T &)
 For any type T, returns true on the first call only, and false thereafter. More...
 
- Public Attributes inherited from mio::LogOnce
bool was_logged = false
 Remember if this Logger was logged already. More...
 

Detailed Description

Logger to log the LocationInformation of the simulation.

Member Typedef Documentation

◆ Type

Member Function Documentation

◆ log()

static Type mio::abm::LogLocationInformation::log ( const mio::abm::Simulation<> &  sim)
inlinestatic

Log the LocationInformation of the simulation.

Parameters
[in]simThe simulation of the abm.
Returns
A vector of tuples with the LocationInformation, where each tuple contains the following information:
  1. The index of the location.
  2. The type of the location.
  3. The geographical location of the location.
  4. The number of cells in the location.
  5. The capacity of the location.