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

  Copyright (C)2009 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: 30928 $
 *---------------------------------------------------------------------------*/
#ifndef NN_DLP_CTR_DLP_RESULT_H_
#define NN_DLP_CTR_DLP_RESULT_H_

#include <nn/Result.h>

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


namespace nn {
namespace dlp {
namespace CTR {

    /*
        @brief Result コードの詳細
    */
    enum Description
    {
        DESCRIPTION_INVALID_STATE                           = 1,        //!< API を使用するのに不適切な内部状態です。
        DESCRIPTION_INTERNAL_ERROR                          = 2,        //!< アプリケーションからハンドリングできないエラーが発生しました。
        DESCRIPTION_ALREADY_OCCUPIED_WIRELESS_DEVICE        = 3,        //!< 無線デバイスが既に占有されています。
        DESCRIPTION_WIRELESS_OFF                            = 4,        //!< 通信ができない状態です。
        DESCRIPTION_NOT_FOUND_SERVER                        = 5,        //!< サーバが見つかりません。
        DESCRIPTION_SERVER_IS_FULL                          = 6,        //!< サーバにこれ以上のクライアントは接続できません。
        DESCRIPTION_INVALID_MEDIA_TYPE                      = 7,        //!< アクセスするメディアがサポートされていません。
        DESCRIPTION_FAILED_TO_ACCESS_MEDIA                  = 8,        //!< メディアへのアクセスに失敗しました。
        DESCRIPTION_CHILD_TOO_LARGE                         = 9,        //!< 子機プログラムのインポートに必要なNAND容量が大きすぎます。
        DESCRIPTION_INCOMMUTABLE                            = 10,       //!< 相手と通信ができません。
        DESCRIPTION_INVALID_DLP_VERSION                     = 11,
        DESCRIPTION_INVALID_REGION                          = 12        //!< 子機プロうグラムのリージョンが親機と異なります。
    };


    NN_DEFINE_RESULT_FUNC_LSM(  MakeInvalidStateResult,     Result::LEVEL_USAGE,     Result::SUMMARY_INVALID_STATE,     Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeInvalidArgumentResult,  Result::LEVEL_PERMANENT, Result::SUMMARY_INVALID_ARGUMENT,  Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeOutOfResourceResult,    Result::LEVEL_PERMANENT, Result::SUMMARY_OUT_OF_RESOURCE,   Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeInternalResult,         Result::LEVEL_PERMANENT, Result::SUMMARY_INTERNAL,          Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeNotSupportedResult,     Result::LEVEL_PERMANENT, Result::SUMMARY_NOT_SUPPORTED,     Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeNotFoundResult,         Result::LEVEL_STATUS,    Result::SUMMARY_NOT_FOUND,         Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeOutOfResourceResulttemporarily, Result::LEVEL_STATUS,    Result::SUMMARY_OUT_OF_RESOURCE,   Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeStatusChangedResult,    Result::LEVEL_STATUS,    Result::SUMMARY_STATUS_CHANGED,    Result::MODULE_NN_DLP);
    NN_DEFINE_RESULT_FUNC_LSM(  MakeCanceledResult,         Result::LEVEL_STATUS,    Result::SUMMARY_CANCELLED,         Result::MODULE_NN_DLP);

    /*!
      @name   Result 値
      @{
    */

