/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     cec_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: 31998 $
 *---------------------------------------------------------------------------*/
#ifndef __CEC_RESULT_H__
#define __CEC_RESULT_H__

#include <nn/Result.h>

namespace nn {
namespace cec {

enum ResultDescription
{
    DESCRIPTION_UNKNOWN = 100,

    DESCRIPTION_BOXSIZE_FULL,
    DESCRIPTION_BOXMESSNUM_FULL,
    DESCRIPTION_BOXNUM_FULL,
    DESCRIPTION_BOX_ALREADY_EXISTS,

    DESCRIPTION_MESS_TOO_LARGE,
    DESCRIPTION_INVALID_DATA,
    DESCRIPTION_INVALID_ID,
    
    DESCRIPTION_NOT_AGREE_EULA,                 //!< EULA非同意
    DESCRIPTION_PARENTAL_CONTROL_CEC,                 //!< ParentalControl非同意
    

    DESCRIPTION_END
};

inline Result ResultAlreadyInitialized()
{
    return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_ALREADY_INITIALIZED );
}
inline Result MakeResultAlreadyInitialized()
{
    return ResultAlreadyInitialized();
}


/*!
    :category   Result
    @class nn::cec::ResultNotAgreeEula
    @brief EULAに同意されていません
*/
inline Result ResultNotAgreeEula()
{
    return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, DESCRIPTION_NOT_AGREE_EULA );
}
inline Result MakeResultNotAgreeEula()
{
    return ResultNotAgreeEula();
}


/*!
    :category   Result
    @class nn::cec::ResultParentalControlCec
    @brief ParentalControlによって動作が制限されています。
*/
inline Result ResultParentalControlCec()
{
    return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, DESCRIPTION_PARENTAL_CONTROL_CEC );
}
inline Result MakeResultParentalControlCec(){return ResultParentalControlCec();}


/*!
    :category   Result
    @class nn::cec::ResultNotInitialized
    @brief 初期化されていません。
*/
inline Result ResultNotInitialized()
{
    return MakeUsageResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_CEC, Result::DESCRIPTION_NOT_INITIALIZED );
}
inline Result MakeResultNotInitialized(){return ResultNotInitialized();}


/*!
    :category   Result
    @class nn::cec::ResultNotInitialized
    @brief 初期化されていません。
*/
inline Result ResultAlreadyDone()
{
    return MakeInfoResult( Result::SUMMARY_NOTHING_HAPPENED, Result::MODULE_NN_CEC, Result::DESCRIPTION_ALREADY_DONE );
}
inline Result MakeResultAlreadyDone(){return ResultAlreadyDone();}

/*!
:private
    :category   Result
    @class nn::cec::ResultInvalidState
    @brief 無効な内部ステートです。
*/
inline Result ResultInvalidState()
{
    return MakeUsageResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_INVALID_COMBINATION );
}
inline Result MakeResultInvalidState(){return ResultInvalidState();}


/*!
    :category   Result
    @class nn::cec::ResultInvalidCombination
    @brief 引数の組み合わせが不正です。
*/
inline Result ResultInvalidCombination()
{
    return MakeUsageResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_INVALID_COMBINATION );
}
inline Result MakeResultInvalidCombination(){return ResultInvalidCombination();}

/*!
    :category   Result
    @class nn::cec::ResultInvalidArgument
    @brief 引数が不正です。
*/
inline Result ResultInvalidArgument()
{
    return MakeUsageResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_OUT_OF_RANGE );
}
inline Result MakeResultInvalidArgument(){return ResultInvalidArgument();}

/*!
    :category   Result
    @class nn::cec::ResultBufferFull
    @brief メモリの確保に失敗しました。
*/
inline Result ResultBufferFull()
{
    return MakeStatusResult( Result::SUMMARY_OUT_OF_RESOURCE, Result::MODULE_NN_CEC, Result::DESCRIPTION_OUT_OF_MEMORY );
}
inline Result MakeResultBufferFull(){return ResultBufferFull();}


/*!
    :category   Result
    @class nn::cec::ResultNoData
    @brief データがありません。
*/
inline Result ResultNoData()
{
    return MakeStatusResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_CEC, Result::DESCRIPTION_NO_DATA );
}
inline Result MakeResultNoData(){return ResultNoData();}


