src/modules/API/Radio/IManager.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /**
  17  * @author        Zbigniew Kostrzewa <z.kostrzewa@samsung.com>
  18  */
  19
  20 #ifndef WRTDEVICEAPIS_RADIO_IMANAGER_H_
  21 #define WRTDEVICEAPIS_RADIO_IMANAGER_H_
  22
  23 #include <string>
  24 #include <dpl/noncopyable.h>
  25 #include "Types.h"
  26 #include "ISource.h"
  27
  28 namespace WrtDeviceApis {
  29 namespace Radio {
  30 namespace Api {
  31 class IManager : public DPL::Noncopyable
  32 {
  33   public:
  34     static IManager& getInstance();
  35
  36   public:
  37     virtual ~IManager() = 0;
  38
  39     /**
  40      * Checks whether radio is enabled.
  41      * @return True if radio is enabled, false otherwise.
  42      * @throw UnsupportedException If platform doesn't support it.
  43      * @throw PlatformException If error in platform occurs.
  44      */
  45     virtual bool isEnabled() const = 0;
  46
  47     /**
  48      * Checks whether roaming is turned on.
  49      * @return True when roaming is on, false otherwise.
  50      */
  51     virtual bool isRoaming() const = 0;
  52
  53     /**
  54      * Gets interface of currently connected source.
  55      * @return Interface of radio source.
  56      * @throw UnsupportedException If platform doesn't support it.
  57      * @throw PlatformException If error in platform occurs.
  58      */
  59     virtual ISource* getSource() const = 0;
  60
  61     /**
  62      * Gets signal strength.
  63      * @return Signal strength (in percents).
  64      * @throw UnsupportedException If platform doesn't support it.
  65      * @throw PlatformException If error in platform occurs.
  66      */
  67     virtual Strength getSignalStrength() const = 0;
  68
  69     /**
  70      * Gets Mobile Country Code
  71      * @return Mobile Country Code string.
  72      */
  73     virtual std::string getMcc() const = 0;
  74
  75     /**
  76      * Gets Mobile Network Code
  77      * @return Mobile Country Code string.
  78      */
  79     virtual std::string getMnc() const = 0;
  80
  81     /**
  82      * Checks whether telephony H/W is turend on.
  83      * @return true when on, false otherwise.
  84      */
  85     virtual bool isHardwareOn() const = 0;
  86 };
  87 } // Api
  88 } // Radio
  89 } // WrtDeviceApis
  90
  91 #endif // WRTDEVICEAPIS_RADIO_IMANAGER_H_