Revise cpp codes
[platform/core/api/audio-io.git] / include / CAudioError.h
1 /*
2  * Copyright (c) 2015 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 #ifndef __TIZEN_MEDIA_AUDIO_IO_CAUDIOERROR_H__
18 #define __TIZEN_MEDIA_AUDIO_IO_CAUDIOERROR_H__
19
20
21 #ifdef __cplusplus
22
23
24 namespace tizen_media_audio {
25
26
27     /**
28      * Audio Error
29      */
30     class CAudioError {
31     public:
32         /* Enums Definition */
33         enum class EError : unsigned int {
34             ERROR_NONE,
35
36             ERROR_INVALID_ARGUMENT,
37             ERROR_INVALID_HANDLE,
38             ERROR_INVALID_SAMPLERATE,
39             ERROR_INVALID_CHANNEL,
40             ERROR_INVALID_FORMAT,
41             ERROR_INVALID_POINTER,
42             ERROR_INVALID_OPERATION,
43             ERROR_INVALID_STATE,
44
45             ERROR_NOT_INITIALIZED,
46             ERROR_NOT_SUPPORTED,
47             ERROR_NOT_SUPPORTED_TYPE,
48
49             ERROR_PERMISSION_DENIED,
50
51             ERROR_DEVICE_POLICY_RESTRICTION,
52             ERROR_DEVICE_NOT_OPENED,
53             ERROR_DEVICE_NOT_CLOSED,
54
55             ERROR_OUT_OF_MEMORY,
56             ERROR_INTERNAL_OPERATION,
57             ERROR_FAILED_OPERATION,
58
59             ERROR_POLICY_BLOCKED,
60             ERROR_POLICY_INTERRUPTED,
61             ERROR_POLICY_DUPLICATED,
62
63             ERROR_MAX
64         };
65
66         /* Constants Definition */
67         static const unsigned int MSG_LENGTH = 512;
68
69         /* Constructor & Destructor */
70         explicit CAudioError(EError err);
71         CAudioError(EError err, const char* fileName, const char* parentFunc, int lineNum);
72         CAudioError(EError err, const char* msg, const char* fileName, const char* parentFunc, int lineNum);
73         CAudioError(const CAudioError& err);
74         virtual ~CAudioError() = default;
75
76         /* Static Methods */
77         static EError getLastError();
78         static const char* getLastErrorMsg();
79
80         /* Setter & Getter */
81         EError getError();
82         const char* getErrorMsg();
83
84         /* Overrided Operation */
85         CAudioError& operator =  (const EError err);
86         CAudioError& operator =  (const CAudioError& err);
87         bool         operator != (const EError err);
88         bool         operator == (const EError err);
89         //friend bool operator == (const CAudioError& src, const EError& err);
90
91     private:
92         const char* __convertErrorToString(EError err);
93
94         /* Members */
95         static EError __mLastError;
96         static char   __mLastErrorMsg[MSG_LENGTH];
97         EError        __mError;
98         char          __mErrorMsg[MSG_LENGTH]{};
99     };
100
101
102 } /* namespace tizen_media_audio */
103
104 #endif
105 #endif /* __TIZEN_MEDIA_AUDIO_IO_CAUDIOERROR_H__ */