summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLitvinenkoIra <ilytvynenko@luxoft.com>2020-02-21 11:38:06 +0200
committerLitvinenkoIra <ilytvynenko@luxoft.com>2020-02-21 11:51:57 +0200
commit8a09898be74e4d2bd265c73540ad7b0609b05db6 (patch)
tree03961a9791f100a2c15444a3f2bc5c92d551b972
parent84148c95b06493d636b973b91f3eea1e07d737be (diff)
downloadsdl_core-8a09898be74e4d2bd265c73540ad7b0609b05db6.tar.gz
Fix doxygen
-rw-r--r--src/components/application_manager/include/application_manager/hmi_capabilities_impl.h305
-rw-r--r--src/components/include/application_manager/hmi_capabilities.h178
2 files changed, 67 insertions, 416 deletions
diff --git a/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h b/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h
index 3879aada7a..d1f01d5ce1 100644
--- a/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h
+++ b/src/components/application_manager/include/application_manager/hmi_capabilities_impl.h
@@ -46,32 +46,19 @@ class ApplicationManager;
class HMICapabilitiesImpl : public HMICapabilities {
public:
- /*
+ /**
* @ Class constructor
- *
* @param app_mngr Application manager pointer
*/
explicit HMICapabilitiesImpl(ApplicationManager& app_mngr);
- /*
+ /**
* @brief Class destructor
- *
*/
virtual ~HMICapabilitiesImpl();
- /*
- * @brief Checks is image type(Static/Dynamic) requested by
- * Mobile Device is supported on current HMI.
- * @param image_type recieved type of image from Enum.
- * @return Bool true if supported
- */
bool VerifyImageType(const int32_t image_type) const OVERRIDE;
- /**
- * @brief Checks if all HMI capabilities received
- *
- * @return TRUE if all information received, otherwise FALSE
- */
bool is_vr_cooperating() const OVERRIDE;
void set_is_vr_cooperating(const bool value) OVERRIDE;
@@ -90,414 +77,137 @@ class HMICapabilitiesImpl : public HMICapabilities {
bool is_rc_cooperating() const OVERRIDE;
void set_is_rc_cooperating(const bool value) OVERRIDE;
- /*
- * @brief Interface used to store information about software version of the
- *target
- *
- * @param ccpu_version Received system/hmi software version
- */
void set_ccpu_version(const std::string& ccpu_version) OVERRIDE;
- /*
- * @brief Returns software version of the target
- *
- * @return TRUE if it supported, otherwise FALSE
- */
const std::string& ccpu_version() const OVERRIDE;
- /*
- * @brief Retrieves if mixing audio is supported by HMI
- * (ie recording TTS command and playing audio)
- *
- * @return Current state of the mixing audio flag
- */
bool attenuated_supported() const OVERRIDE;
- /*
- * @brief Sets state for mixing audio
- *
- * @param state New state to be set
- */
void set_attenuated_supported(const bool state) OVERRIDE;
- /*
- * @brief Retrieves currently active UI language
- *
- * @return Currently active UI language
- */
const hmi_apis::Common_Language::eType active_ui_language() const OVERRIDE;
- /*
- * @brief Sets currently active UI language
- *
- * @param language Currently active UI language
- */
void set_active_ui_language(
const hmi_apis::Common_Language::eType language) OVERRIDE;
- /*
- * @brief Retrieves UI supported languages
- *
- * @return Currently supported UI languages
- */
const smart_objects::SmartObjectSPtr ui_supported_languages() const OVERRIDE;
- /*
- * @brief Sets supported UI languages
- *
- * @param supported_languages Supported UI languages
- */
void set_ui_supported_languages(
const smart_objects::SmartObject& supported_languages) OVERRIDE;
- /*
- * @brief Retrieves currently active VR language
- *
- * @return Currently active VR language
- */
const hmi_apis::Common_Language::eType active_vr_language() const OVERRIDE;
- /*
- * @brief Sets currently active VR language
- *
- * @param language Currently active VR language
- */
void set_active_vr_language(
const hmi_apis::Common_Language::eType language) OVERRIDE;
- /*
- * @brief Retrieves VR supported languages
- *
- * @return Currently supported VR languages
- */
const smart_objects::SmartObjectSPtr vr_supported_languages() const OVERRIDE;
- /*
- * @brief Sets supported VR languages
- *
- * @param supported_languages Supported VR languages
- */
void set_vr_supported_languages(
const smart_objects::SmartObject& supported_languages) OVERRIDE;
- /*
- * @brief Retrieves currently active TTS language
- *
- * @return Currently active TTS language
- */
const hmi_apis::Common_Language::eType active_tts_language() const OVERRIDE;
- /*
- * @brief Sets currently active TTS language
- *
- * @param language Currently active TTS language
- */
void set_active_tts_language(
const hmi_apis::Common_Language::eType language) OVERRIDE;
- /*
- * @brief Retrieves TTS supported languages
- *
- * @return Currently supported TTS languages
- */
const smart_objects::SmartObjectSPtr tts_supported_languages() const OVERRIDE;
- /*
- * @brief Sets supported TTS languages
- *
- * @param supported_languages Supported TTS languages
- */
void set_tts_supported_languages(
const smart_objects::SmartObject& supported_languages) OVERRIDE;
- /*
- * @brief Retrieves information about the display capabilities
- *
- * @return Currently supported display capabilities
- */
const smart_objects::SmartObjectSPtr display_capabilities() const OVERRIDE;
- /*
- * @brief Sets supported display capabilities
- *
- * @param display_capabilities supported display capabilities
- */
void set_display_capabilities(
const smart_objects::SmartObject& display_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the display capability
- * @return Currently supported display capability
- */
const smart_objects::SmartObjectSPtr system_display_capabilities()
const OVERRIDE;
- /*
- * @brief Sets supported display capability
- * @param display_capabilities supported display capability
- */
void set_system_display_capabilities(
const smart_objects::SmartObject& display_capabilities);
- /*
- * @brief Retrieves information about the HMI zone capabilities
- *
- * @return Currently supported HMI zone capabilities
- */
const smart_objects::SmartObjectSPtr hmi_zone_capabilities() const OVERRIDE;
- /*
- * @brief Sets supported HMI zone capabilities
- *
- * @param hmi_zone_capabilities supported HMI zone capabilities
- */
void set_hmi_zone_capabilities(
const smart_objects::SmartObject& hmi_zone_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the SoftButton's capabilities
- *
- * @return Currently supported SoftButton's capabilities
- */
const smart_objects::SmartObjectSPtr soft_button_capabilities()
const OVERRIDE;
- /*
- * @brief Sets supported SoftButton's capabilities
- *
- * @param soft_button_capabilities supported SoftButton's capabilities
- */
void set_soft_button_capabilities(
const smart_objects::SmartObject& soft_button_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the Button's capabilities
- *
- * @return Currently supported Button's capabilities
- */
const smart_objects::SmartObjectSPtr button_capabilities() const OVERRIDE;
- /*
- * @brief Sets supported Button's capabilities
- *
- * @param soft_button_capabilities supported Button's capabilities
- */
void set_button_capabilities(
const smart_objects::SmartObject& button_capabilities) OVERRIDE;
- /*
- * @brief Sets supported speech capabilities
- *
- * @param speech_capabilities supported speech capabilities
- */
void set_speech_capabilities(
const smart_objects::SmartObject& speech_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the speech capabilities
- *
- * @return Currently supported speech capabilities
- */
const smart_objects::SmartObjectSPtr speech_capabilities() const OVERRIDE;
- /*
- * @brief Sets supported VR capabilities
- *
- * @param vr_capabilities supported VR capabilities
- */
void set_vr_capabilities(
const smart_objects::SmartObject& vr_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the VR capabilities
- *
- * @return Currently supported VR capabilities
- */
const smart_objects::SmartObjectSPtr vr_capabilities() const OVERRIDE;
- /*
- * @brief Sets supported audio_pass_thru capabilities
- *
- * @param vr_capabilities supported audio_pass_thru capabilities
- */
void set_audio_pass_thru_capabilities(
const smart_objects::SmartObject& audio_pass_thru_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the audio_pass_thru capabilities
- *
- * @return Currently supported audio_pass_thru capabilities
- */
const smart_objects::SmartObjectSPtr audio_pass_thru_capabilities()
const OVERRIDE;
- /*
- * @brief Sets supported pcm_stream capabilities
- *
- * @param supported pcm_stream capabilities
- */
void set_pcm_stream_capabilities(
const smart_objects::SmartObject& pcm_stream_capabilities) OVERRIDE;
- /*
- * @brief Retrieves information about the pcm_stream capabilities
- *
- * @return Currently supported pcm_streaming capabilities
- */
const smart_objects::SmartObjectSPtr pcm_stream_capabilities() const OVERRIDE;
- /*
- * @brief Retrieves information about the preset bank capabilities
- *
- * @return Currently supported preset bank capabilities
- */
const smart_objects::SmartObjectSPtr preset_bank_capabilities()
const OVERRIDE;
- /*
- * @brief Sets supported preset bank capabilities
- *
- * @param soft_button_capabilities supported preset bank capabilities
- */
void set_preset_bank_capabilities(
const smart_objects::SmartObject& preset_bank_capabilities) OVERRIDE;
- /*
- * @brief Sets vehicle information(make, model, modelYear)
- *
- * @param vehicle_type Cuurent vehicle information
- */
void set_vehicle_type(
const smart_objects::SmartObject& vehicle_type) OVERRIDE;
- /*
- * @brief Retrieves vehicle information(make, model, modelYear)
- *
- * @param vehicle_type Cuurent vehicle information
- */
const smart_objects::SmartObjectSPtr vehicle_type() const OVERRIDE;
- /*
- * @brief Retrieves information about the prerecorded speech
- *
- * @return Currently supported prerecorded speech
- */
const smart_objects::SmartObjectSPtr prerecorded_speech() const OVERRIDE;
- /*
- * @brief Sets supported prerecorded speech
- *
- * @param prerecorded_speech supported prerecorded speech
- */
void set_prerecorded_speech(
const smart_objects::SmartObject& prerecorded_speech) OVERRIDE;
- /*
- * @brief Interface used to store information if navigation
- * supported by the system
- *
- * @param supported Indicates if navigation supported by the system
- */
void set_navigation_supported(const bool supported) OVERRIDE;
- /*
- * @brief Retrieves information if navi supported by the system
- *
- * @return TRUE if it supported, otherwise FALSE
- */
bool navigation_supported() const OVERRIDE;
- /*
- * @brief Interface used to store information if phone call
- * supported by the system
- *
- * @param supported Indicates if navigation supported by the sustem
- */
void set_phone_call_supported(const bool supported) OVERRIDE;
- /*
- * @brief Retrieves information if phone call supported by the system
- *
- * @return TRUE if it supported, otherwise FALSE
- */
bool phone_call_supported() const OVERRIDE;
- /*
- * @brief Interface to store whether HMI supports video streaming
- *
- * @param supported Indicates whether video streaming is supported by HMI
- */
void set_video_streaming_supported(const bool supported) OVERRIDE;
- /*
- * @brief Retrieves whether HMI supports video streaming
- *
- * @return TRUE if it supported, otherwise FALSE
- */
bool video_streaming_supported() const OVERRIDE;
- /*
- * @brief Interface to store whether HMI supports remote control
- *
- * @param supported Indicates whether video streaming is supported by HMI
- */
void set_rc_supported(const bool supported) OVERRIDE;
- /*
- * @brief Retrieves whether HMI supports remote control
- *
- * @return TRUE if it supported, otherwise FALSE
- */
bool rc_supported() const OVERRIDE;
- /*
- * @brief Interface used to store information regarding
- * the navigation "System Capability"
- *
- * @param navigation_capability contains information related
- * to the navigation system capability.
- */
void set_navigation_capability(
const smart_objects::SmartObject& navigation_capability) OVERRIDE;
- /*
- * @brief Retrieves information regarding the navigation system capability
- *
- * @return NAVIGATION system capability
- */
const smart_objects::SmartObjectSPtr navigation_capability() const OVERRIDE;
- /*
- * @brief Interface used to store information regarding
- * the phone "System Capability"
- *
- * @param phone_capability contains information related
- * to the phone system capability.
- */
void set_phone_capability(
const smart_objects::SmartObject& phone_capability) OVERRIDE;
- /*
- * @brief Retrieves information regarding the phone call system capability
- *
- * @return PHONE_CALL system capability
- */
-
const smart_objects::SmartObjectSPtr phone_capability() const OVERRIDE;
- /*
- * @brief Sets HMI's video streaming related capability information
- *
- * @param video_streaming_capability the video streaming related capabilities
- */
void set_video_streaming_capability(
const smart_objects::SmartObject& video_streaming_capability) OVERRIDE;
- /*
- * @brief Retrieves HMI's video streaming related capabilities
- *
- * @return HMI's video streaming related capability information
- */
const smart_objects::SmartObjectSPtr video_streaming_capability()
const OVERRIDE;
@@ -517,17 +227,8 @@ class HMICapabilitiesImpl : public HMICapabilities {
DEPRECATED
void Init(resumption::LastState* last_state) OVERRIDE;
- /*
- * @brief return component which follows for correctness of
- * languages
- * @return HMI language handler
- */
HMILanguageHandler& get_hmi_language_handler() OVERRIDE;
- /**
- * @brief Trigger waiting for response
- * @param request Request object
- */
void set_handle_response_for(
const smart_objects::SmartObject& request) OVERRIDE;
@@ -538,7 +239,7 @@ class HMICapabilitiesImpl : public HMICapabilities {
void DeleteCachedCapabilitiesFile() const OVERRIDE;
protected:
- /*
+ /**
* @brief Loads capabilities from local file in case SDL was launched
* without HMI
*
diff --git a/src/components/include/application_manager/hmi_capabilities.h b/src/components/include/application_manager/hmi_capabilities.h
index 75326f2039..48da79444e 100644
--- a/src/components/include/application_manager/hmi_capabilities.h
+++ b/src/components/include/application_manager/hmi_capabilities.h
@@ -46,9 +46,8 @@ class ApplicationManager;
class HMICapabilities {
public:
- /*
+ /**
* @brief Class destructor
- *
*/
virtual ~HMICapabilities() {}
@@ -59,7 +58,7 @@ class HMICapabilities {
*/
virtual HMILanguageHandler& get_hmi_language_handler() = 0;
- /*
+ /**
* @brief Checks if image type(Static/Dynamic) requested by
* Mobile Device is supported on current HMI.
* @param image_type received type of image from Enum.
@@ -69,7 +68,6 @@ class HMICapabilities {
/**
* @brief Checks if all HMI capabilities received
- *
* @return TRUE if all information received, otherwise FALSE
*/
virtual bool is_vr_cooperating() const = 0;
@@ -90,418 +88,366 @@ class HMICapabilities {
virtual bool is_rc_cooperating() const = 0;
virtual void set_is_rc_cooperating(const bool value) = 0;
- /*
+ /**
* @brief Interface used to store information about software version of the
- *target
- *
+ * target
* @param ccpu_version Received system/hmi software version
*/
virtual void set_ccpu_version(const std::string& ccpu_version) = 0;
- /*
+ /**
* @brief Returns software version of the target
- *
* @return TRUE if it supported, otherwise FALSE
*/
virtual const std::string& ccpu_version() const = 0;
- /*
+ /**
* @brief Retrieves if mixing audio is supported by HMI
* (ie recording TTS command and playing audio)
- *
* @return Current state of the mixing audio flag
*/
virtual bool attenuated_supported() const = 0;
- /*
+ /**
* @brief Sets state for mixing audio
- *
* @param state New state to be set
*/
virtual void set_attenuated_supported(const bool state) = 0;
- /*
+ /**
* @brief Retrieves currently active UI language
- *
* @return Currently active UI language
*/
virtual const hmi_apis::Common_Language::eType active_ui_language() const = 0;
- /*
+ /**
* @brief Sets currently active UI language
- *
* @param language Currently active UI language
*/
virtual void set_active_ui_language(
const hmi_apis::Common_Language::eType language) = 0;
- /*
+ /**
* @brief Retrieves UI supported languages
- *
* @return Currently supported UI languages
*/
virtual const smart_objects::SmartObjectSPtr ui_supported_languages()
const = 0;
- /*
+ /**
* @brief Sets supported UI languages
- *
* @param supported_languages Supported UI languages
*/
virtual void set_ui_supported_languages(
const smart_objects::SmartObject& supported_languages) = 0;
- /*
+ /**
* @brief Retrieves currently active VR language
- *
* @return Currently active VR language
*/
virtual const hmi_apis::Common_Language::eType active_vr_language() const = 0;
- /*
+ /**
* @brief Sets currently active VR language
- *
* @param language Currently active VR language
*/
virtual void set_active_vr_language(
const hmi_apis::Common_Language::eType language) = 0;
- /*
+ /**
* @brief Retrieves VR supported languages
- *
* @return Currently supported VR languages
*/
virtual const smart_objects::SmartObjectSPtr vr_supported_languages()
const = 0;
- /*
+ /**
* @brief Sets supported VR languages
- *
* @param supported_languages Supported VR languages
*/
virtual void set_vr_supported_languages(
const smart_objects::SmartObject& supported_languages) = 0;
- /*
+ /**
* @brief Retrieves currently active TTS language
- *
* @return Currently active TTS language
*/
virtual const hmi_apis::Common_Language::eType active_tts_language()
const = 0;
- /*
+ /**
* @brief Sets currently active TTS language
- *
* @param language Currently active TTS language
*/
virtual void set_active_tts_language(
const hmi_apis::Common_Language::eType language) = 0;
- /*
+ /**
* @brief Retrieves TTS supported languages
- *
* @return Currently supported TTS languages
*/
virtual const smart_objects::SmartObjectSPtr tts_supported_languages()
const = 0;
- /*
+ /**
* @brief Sets supported TTS languages
- *
* @param supported_languages Supported TTS languages
*/
virtual void set_tts_supported_languages(
const smart_objects::SmartObject& supported_languages) = 0;
- /*
+ /**
* @brief Retrieves information about the display capabilities
- *
* @return Currently supported display capabilities
*/
virtual const smart_objects::SmartObjectSPtr display_capabilities() const = 0;
- /*
+ /**
* @brief Sets supported display capabilities
- *
* @param display_capabilities supported display capabilities
*/
virtual void set_display_capabilities(
const smart_objects::SmartObject& display_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the display capability
* @return Currently supported display capability
*/
virtual const smart_objects::SmartObjectSPtr system_display_capabilities()
const = 0;
- /*
+ /**
* @brief Sets supported display capability
* @param display_capabilities supported display capability
*/
virtual void set_system_display_capabilities(
const smart_objects::SmartObject& display_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the HMI zone capabilities
- *
* @return Currently supported HMI zone capabilities
*/
virtual const smart_objects::SmartObjectSPtr hmi_zone_capabilities()
const = 0;
- /*
+ /**
* @brief Sets supported HMI zone capabilities
- *
* @param hmi_zone_capabilities supported HMI zone capabilities
*/
virtual void set_hmi_zone_capabilities(
const smart_objects::SmartObject& hmi_zone_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the SoftButton's capabilities
- *
* @return Currently supported SoftButton's capabilities
*/
virtual const smart_objects::SmartObjectSPtr soft_button_capabilities()
const = 0;
- /*
+ /**
* @brief Sets supported SoftButton's capabilities
- *
* @param soft_button_capabilities supported SoftButton's capabilities
*/
virtual void set_soft_button_capabilities(
const smart_objects::SmartObject& soft_button_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the Button's capabilities
- *
* @return Currently supported Button's capabilities
*/
virtual const smart_objects::SmartObjectSPtr button_capabilities() const = 0;
- /*
+ /**
* @brief Sets supported Button's capabilities
- *
* @param soft_button_capabilities supported Button's capabilities
*/
virtual void set_button_capabilities(
const smart_objects::SmartObject& button_capabilities) = 0;
- /*
+ /**
* @brief Sets supported speech capabilities
- *
* @param speech_capabilities supported speech capabilities
*/
virtual void set_speech_capabilities(
const smart_objects::SmartObject& speech_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the speech capabilities
- *
* @return Currently supported speech capabilities
*/
virtual const smart_objects::SmartObjectSPtr speech_capabilities() const = 0;
- /*
+ /**
* @brief Sets supported VR capabilities
- *
* @param vr_capabilities supported VR capabilities
*/
virtual void set_vr_capabilities(
const smart_objects::SmartObject& vr_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the VR capabilities
- *
* @return Currently supported VR capabilities
*/
virtual const smart_objects::SmartObjectSPtr vr_capabilities() const = 0;
- /*
+ /**
* @brief Sets supported audio_pass_thru capabilities
- *
* @param vr_capabilities supported audio_pass_thru capabilities
*/
virtual void set_audio_pass_thru_capabilities(
const smart_objects::SmartObject& audio_pass_thru_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the audio_pass_thru capabilities
- *
* @return Currently supported audio_pass_thru capabilities
*/
virtual const smart_objects::SmartObjectSPtr audio_pass_thru_capabilities()
const = 0;
- /*
+ /**
* @brief Sets supported pcm_stream capabilities
- *
* @param supported pcm_stream capabilities
*/
virtual void set_pcm_stream_capabilities(
const smart_objects::SmartObject& pcm_stream_capabilities) = 0;
- /*
+ /**
* @brief Retrieves information about the pcm_stream capabilities
- *
* @return Currently supported pcm_streaming capabilities
*/
virtual const smart_objects::SmartObjectSPtr pcm_stream_capabilities()
const = 0;
- /*
+ /**
* @brief Retrieves information about the preset bank capabilities
- *
* @return Currently supported preset bank capabilities
*/
virtual const smart_objects::SmartObjectSPtr preset_bank_capabilities()
const = 0;
- /*
+ /**
* @brief Sets supported preset bank capabilities
- *
* @param soft_button_capabilities supported preset bank capabilities
*/
virtual void set_preset_bank_capabilities(
const smart_objects::SmartObject& preset_bank_capabilities) = 0;
- /*
+ /**
* @brief Sets vehicle information(make, model, modelYear)
- *
- * @param vehicle_type Cuurent vehicle information
+ * @param vehicle_type vehicle information
*/
virtual void set_vehicle_type(
const smart_objects::SmartObject& vehicle_type) = 0;
- /*
+ /**
* @brief Retrieves vehicle information(make, model, modelYear)
- *
- * @param vehicle_type Cuurent vehicle information
+ * @param vehicle_type Current vehicle information
*/
virtual const smart_objects::SmartObjectSPtr vehicle_type() const = 0;
- /*
+ /**
* @brief Retrieves information about the prerecorded speech
- *
* @return Currently supported prerecorded speech
*/
virtual const smart_objects::SmartObjectSPtr prerecorded_speech() const = 0;
- /*
+ /**
* @brief Sets supported prerecorded speech
- *
* @param prerecorded_speech supported prerecorded speech
*/
virtual void set_prerecorded_speech(
const smart_objects::SmartObject& prerecorded_speech) = 0;
- /*
+ /**
* @brief Interface used to store information if navigation
* supported by the system
- *
* @param supported Indicates if navigation supported by the system
*/
virtual void set_navigation_supported(const bool supported) = 0;
- /*
+ /**
* @brief Retrieves information if navi supported by the system
- *
* @return TRUE if it supported, otherwise FALSE
*/
virtual bool navigation_supported() const = 0;
- /*
+ /**
* @brief Interface used to store information if phone call
* supported by the system
- *
* @param supported Indicates if navigation supported by the sustem
*/
virtual void set_phone_call_supported(const bool supported) = 0;
- /*
+ /**
* @brief Retrieves information if phone call supported by the system
- *
* @return TRUE if it supported, otherwise FALSE
*/
virtual bool phone_call_supported() const = 0;
- /*
+ /**
* @brief Interface to store whether HMI supports video streaming
- *
* @param supported Indicates whether video streaming is supported by HMI
*/
virtual void set_video_streaming_supported(const bool supported) = 0;
- /*
+ /**
* @brief Retrieves whether HMI supports video streaming
- *
* @return TRUE if it supported, otherwise FALSE
*/
virtual bool video_streaming_supported() const = 0;
- /*
+ /**
* @brief Interface to store whether HMI supports remote control
- *
- * @param supported Indicates whether remote control is supported by HMI
+ * @param supported Indicates whether video streaming is supported by HMI
*/
virtual void set_rc_supported(const bool supported) = 0;
- /*
+ /**
* @brief Retrieves whether HMI supports remote control
- *
* @return TRUE if it supported, otherwise FALSE
*/
virtual bool rc_supported() const = 0;
- /*
+ /**
* @brief Interface used to store information regarding
* the navigation "System Capability"
- *
* @param navigation_capability contains information related
* to the navigation system capability.
*/
virtual void set_navigation_capability(
const smart_objects::SmartObject& navigation_capability) = 0;
- /*
+ /**
* @brief Retrieves information regarding the navigation system capability
- *
* @return NAVIGATION system capability
*/
virtual const smart_objects::SmartObjectSPtr navigation_capability()
const = 0;
- /*
+ /**
* @brief Interface used to store information regarding
* the phone "System Capability"
- *
* @param phone_capability contains information related
* to the phone system capability.
*/
virtual void set_phone_capability(
const smart_objects::SmartObject& phone_capability) = 0;
- /*
+ /**
* @brief Retrieves information regarding the phone call system capability
- *
* @return PHONE_CALL system capability
*/
virtual const smart_objects::SmartObjectSPtr phone_capability() const = 0;
- /*
+ /**
* @brief Sets HMI's video streaming related capability information
- *
* @param video_streaming_capability the video streaming related capabilities
*/
virtual void set_video_streaming_capability(
const smart_objects::SmartObject& video_streaming_capability) = 0;
- /*
+ /**
* @brief Retrieves HMI's video streaming related capabilities
- *
* @return HMI's video streaming related capability information
*/
virtual const smart_objects::SmartObjectSPtr video_streaming_capability()
@@ -514,6 +460,10 @@ class HMICapabilities {
virtual void set_rc_capability(
const smart_objects::SmartObject& rc_capability) = 0;
+ /**
+ * @brief Retrieves information regarding the remote control capabilities
+ * @return RC capabilities
+ */
virtual const smart_objects::SmartObjectSPtr rc_capability() const = 0;
/**