/*---------------------------------------------------------------------------*
  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: 36566 $
 *---------------------------------------------------------------------------*/

#ifndef NN_HID_CTR_HID_RESULT_H_
#define NN_HID_CTR_HID_RESULT_H_

#include <nn/Result.h>

namespace nn {
namespace hid {
namespace CTR {

/* Please see man pages for details 
    
    
*/
    inline Result MakeResultAlreadyInitialized()
    {
        return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_HID, Result::DESCRIPTION_ALREADY_INITIALIZED );
    }
/* Please see man pages for details 
    
    
*/
    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 MakeResultNotInitialized()
    {
        return MakeUsageResult(Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_HID, Result::DESCRIPTION_NOT_INITIALIZED);
    }

    // For internal use
    // Indicates that no value was specified for the touch panel's calibration value.
    inline Result MakeResultNoData()
    {
        return MakePermanentResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_HID, Result::DESCRIPTION_NO_DATA );
    }

    // For internal use
    // Indicates that the specified analog stick calibration value was invalid.
    inline Result MakeResultOutOfRange()
    {
        return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_HID, Result::DESCRIPTION_OUT_OF_RANGE );
    }

    // For internal use
    // Indicates that an unauthorized function was called for the connection port.
    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_