/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     boss_TaskOption.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: 26265 $
 *---------------------------------------------------------------------------*/

#ifndef NN_BOSS_BOSS_TASK_OPTION_H_
#define NN_BOSS_BOSS_TASK_OPTION_H_

#include <nn/boss/boss_Const.h>
#include <nn/boss/boss_Result.h>
#include <nn/boss/boss_Types.h>

#ifdef __cplusplus

namespace nn {
namespace boss {

/*!
  @brief        タスクオプションを表すクラスです。タスクを登録する際のオプション情報設定などに利用します。(ただし現時点では、タスクオプション機能は未対応です。)
*/
class TaskOption
{
public:
/*!
  @brief        コンストラクタです。
*/
    explicit TaskOption(void);

/*!
  @brief        デストラクタです。
*/
    virtual ~TaskOption(void);

/*!
  @brief        タスクオプションの初期設定を行います。
  @return       処理の結果が返ります。<BR>
*/
    nn::Result Initialize(void);

/*!
  @brief        タスクの実行制御オプションの設定を行います。（将来の拡張機能です）
  @param[in]    exec     タスクの実行制御オプションを指定します。
  @return       処理の結果が返ります。<BR>
*/
    nn::Result Initialize(ExecOption exec);

/*!
  @brief        タスクの実行制御オプションに対するパラメータ設定を行います。
  @param[in]    target      実行制御変更後のタスクステップIDを指定します。
  @param[in]    param1      制御パラメータ１を指定します。
  @param[in]    param2      制御パラメータ２を指定します。
  @return       処理の結果が返ります。<BR>
*/
    nn::Result SetConditional(u8 target, u32 param1, u32 param2);


/*!
  @brief        クラス内のプロパティの値を設定します。
                下記のプロパティを使用できます。\n
        識別子                  型 \n
        TASK_EXEC_OPTION        ExecOption \n
        TASK_STEP               u8 \n
        TASK_OPTION_TARGET_STEP u8 \n
        TASK_OPTION_PARAM1      u32 \n
        TASK_OPTION_PARAM2      u32 \n
  @param[in]    type    プロパティの識別子を指定します。
  @param[in]    pValue  値を指定します。
  @param[in]    size    値のサイズを指定します。
  @return       処理の結果が返ります。<BR>
  @retval       Description== @ref ER_INVALID_PROPERTYVALUE 「プロパティ値のポインタがNULLです。」を表すエラー
  @retval       Description== @ref ER_INVALID_PROPERTYTYPE  「プロパティタイプがサポート外です。」を表すエラー
*/
    nn::Result SetProperty(PropertyType type, void* pValue, size_t size);

/*!
  @brief        クラス内のプロパティの値を取得します。
                下記のプロパティを使用できます。\n
        識別子                  型 \n
        TASK_EXEC_OPTION        ExecOption \n
        TASK_STEP               u8 \n
        TASK_OPTION_TARGET_STEP u8 \n
        TASK_OPTION_PARAM1      u32 \n
        TASK_OPTION_PARAM2      u32 \n
  @param[in]    type    プロパティの識別子を指定します。
  @param[out]   pValue  値を指定します。
  @param[in]    size    値のサイズを指定します。
  @return       処理の結果が返ります。<BR>
  @retval       Description== @ref ER_INVALID_PROPERTYVALUE 「プロパティ値のポインタがNULLです。」を表すエラー
  @retval       Description== @ref ER_INVALID_PROPERTYTYPE  「プロパティタイプがサポート外です。」を表すエラー
*/
    nn::Result GetProperty(PropertyType type, void* pValue, size_t size);

protected:
    friend class AccessConfig;
    TaskOptionConfig m_Option;
};

} // end of namespace boss
} // end of namespace nn

#endif // __cplusplus

#endif /* NN_BOSS_BOSS_TASK_OPTION_H_ */