osmscout::NoOpTTSMessageGenerator Class Reference

#include <VoiceInstructionAgent.h>

Inheritance diagram for osmscout::NoOpTTSMessageGenerator:

Public Member Functions
std::optional< std::string >	GenerateMessage (const Distance &distanceFromStart, const VoiceMessageStruct &message, const VoiceMessageStruct &then) override
	Generate a spoken message for the given maneuver.
bool	SetLanguage (const std::string &languageCode) override
	Set the language of the generated messages.
void	SetUnits (DistanceUnitSystem units) override
	Set the distance units used for the announced distances.
void	SetVehicle (Vehicle vehicle) override
	Set the current vehicle.
	~NoOpTTSMessageGenerator () override=default
Public Member Functions inherited from osmscout::TTSMessageGenerator
virtual	~TTSMessageGenerator ()=default

Constructor & Destructor Documentation

~NoOpTTSMessageGenerator()

osmscout::NoOpTTSMessageGenerator::~NoOpTTSMessageGenerator ( )

overridedefault

Member Function Documentation

GenerateMessage()

std::optional< std::string > osmscout::NoOpTTSMessageGenerator::GenerateMessage ( const Distance &  distanceFromStart, const VoiceMessageStruct &  message, const VoiceMessageStruct &  then  )

inlineoverridevirtual

Generate a spoken message for the given maneuver.

Parameters

distanceFromStart	current position (distance from the route start). Together with the maneuver distance it defines how far ahead the maneuver is, which may be announced ("After 300 meters, ...") and controls the wording (e.g. a short roundabout phrase when close).
message	the maneuver to announce
then	optional following maneuver, only announced when close enough

Returns

the message text, or std::nullopt when there is nothing to say

Implements osmscout::TTSMessageGenerator.

SetLanguage()

bool osmscout::NoOpTTSMessageGenerator::SetLanguage ( const std::string &  languageCode )

inlineoverridevirtual

Set the language of the generated messages.

Parameters

languageCode

Returns

true if language is supported

Implements osmscout::TTSMessageGenerator.

SetUnits()

void osmscout::NoOpTTSMessageGenerator::SetUnits ( DistanceUnitSystem  units )

inlineoverridevirtual

Set the distance units used for the announced distances.

Implements osmscout::TTSMessageGenerator.

SetVehicle()

void osmscout::NoOpTTSMessageGenerator::SetVehicle ( Vehicle  vehicle )

inlineoverridevirtual

Set the current vehicle.

Implements osmscout::TTSMessageGenerator.

---

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

• VoiceInstructionAgent.h