/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     y2r_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: 31133 $
 *---------------------------------------------------------------------------*/

#ifndef NN_Y2R_Y2R_RESULT_H_
#define NN_Y2R_Y2R_RESULT_H_

#include <nn/Result.h>

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


namespace nn {
namespace y2r {
namespace CTR {

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

/*!
    @class nn::y2r::CTR::ResultIsSleeping
    @brief @ref システムがスリープ中であるためY2Rを使用できないことを示します。
*/
    NN_DEFINE_RESULT_CONST(
        ResultIsSleeping,
        Result::LEVEL_STATUS, Result::SUMMARY_STATUS_CHANGED, Result::MODULE_NN_CAMERA, DESCRIPTION_Y2R_IS_SLEEPING
    );

    // 内部用
    // シムレイヤ側のGetOutputFormatBytes()で、指定されたフォーマット種別が不正なら、このエラーでPANICする。
    NN_DEFINE_RESULT_CONST(
        ResultInvalidEnumValue,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_INVALID_ENUM_VALUE
    );

    // 内部用
    // シムレイヤ側のGetOutputBlockSize()で、計算結果が出力バッファサイズを超えていたら、このエラーでPANICする。
    NN_DEFINE_RESULT_CONST(
        ResultOutOfRange,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_OUT_OF_RANGE
    );

    // 内部用
    // プロセスでの初期化が既に行われていることを示します。
    NN_DEFINE_RESULT_CONST(
        ResultAlreadyInitialized,
        Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_ALREADY_INITIALIZED
    );

    // 内部用
    // プロセスでの初期化がされていないことを示します。
    NN_DEFINE_RESULT_CONST(
        ResultNotInitialized,
        Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_NOT_INITIALIZED
    );

}
}
}

#endif /* NN_Y2R_Y2R_RESULT_H_ */