RDK Documentation (Open Sourced RDK Components)
unsupportedOperationException.hpp
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 
21 /**
22  * @file unsupportedOperationException.hpp
23  * @brief This file defines UnsupportedOperationException class.
24  */
25 
26 
27 
28 /**
29 * @defgroup devicesettings
30 * @{
31 * @defgroup ds
32 * @{
33 **/
34 
35 
36 #ifndef _DS_UNSUPPORTEDOPERATIONEXCEPTION_HPP_
37 #define _DS_UNSUPPORTEDOPERATIONEXCEPTION_HPP_
38 
39 #include "exception.hpp"
40 #include <iostream>
41 
42 namespace device {
43 
44 
45 /**
46  * @class UnsupportedOperationException
47  * @brief This class extends Exception class to manage unsupported operations in devicesettings.
48  * @ingroup devicesettingsclass
49  */
50 class UnsupportedOperationException : public Exception {
51 public:
52 
53 /**
54  * @fn UnsupportedOperationException::UnsupportedOperationException(const char *msg = "Unsupported operation")
55  * @brief This function is the default constructor of UnsupportedOperationException class. It creates an exception
56  * with the message passed as input.
57  *
58  * @param[in] msg Indicates the message string with which exception needs to be thrown.
59  *
60  * @return None
61  */
62  UnsupportedOperationException(const char *msg = "Unsupported operation") throw (): Exception(msg) {};
63 
64 
65 /**
66  * @fn UnsupportedOperationException::~UnsupportedOperationException()
67  * @brief This function is the default destructor of UnsupportedOperationException class.
68  *
69  * @return none
70  */
71  virtual ~UnsupportedOperationException() throw() {};
72 };
73 
74 }
75 
76 #endif /* UNSUPPORTEDOPERATIONEXCEPTION_HPP_ */
77 
78 
79 /** @} */
80 /** @} */
device::UnsupportedOperationException::UnsupportedOperationException
UnsupportedOperationException(const char *msg="Unsupported operation")
This function is the default constructor of UnsupportedOperationException class. It creates an except...
Definition: unsupportedOperationException.hpp:62
device::UnsupportedOperationException
This class extends Exception class to manage unsupported operations in devicesettings.
Definition: unsupportedOperationException.hpp:50
device::Exception
This class handles exceptions occurring in DS module.
Definition: exception.hpp:52
device::UnsupportedOperationException::~UnsupportedOperationException
virtual ~UnsupportedOperationException()
This function is the default destructor of UnsupportedOperationException class.
Definition: unsupportedOperationException.hpp:71