1 /*---------------------------------------------------------------------------*
2 Project: Horizon
3 File: cec_result.h
4
5 Copyright (C)2009 Nintendo Co., Ltd. All rights reserved.
6
7 These coded instructions, statements, and computer programs contain
8 proprietary information of Nintendo of America Inc. and/or Nintendo
9 Company Ltd., and are protected by Federal copyright law. They may
10 not be disclosed to third parties or copied or duplicated in any form,
11 in whole or in part, without the prior written consent of Nintendo.
12
13 $Rev: 31024 $
14 *---------------------------------------------------------------------------*/
15 #ifndef __CEC_RESULT_H__
16 #define __CEC_RESULT_H__
17
18 #include <nn/Result.h>
19
20 namespace nn {
21 namespace cec {
22
23 enum ResultDescription
24 {
25 DESCRIPTION_UNKNOWN = 100,
26
27 DESCRIPTION_BOXSIZE_FULL,
28 DESCRIPTION_BOXMESSNUM_FULL,
29 DESCRIPTION_BOXNUM_FULL,
30 DESCRIPTION_BOX_ALREADY_EXISTS,
31
32 DESCRIPTION_MESS_TOO_LARGE,
33 DESCRIPTION_INVALID_DATA,
34 DESCRIPTION_INVALID_ID,
35
36 DESCRIPTION_NOT_AGREE_EULA, //!< EULA非同意
37 DESCRIPTION_PARENTAL_CONTROL_CEC, //!< ParentalControl非同意
38
39
40 DESCRIPTION_END
41 };
42
ResultAlreadyInitialized()43 inline Result ResultAlreadyInitialized()
44 {
45 return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_ALREADY_INITIALIZED );
46 }
MakeResultAlreadyInitialized()47 inline Result MakeResultAlreadyInitialized()
48 {
49 return ResultAlreadyInitialized();
50 }
51
52
53 /*!
54 :category Result
55 @class nn::cec::ResultNotAgreeEula
56 @brief EULAに同意されていません
57 */
ResultNotAgreeEula()58 inline Result ResultNotAgreeEula()
59 {
60 return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, DESCRIPTION_NOT_AGREE_EULA );
61 }
MakeResultNotAgreeEula()62 inline Result MakeResultNotAgreeEula()
63 {
64 return ResultNotAgreeEula();
65 }
66
67
68 /*!
69 :category Result
70 @class nn::cec::ResultParentalControlCec
71 @brief ParentalControlによって動作が制限されています。
72 */
ResultParentalControlCec()73 inline Result ResultParentalControlCec()
74 {
75 return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, DESCRIPTION_PARENTAL_CONTROL_CEC );
76 }
MakeResultParentalControlCec()77 inline Result MakeResultParentalControlCec(){return ResultParentalControlCec();}
78
79
80 /*!
81 :category Result
82 @class nn::cec::ResultNotInitialized
83 @brief 初期化されていません。
84 */
ResultNotInitialized()85 inline Result ResultNotInitialized()
86 {
87 return MakeUsageResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_CEC, Result::DESCRIPTION_NOT_INITIALIZED );
88 }
MakeResultNotInitialized()89 inline Result MakeResultNotInitialized(){return ResultNotInitialized();}
90
91
92 /*!
93 :category Result
94 @class nn::cec::ResultNotInitialized
95 @brief 初期化されていません。
96 */
ResultAlreadyDone()97 inline Result ResultAlreadyDone()
98 {
99 return MakeInfoResult( Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_CEC, Result::DESCRIPTION_ALREADY_DONE );
100 }
MakeResultAlreadyDone()101 inline Result MakeResultAlreadyDone(){return ResultAlreadyDone();}
102
103 /*!
104 :private
105 :category Result
106 @class nn::cec::ResultInvalidState
107 @brief 無効な内部ステートです。
108 */
ResultInvalidState()109 inline Result ResultInvalidState()
110 {
111 return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_INVALID_COMBINATION );
112 }
MakeResultInvalidState()113 inline Result MakeResultInvalidState(){return ResultInvalidState();}
114
115
116 /*!
117 :category Result
118 @class nn::cec::ResultInvalidCombination
119 @brief 引数の組み合わせが不正です。
120 */
ResultInvalidCombination()121 inline Result ResultInvalidCombination()
122 {
123 return MakeUsageResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_INVALID_COMBINATION );
124 }
MakeResultInvalidCombination()125 inline Result MakeResultInvalidCombination(){return ResultInvalidCombination();}
126
127 /*!
128 :category Result
129 @class nn::cec::ResultInvalidArgument
130 @brief 引数が不正です。
131 */
ResultInvalidArgument()132 inline Result ResultInvalidArgument()
133 {
134 return MakeUsageResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_OUT_OF_RANGE );
135 }
MakeResultInvalidArgument()136 inline Result MakeResultInvalidArgument(){return ResultInvalidArgument();}
137
138 /*!
139 :category Result
140 @class nn::cec::ResultBufferFull
141 @brief メモリの確保に失敗しました。
142 */
ResultBufferFull()143 inline Result ResultBufferFull()
144 {
145 return MakeStatusResult( Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_CEC, Result::DESCRIPTION_OUT_OF_MEMORY );
146 }
MakeResultBufferFull()147 inline Result MakeResultBufferFull(){return ResultBufferFull();}
148
149
150 /*!
151 :category Result
152 @class nn::cec::ResultNoData
153 @brief データがありません。
154 */
ResultNoData()155 inline Result ResultNoData()
156 {
157 return MakeStatusResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_CEC, Result::DESCRIPTION_NO_DATA );
158 }
MakeResultNoData()159 inline Result MakeResultNoData(){return ResultNoData();}
160
161
162 /*!
163 :category Result
164 @class nn::cec::ResultNotAuthorized
165 @brief 認証に必要な情報が指定されていないため、アクセスできません。
166 */
ResultNotAuthorized()167 inline Result ResultNotAuthorized()
168 {
169 return MakeStatusResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_CEC, Result::DESCRIPTION_NOT_AUTHORIZED );
170 }
MakeResultNotAuthorized()171 inline Result MakeResultNotAuthorized(){return ResultNotAuthorized();}
172
173
174 /*!
175 :category Result
176 @class nn::cec::ResultTooLarge
177 @brief 大きすぎる値が指定されています。
178 */
ResultTooLarge()179 inline Result ResultTooLarge()
180 {
181 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_TOO_LARGE );
182 }
MakeResultTooLarge()183 inline Result MakeResultTooLarge(){return ResultTooLarge();}
184
185
186 /*!
187 :category Result
188 @class nn::cec::ResultBoxSizeFull
189 @brief ボックスに格納できる容量を超えています。
190 */
ResultBoxSizeFull()191 inline Result ResultBoxSizeFull()
192 {
193 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOXSIZE_FULL );
194 }
MakeResultBoxSizeFull()195 inline Result MakeResultBoxSizeFull(){return ResultBoxSizeFull();}
196
197 /*!
198 :category Result
199 @class nn::cec::ResultBoxMessNumFull
200 @brief ボックスに格納できる個数を超えています。
201 */
ResultBoxMessNumFull()202 inline Result ResultBoxMessNumFull()
203 {
204 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOXMESSNUM_FULL );
205 }
MakeResultBoxMessNumFull()206 inline Result MakeResultBoxMessNumFull(){return ResultBoxMessNumFull();}
207
208
209 /*!
210 :category Result
211 @class nn::cec::ResultBoxNumFull
212 @brief ボックスの最大個数を超えています。
213 */
ResultBoxNumFull()214 inline Result ResultBoxNumFull()
215 {
216 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOXNUM_FULL );
217 }
MakeResultBoxNumFull()218 inline Result MakeResultBoxNumFull(){return ResultBoxNumFull();}
219
220
221 /*!
222 :category Result
223 @class nn::cec::ResultBoxAlreadyExists
224 @brief ボックスの最大個数を超えています。
225 */
ResultBoxAlreadyExists()226 inline Result ResultBoxAlreadyExists()
227 {
228 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOX_ALREADY_EXISTS );
229 }
MakeResultBoxAlreadyExists()230 inline Result MakeResultBoxAlreadyExists(){return ResultBoxAlreadyExists();}
231
232 /*!
233 :category Result
234 @class nn::cec::ResultMessTooLarge
235 @brief メッセージのサイズが大きすぎます。
236 */
ResultMessTooLarge()237 inline Result ResultMessTooLarge()
238 {
239 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_MESS_TOO_LARGE );
240 }
MakeResultMessTooLarge()241 inline Result MakeResultMessTooLarge(){return ResultMessTooLarge();}
242
243
244 /*!
245 :category Result
246 @class nn::cec::ResultInvalidId
247 @brief 不正なIDが指定されています。
248 */
ResultInvalidId()249 inline Result ResultInvalidId()
250 {
251 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_INVALID_ID );
252 }
MakeResultInvalidId()253 inline Result MakeResultInvalidId(){return ResultInvalidId();}
254
255 /*!
256 :category Result
257 @class nn::cec::ResultInvalidData
258 @brief 不正なデータが指定されています。
259 */
ResultInvalidData()260 inline Result ResultInvalidData()
261 {
262 return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_INVALID_DATA );
263 }
MakeResultInvalidData()264 inline Result MakeResultInvalidData(){return ResultInvalidData();}
265
266 /*!
267 :category Result
268 @class nn::cec::ResultInvalidPointer
269 @brief 不正なポインタが指定されています。
270 */
ResultInvalidPointer()271 inline Result ResultInvalidPointer()
272 {
273 return MakeUsageResult(Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_INVALID_POINTER);
274 }
MakeResultInvalidPointer()275 inline Result MakeResultInvalidPointer(){return ResultInvalidPointer();}
276
277
278 /*!
279 :category Result
280 @class nn::cec::ResultStateBusy
281 @brief BUSY状態のため、アクセスできません。
282 */
ResultStateBusy()283 inline Result ResultStateBusy()
284 {
285 return MakeStatusResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_BUSY );
286 }
MakeResultStateBusy()287 inline Result MakeResultStateBusy(){return ResultStateBusy();}
288
289
290
291
292 } // namespace cec
293 } // namespace nn
294
295
296 #endif //__CEC_H__
297
298