/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     hid_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: 34180 $
 *---------------------------------------------------------------------------*/

#ifndef NN_HID_CTR_HID_RESULT_H_
#define NN_HID_CTR_HID_RESULT_H_

#include <nn/Result.h>

namespace nn {
namespace hid {
namespace CTR {

/*!
    @class nn::hid::CTR::MakeResultAlreadyInitialized
    @brief @ref HIDライブラリが初期化済みであることを示します。
*/
    inline Result MakeResultAlreadyInitialized()
    {
        return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_HID, Result::DESCRIPTION_ALREADY_INITIALIZED );
    }
/*!
    @class nn::hid::CTR::MakeResultInvalidCombination
    @brief @ref 引数が不正な組み合わせであることを示します。
*/
    inline Result MakeResultInvalidCombination()
    {
        return MakeUsageResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_HID, Result::DESCRIPTION_INVALID_COMBINATION );
    }

    inline Result MakeResultOutOfMemory()
    {
        return MakePermanentResult( Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_HID, Result::DESCRIPTION_OUT_OF_MEMORY );
    }

    // 内部用
    // タッチパネルのキャル値として保存する値を指定しなかったことを示す。
    inline Result MakeResultNoData()
    {
        return MakePermanentResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_HID, Result::DESCRIPTION_NO_DATA );
    }

    // 内部用
    // アナログスティックのキャル値として保存しようとした値が不正だったことを示す。
    inline Result MakeResultOutOfRange()
    {
        return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_HID, Result::DESCRIPTION_OUT_OF_RANGE );
    }

    // 内部用
    // 接続ポートに対して権限のない関数を呼び出したことを示す。
    inline Result MakeResultNotAuthorized()
    {
        return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_HID, Result::DESCRIPTION_NOT_AUTHORIZED );
    }

} // namespace CTR
} // namespace hid
} // namespace nn

#endif //NN_HID_CTR_HID_RESULT_H_