1 /*---------------------------------------------------------------------------*
2   Project:  Horizon
3   File:     mic_Result.h
4 
5   Copyright (C)2010 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: 32939 $
14  *---------------------------------------------------------------------------*/
15 
16 #ifndef NN_MIC_MIC_RESULT_H_
17 #define NN_MIC_MIC_RESULT_H_
18 
19 #include <nn/Result.h>
20 
21 /*! @file
22     @brief      MIC ライブラリの Result 群です。
23 */
24 
25 
26 namespace nn {
27 namespace mic {
28 namespace CTR {
29 
30     /*
31         @brief Result コードの詳細
32     */
33     enum Description
34     {
35         DESCRIPTION_MIC_SHELL_CLOSE = 1
36     };
37 
38 /*!
39   @name   Result 値
40   @{
41 */
42 
43 /*!
44     :category Result
45     @class nn::mic::CTR::ResultShellClose
46     @brief ふたが閉じられているためマイクを使用できません。
47 
48            ふたが閉じられる際にマイクのサンプリングが動作していた場合、自動的にサンプリングを停止し、
49            ふたが開けられた際に自動的にサンプリングを再開します。
50 
51            ふた閉じ中に使用できない関数は、@ref nn::mic::CTR::StartSampling、@ref nn::mic::CTR::StopSampling、@ref nn::mic::CTR::AdjustSampling になります。
52 */
53     NN_DEFINE_RESULT_CONST(
54         ResultShellClose,
55         Result::LEVEL_STATUS, Result::SUMMARY_STATUS_CHANGED, Result::MODULE_NN_MIC, DESCRIPTION_MIC_SHELL_CLOSE
56     );
57 /*!
58     :category Result
59     @class nn::mic::CTR::ResultNotInitialized
60     @brief あらかじめ初期化が必要な関数に初期化されずに呼ばれています。
61 */
62     NN_DEFINE_RESULT_CONST(
63         ResultNotInitialized,
64         Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_MIC, Result::DESCRIPTION_NOT_INITIALIZED
65     );
66 /*!
67     :category Result
68     @class nn::mic::CTR::ResultAlreadyInitialized
69     @brief 既に初期化されているのに、初期化を行おうとしています。
70 */
71     NN_DEFINE_RESULT_CONST(
72         ResultAlreadyInitialized,
73         Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_MIC, Result::DESCRIPTION_ALREADY_INITIALIZED
74     );
75 /*!
76     :category Result
77     @class nn::mic::CTR::ResultUsingOtherProcess
78     @brief MIC ライブラリの初期化時に、他のプロセスが使用中であり使用できません。
79 
80            アプレットではない通常のアプリケーションにおいてはこのエラーが返ることはありません。
81 */
82     NN_DEFINE_RESULT_CONST(
83         ResultUsingOtherProcess,
84         Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_MIC, Result::DESCRIPTION_ALREADY_INITIALIZED
85     );
86 /*!
87     :category Result
88     @class nn::mic::CTR::ResultBusy
89     @brief マイクのサンプリングが動作しているため、処理できません。
90 
91            処理を行いたい場合は@ref nn::mic::CTR::StartSampling を先に呼んでください。
92 */
93     NN_DEFINE_RESULT_CONST(
94         ResultBusy,
95         Result::LEVEL_STATUS, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_MIC, Result::DESCRIPTION_BUSY
96     );
97 /*!
98     :category Result
99     @class nn::mic::CTR::ResultMisalignedSize
100     @brief 指定したサイズのアライメントが不正です。
101 */
102     NN_DEFINE_RESULT_CONST(
103         ResultMisalignedSize,
104         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_MISALIGNED_SIZE
105     );
106 /*!
107     :category Result
108     @class nn::mic::CTR::ResultMisalignedAddress
109     @brief 指定したアドレスのアライメントが不正です。
110 */
111     NN_DEFINE_RESULT_CONST(
112         ResultMisalignedAddress,
113         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_MISALIGNED_ADDRESS
114     );
115 /*!
116     :category Result
117     @class nn::mic::CTR::ResultOutOfMemory
118     @brief サンプリング結果を格納するメモリ領域の指定位置が不正です。
119 */
120     NN_DEFINE_RESULT_CONST(
121         ResultOutOfMemory,
122         Result::LEVEL_USAGE, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_OUT_OF_MEMORY
123     );
124 
125     NN_DEFINE_RESULT_CONST(
126         ResultOutOfRange,
127         Result::LEVEL_USAGE, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_OUT_OF_RANGE
128     );
129 /*!
130     :category Result
131     @class nn::mic::CTR::ResultInvalidSize
132     @brief 不正なサイズを指定しています。
133 */
134     NN_DEFINE_RESULT_CONST(
135         ResultInvalidSize,
136         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_INVALID_SIZE
137     );
138 /*!
139     :category Result
140     @class nn::mic::CTR::ResultInvalidHandle
141     @brief 指定したメモリ領域が不正です。
142 */
143     NN_DEFINE_RESULT_CONST(
144         ResultInvalidHandle,
145         Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_INVALID_HANDLE
146     );
147 
148 }
149 }
150 }
151 
152 #endif /* NN_MIC_MIC_RESULT_H_ */
153