    // LEVEL_USAGE
    /*!
        :category   Result
        @class nn::dlp::CTR::ResultAlreadyOccupiedWirelessDevice
        @brief @ref 無線デバイスが既に占有されています。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultAlreadyOccupiedWirelessDevice,
            MakeInvalidStateResult, DESCRIPTION_ALREADY_OCCUPIED_WIRELESS_DEVICE
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultInvalidState
        @brief @ref API を使用するのに不適切な内部状態です。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultInvalidState,
            MakeInvalidStateResult, DESCRIPTION_INVALID_STATE
    );

    // LEVEL_PERMANENT
    /*!
        :category   Result
        @class nn::dlp::CTR::ResultOutOfRange
        @brief @ref 使用しているパラメータが範囲外です。
    */
	NN_DEFINE_RESULT_CONST_LSM(
			ResultOutOfRange,
			MakeInvalidArgumentResult, Result::DESCRIPTION_OUT_OF_RANGE
	);

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultInvalidPointer
        @brief @ref 不正なポインタ引数です。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultInvalidPointer,
            MakeInvalidArgumentResult, Result::DESCRIPTION_INVALID_POINTER
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultInvalidHandle
        @brief @ref 不正なハンドル引数です。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultInvalidHandle,
            MakeInvalidArgumentResult, Result::DESCRIPTION_INVALID_HANDLE
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultInternalError
        @brief @ref アプリケーションからハンドリングできないエラーが発生しました。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultInternalError,
            MakeInternalResult, DESCRIPTION_INTERNAL_ERROR
    );

    NN_DEFINE_RESULT_CONST_LSM(
            ResultOutOfMemory,
            MakeOutOfResourceResult, Result::DESCRIPTION_OUT_OF_MEMORY
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultInvalidMediaType
        @brief @ref アクセスするメディアがサポートされていません。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultInvalidMediaType,
            MakeNotSupportedResult, DESCRIPTION_INVALID_MEDIA_TYPE
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultFailedToAccessMedia
        @brief @ref メディアへのアクセスに失敗しました。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultFailedToAccessMedia,
            MakeInternalResult, DESCRIPTION_FAILED_TO_ACCESS_MEDIA
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultChildTooLarge
        @brief @ref 子機プログラムのインポートに必要なNAND容量が大きすぎます。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultChildTooLarge,
            MakeNotSupportedResult, DESCRIPTION_CHILD_TOO_LARGE
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultInvalidRegion
        @brief @ref 子機プログラムのリージョンが親機と異なります。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultInvalidRegion,
            MakeNotSupportedResult, DESCRIPTION_INVALID_REGION
    );

    NN_DEFINE_RESULT_CONST_LSM(
            ResultInvalidDlpVersion,
            MakeNotSupportedResult, DESCRIPTION_INVALID_DLP_VERSION
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultIncommutable
        @brief @ref 相手と通信ができません。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultIncommutable,
            MakeNotSupportedResult, DESCRIPTION_INCOMMUTABLE
    );

    // LEVEL_STATUS
    /*!
        :category   Result
        @class nn::dlp::CTR::ResultNoData
        @brief @ref 対象のデータがありません。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultNoData,
            MakeNotFoundResult, Result::DESCRIPTION_NO_DATA
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultWirelessOff
        @brief @ref 通信ができない状態です。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultWirelessOff,
            MakeStatusChangedResult, DESCRIPTION_WIRELESS_OFF
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultNotFoundServer
        @brief @ref サーバが見つかりません。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultNotFoundServer,
            MakeNotFoundResult, DESCRIPTION_NOT_FOUND_SERVER
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultServerIsFull
        @brief @ref サーバにこれ以上のクライアントは接続できません。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultServerIsFull,
            MakeOutOfResourceResulttemporarily, DESCRIPTION_SERVER_IS_FULL
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultDeniedFromServer
        @brief @ref サーバも接続を拒否されました。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultDeniedFromServer,
            MakeCanceledResult, Result::DESCRIPTION_CANCEL_REQUESTED
    );

    /*!
        :category   Result
        @class nn::dlp::CTR::ResultConnectionTimeout
        @brief @ref 接続の試みがタイムアウトしました。
    */
    NN_DEFINE_RESULT_CONST_LSM(
            ResultConnectionTimeout,
            MakeCanceledResult, Result::DESCRIPTION_TIMEOUT
    );

    /*!
      @}
    */
}
}
}


#endif /* NN_DLP_CTR_DLP_RESULT_H_ */