/*!
    :category   Result
    @class nn::cec::ResultNotAuthorized
    @brief 認証に必要な情報が指定されていないため、アクセスできません。
*/
inline Result ResultNotAuthorized()
{
    return MakeStatusResult( Result::SUMMARY_NOT_FOUND, Result::MODULE_NN_CEC, Result::DESCRIPTION_NOT_AUTHORIZED );
}
inline Result MakeResultNotAuthorized(){return ResultNotAuthorized();}


/*!
    :category   Result
    @class nn::cec::ResultTooLarge
    @brief 大きすぎる値が指定されています。
*/
inline Result ResultTooLarge()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_TOO_LARGE );
}
inline Result MakeResultTooLarge(){return ResultTooLarge();}


/*!
    :category   Result
    @class nn::cec::ResultBoxSizeFull
    @brief ボックスに格納できる容量を超えています。
*/
inline Result ResultBoxSizeFull()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOXSIZE_FULL );
}
inline Result MakeResultBoxSizeFull(){return ResultBoxSizeFull();}

/*!
    :category   Result
    @class nn::cec::ResultBoxMessNumFull
    @brief ボックスに格納できる個数を超えています。
*/
inline Result ResultBoxMessNumFull()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOXMESSNUM_FULL );
}
inline Result MakeResultBoxMessNumFull(){return ResultBoxMessNumFull();}


/*!
    :category   Result
    @class nn::cec::ResultBoxNumFull
    @brief ボックスの最大個数を超えています。
*/
inline Result ResultBoxNumFull()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOXNUM_FULL );
}
inline Result MakeResultBoxNumFull(){return ResultBoxNumFull();}


/*!
    :category   Result
    @class nn::cec::ResultBoxAlreadyExists
    @brief ボックスが既に存在します。
*/
inline Result ResultBoxAlreadyExists()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_BOX_ALREADY_EXISTS );
}
inline Result MakeResultBoxAlreadyExists(){return ResultBoxAlreadyExists();}

/*!
    :category   Result
    @class nn::cec::ResultMessTooLarge
    @brief メッセージのサイズが大きすぎます。
*/
inline Result ResultMessTooLarge()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_MESS_TOO_LARGE );
}
inline Result MakeResultMessTooLarge(){return ResultMessTooLarge();}


/*!
    :category   Result
    @class nn::cec::ResultInvalidId
    @brief 不正なIDが指定されています。
*/
inline Result ResultInvalidId()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_INVALID_ID );
}
inline Result MakeResultInvalidId(){return ResultInvalidId();}

/*!
    :category   Result
    @class nn::cec::ResultInvalidData
    @brief 不正なデータが指定されています。
*/
inline Result ResultInvalidData()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, DESCRIPTION_INVALID_DATA );
}
inline Result MakeResultInvalidData(){return ResultInvalidData();}

/*!
    :category   Result
    @class nn::cec::ResultInvalidPointer
    @brief 不正なポインタが指定されています。
*/
inline Result ResultInvalidPointer()
{
    return MakeUsageResult(Result::SUMMARY_INVALID_ARGUMENT, Result::MODULE_NN_CEC, Result::DESCRIPTION_INVALID_POINTER);
}
inline Result MakeResultInvalidPointer(){return ResultInvalidPointer();}


/*!
    :category   Result
    @class nn::cec::ResultStateBusy
    @brief BUSY状態のため、アクセスできません。
*/
inline Result ResultStateBusy()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_BUSY );
}
inline Result MakeResultStateBusy(){return ResultStateBusy();}

/*!
    :category   Result
    @class nn::cec::ResultMisalignedSize
    @brief サイズに関するアライメントが不正です。
*/
inline Result ResultMisalignedSize()
{
    return MakeStatusResult( Result::SUMMARY_INVALID_STATE, Result::MODULE_NN_CEC, Result::DESCRIPTION_MISALIGNED_SIZE );
}
inline Result MakeResultMisalignedSize(){return ResultMisalignedSize();}




} // namespace cec
} // namespace nn


#endif  //__CEC_H__