/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     camera_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: 34383 $
 *---------------------------------------------------------------------------*/

#ifndef NN_CAMERA_CAMERA_RESULT_H_
#define NN_CAMERA_CAMERA_RESULT_H_

#include <nn/Result.h>

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


namespace nn {
namespace camera {
namespace CTR {

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

/*!
  @name   Result 値
  @{
*/

/*!
    @class nn::camera::CTR::ResultIsSleeping
    @brief @ref 蓋閉じ中であるため、呼び出そうとした関数は使用できないことを示します。
*/
    NN_DEFINE_RESULT_CONST(
        ResultIsSleeping,
        Result::LEVEL_STATUS, Result::SUMMARY_STATUS_CHANGED, Result::MODULE_NN_CAMERA, DESCRIPTION_CAMERA_IS_SLEEPING
    );

/*!
    @class nn::camera::CTR::ResultFatalError
    @brief @ref カメラの再起動処理に失敗したことを示します。カメラが物理的に故障している可能性があります。
*/
    NN_DEFINE_RESULT_CONST(
        ResultFatalError,
        Result::LEVEL_FATAL, Result::SUMMARY_INTERNAL, Result::MODULE_NN_CAMERA, DESCRIPTION_CAMERA_FATAL_ERROR
    );

/*!
    @class nn::camera::CTR::ResultAlreadyInitialized
    @brief @ref カメラライブラリが初期化済みであることを示します。
*/
    NN_DEFINE_RESULT_CONST(
        ResultAlreadyInitialized,
        Result::LEVEL_PERMANENT, Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_ALREADY_INITIALIZED
    );

/*!
    @class nn::camera::CTR::ResultUsingOtherProcess
    @brief @ref 他のプロセスがカメラを使用中であるため、自分は使えないことを示します。
*/
    NN_DEFINE_RESULT_CONST(
        ResultUsingOtherProcess,
        Result::LEVEL_STATUS, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_ALREADY_INITIALIZED
    );

    // 内部用
    // 指定された引数がenum値の範囲でなかったことを示す。
    NN_DEFINE_RESULT_CONST(
        ResultInvalidEnumValue,
        Result::LEVEL_USAGE, Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_INVALID_ENUM_VALUE
    );

    // 内部用
    // csnd経由のシャッター音再生が失敗したことを示す。
    // これを受け取ったシムレイヤ側のライブラリは一度だけリトライを試みるので、即アプリ側にFATALを返すことはない。
    NN_DEFINE_RESULT_CONST(
        ResultBusy,
        Result::LEVEL_STATUS, Result::SUMMARY_INTERNAL, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_BUSY
    );

    // 内部用
    // 接続ポートに対して権限のない関数を呼び出したことを示す。
    NN_DEFINE_RESULT_CONST(
        ResultNotAuthorized,
        Result::LEVEL_PERMANENT, Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_NOT_AUTHORIZED
    );

    // 内部用
    // GetLatestVsyncTiming()に指定したデータ取得サイズが最大保持サイズよりも大きかったことを示す。
    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(
        ResultTimeout,
        Result::LEVEL_FATAL, Result::SUMMARY_INTERNAL, Result::MODULE_NN_CAMERA, Result::DESCRIPTION_TIMEOUT
    );

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

}
}
}

#endif /* NN_CAMERA_CAMERA_RESULT_H_ */