1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
#pragma once
#include "routing/turns.hpp"
namespace routing
{
namespace turns
{
namespace sound
{
enum class LengthUnits
{
Undefined,
Meters,
Feet
};
string DebugPrint(LengthUnits const & lengthUnits);
/// \brief The Settings struct is a structure for gathering information about turn sound
/// notifications settings.
/// All distance parameters shall be set in m_lengthUnits. (Meters of feet for the time being.)
class Settings
{
uint32_t m_timeSeconds;
uint32_t m_minDistanceUnits;
uint32_t m_maxDistanceUnits;
/// \brief m_distancesToPronounce is a list of distances in m_lengthUnits
/// which are ready to be pronounced.
vector<uint32_t> m_soundedDistancesUnits;
LengthUnits m_lengthUnits;
public:
Settings()
: m_minDistanceUnits(0),
m_maxDistanceUnits(0),
m_soundedDistancesUnits(),
m_lengthUnits(LengthUnits::Undefined) {}
Settings(uint32_t notificationTimeSeconds, uint32_t minNotificationDistanceUnits,
uint32_t maxNotificationDistanceUnits, vector<uint32_t> const & soundedDistancesUnits,
LengthUnits lengthUnits)
: m_timeSeconds(notificationTimeSeconds),
m_minDistanceUnits(minNotificationDistanceUnits),
m_maxDistanceUnits(maxNotificationDistanceUnits),
m_soundedDistancesUnits(soundedDistancesUnits),
m_lengthUnits(lengthUnits)
{
ASSERT(!m_soundedDistancesUnits.empty(), ());
}
/// \brief IsValid checks if Settings data is consistent.
/// \warning The complexity is up to linear in size of m_soundedDistancesUnits.
bool IsValid() const;
/// \brief computes the distance an end user shall be informed about the future turn
/// before it, taking into account speedMetersPerSecond and fields of the structure.
/// \param speedMetersPerSecond is a speed. For example it could be a current speed of an end
/// user.
/// \return distance in units which are set in m_lengthUnits. (Meters of feet for the time being.)
double ComputeTurnDistance(double speedUnitsPerSecond) const;
/// \brief RoundByPresetSoundedDistancesUnits rounds off its parameter by
/// m_soundedDistancesUnits.
/// \param turnNotificationDistance is a distance in m_lengthUnits.
/// \return the distance which will be used (will be pronounced) in the next turn sound
/// notification in m_lengthUnits units. (Meters of feet for the time being.)
/// The result will be one of the m_soundedDistancesUnits values.
uint32_t RoundByPresetSoundedDistancesUnits(uint32_t turnNotificationUnits) const;
inline LengthUnits GetLengthUnits() const { return m_lengthUnits; }
inline void SetLengthUnits(LengthUnits units) { m_lengthUnits = units; }
double ConvertMetersPerSecondToUnitsPerSecond(double speedInMetersPerSecond) const;
double ConvertUnitsToMeters(double distanceInUnits) const;
};
/// \brief The Notification struct contains all the information about the next sound
/// notification to pronounce.
struct Notification
{
uint32_t m_distanceUnits;
uint8_t m_exitNum;
bool m_useThenInsteadOfDistance;
TurnDirection m_turnDir;
LengthUnits m_lengthUnits;
Notification(uint32_t distanceUnits, uint8_t exitNum, bool useThenInsteadOfDistance,
TurnDirection turnDir, LengthUnits lengthUnits)
: m_distanceUnits(distanceUnits),
m_exitNum(exitNum),
m_useThenInsteadOfDistance(useThenInsteadOfDistance),
m_turnDir(turnDir),
m_lengthUnits(lengthUnits)
{
}
bool operator==(Notification const & rhv) const
{
return m_distanceUnits == rhv.m_distanceUnits && m_exitNum == rhv.m_exitNum &&
m_useThenInsteadOfDistance == rhv.m_useThenInsteadOfDistance &&
m_turnDir == rhv.m_turnDir && m_lengthUnits == rhv.m_lengthUnits;
}
inline bool IsValid() const { return m_lengthUnits != LengthUnits::Undefined; }
};
string DebugPrint(Notification const & turnGeom);
using PairDist = pair<uint32_t, char const *>;
using VecPairDist = vector<PairDist>;
/// @return a reference to a vector of pairs of a distance in meters and a text id.
/// All the distances are translated in supported languages and can be pronounced.
VecPairDist const & GetAllSoundedDistMeters();
/// @return a reference to a vector of pairs of a distance in feet and a text id.
/// All the distances are translated in supported languages and can be pronounced.
VecPairDist const & GetAllSoundedDistFeet();
// @TODO(vbykoianko) Now GetSoundedDistMeters/Feet() functions returns a subset of
// the result of GetAllSoundedDistMeters/Feet() functions. So GetAllSoundedDistMeters/Feet()
// returns more distances.
// After the tuning of turn sound notification is finished to do
// * remove all unnecessary distances from GetAllSoundedDistMeters/Feet().
// * remove all unnecessary string form resources. It let us to reduce the size of apk/ipa by
// 10-20KB.
// * remove GetSoundedDistMeters/Feet() and use lambda in TurnsSound::SetLengthUnits
// to convert from vector<pair<uint32_t, char const *>> to vector<uint32_t>.
/// @return distance in meters which are used for turn sound generation.
vector<uint32_t> const & GetSoundedDistMeters();
/// @return distance in feet which are used for turn sound generation.
vector<uint32_t> const & GetSoundedDistFeet();
} // namespace sound
} // namespace turns
} // namespace routing
|
