/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     mic_Result.h

  Copyright (C)2010 Nintendo Co., Ltd.  All rights reserved.

  These coded instructions, statements, and computer programs contain
  proprietary information of Nintendo of America Inc. and/or Nintendo
  Company Ltd., and are protected by Federal copyright law.  They may
  not be disclosed to third parties or copied or duplicated in any form,
  in whole or in part, without the prior written consent of Nintendo.

  $Rev: 32939 $
 *---------------------------------------------------------------------------*/

#ifndef NN_MIC_MIC_RESULT_H_
#define NN_MIC_MIC_RESULT_H_

#include <nn/Result.h>

/*! @file
    @brief      MIC ライブラリの Result 群です。
*/


namespace nn {
namespace mic {
namespace CTR {

    /*
        @brief Result コードの詳細
    */
    enum Description
    {
        DESCRIPTION_MIC_SHELL_CLOSE = 1
    };

/*!
  @name   Result 値
  @{
*/

/*!
    :category Result
    @class nn::mic::CTR::ResultShellClose
    @brief ふたが閉じられているためマイクを使用できません。

           ふたが閉じられる際にマイクのサンプリングが動作していた場合、自動的にサンプリングを停止し、
           ふたが開けられた際に自動的にサンプリングを再開します。

           ふた閉じ中に使用できない関数は、@ref nn::mic::CTR::StartSampling、@ref nn::mic::CTR::StopSampling、@ref nn::mic::CTR::AdjustSampling になります。
*/
    NN_DEFINE_RESULT_CONST(
        ResultShellClose,
        Result::LEVEL_STATUS, Result::SUMMARY_STATUS_CHANGED, Result::MODULE_NN_MIC, DESCRIPTION_MIC_SHELL_CLOSE
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultNotInitialized
    @brief あらかじめ初期化が必要な関数に初期化されずに呼ばれています。
*/
    NN_DEFINE_RESULT_CONST(
        ResultNotInitialized,
        Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_MIC, Result::DESCRIPTION_NOT_INITIALIZED
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultAlreadyInitialized
    @brief 既に初期化されているのに、初期化を行おうとしています。
*/
    NN_DEFINE_RESULT_CONST(
        ResultAlreadyInitialized,
        Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_MIC, Result::DESCRIPTION_ALREADY_INITIALIZED
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultUsingOtherProcess
    @brief MIC ライブラリの初期化時に、他のプロセスが使用中であり使用できません。

           アプレットではない通常のアプリケーションにおいてはこのエラーが返ることはありません。
*/
    NN_DEFINE_RESULT_CONST(
        ResultUsingOtherProcess,
        Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_MIC, Result::DESCRIPTION_ALREADY_INITIALIZED
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultBusy
    @brief マイクのサンプリングが動作しているため、処理できません。

           処理を行いたい場合は@ref nn::mic::CTR::StartSampling を先に呼んでください。
*/
    NN_DEFINE_RESULT_CONST(
        ResultBusy,
        Result::LEVEL_STATUS, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_MIC, Result::DESCRIPTION_BUSY
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultMisalignedSize
    @brief 指定したサイズのアライメントが不正です。
*/
    NN_DEFINE_RESULT_CONST(
        ResultMisalignedSize,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_MISALIGNED_SIZE
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultMisalignedAddress
    @brief 指定したアドレスのアライメントが不正です。
*/
    NN_DEFINE_RESULT_CONST(
        ResultMisalignedAddress,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_MISALIGNED_ADDRESS
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultOutOfMemory
    @brief サンプリング結果を格納するメモリ領域の指定位置が不正です。
*/
    NN_DEFINE_RESULT_CONST(
        ResultOutOfMemory,
        Result::LEVEL_USAGE, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_OUT_OF_MEMORY
    );

    NN_DEFINE_RESULT_CONST(
        ResultOutOfRange,
        Result::LEVEL_USAGE, Result::SUMMARY_WRONG_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_OUT_OF_RANGE
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultInvalidSize
    @brief 不正なサイズを指定しています。
*/
    NN_DEFINE_RESULT_CONST(
        ResultInvalidSize,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_INVALID_SIZE
    );
/*!
    :category Result
    @class nn::mic::CTR::ResultInvalidHandle
    @brief 指定したメモリ領域が不正です。
*/
    NN_DEFINE_RESULT_CONST(
        ResultInvalidHandle,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_MIC, Result::DESCRIPTION_INVALID_HANDLE
    );

}
}
}

#endif /* NN_MIC_MIC_RESULT_H_ */