onboardapi  9.10.0
by Rheinmetall
M_LanguageManager::IClient Class Reference

Public Member Functions

virtual ~IClient ()
 
virtual void ReportLanguageManagerSettings (M_LanguageManager::LanguageManagerSettingsType const &Settings)
 
virtual void ReportLanguageManagerStatus (M_LanguageManager::LanguageManagerStatusType const &Status, bool IsRemoved)
 
virtual void ReportTranslations (std::string const &KeyDefaultLanguageText, M_LanguageManager::TextListType const &Translations, bool IsRemoved)
 

Detailed Description

Language manager client interface. Contains callback operations from the language manager service to the client.

Constructor & Destructor Documentation

◆ ~IClient()

M_LanguageManager::IClient::~IClient ( )
virtual

Member Function Documentation

◆ ReportLanguageManagerSettings()

void M_LanguageManager::IClient::ReportLanguageManagerSettings ( M_LanguageManager::LanguageManagerSettingsType const &  Settings)
virtual

Report static settings. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters
SettingsSettings of the language manager.

◆ ReportLanguageManagerStatus()

void M_LanguageManager::IClient::ReportLanguageManagerStatus ( M_LanguageManager::LanguageManagerStatusType const &  Status,
bool  IsRemoved 
)
virtual

Report current status.

Parameters
StatusCurrent status of the language manager.
IsRemovedIndicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

◆ ReportTranslations()

void M_LanguageManager::IClient::ReportTranslations ( std::string const &  KeyDefaultLanguageText,
M_LanguageManager::TextListType const &  Translations,
bool  IsRemoved 
)
virtual

Report translations of specified items.

Parameters
KeyDefaultLanguageTextThe text in the default language to be translated into other languages. Note: This field serves at the same time as a lookup key for the translation tables.
TranslationsTranslated texts.
IsRemovedIndicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.