RDK Documentation (Open Sourced RDK Components)
enumerable.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 enumerable.hpp
23  * @brief This file defines Enumerable class.
24  */
25 
26 
27 
28 /**
29 * @defgroup devicesettings
30 * @{
31 * @defgroup ds
32 * @{
33 **/
34 
35 
36 #ifndef _DS_ENUMERABLE_HPP_
37 #define _DS_ENUMERABLE_HPP_
38 
39 namespace device {
40 
41 /**
42  * @class Enumerable
43  * @brief This class is inherited by many classes in DS for getting the ID.
44  * @ingroup devicesettingsclass
45  */
46 class Enumerable {
47 
48 /**
49  * @fn Enumerable::getId()
50  * @brief This function is used to get the id and it is
51  * implemented by the classes inheriting it.
52  *
53  * @return Returns id value.
54  */
55  int getId() const;
56 };
57 
58 }
59 
60 #endif /* _DS_ENUMERABLE_HPP_ */
61 
62 
63 /** @} */
64 /** @} */
device::Enumerable::getId
int getId() const
This function is used to get the id and it is implemented by the classes inheriting it.
device::Enumerable
This class is inherited by many classes in DS for getting the ID.
Definition: enumerable.hpp:46