1 /*---------------------------------------------------------------------------* 2 Project: Horizon 3 File: boss_TaskOption.h 4 5 Copyright (C)2009 Nintendo Co., Ltd. All rights reserved. 6 7 These coded instructions, statements, and computer programs contain 8 proprietary information of Nintendo of America Inc. and/or Nintendo 9 Company Ltd., and are protected by Federal copyright law. They may 10 not be disclosed to third parties or copied or duplicated in any form, 11 in whole or in part, without the prior written consent of Nintendo. 12 13 $Rev: 31623 $ 14 *---------------------------------------------------------------------------*/ 15 16 #ifndef NN_BOSS_BOSS_TASK_OPTION_H_ 17 #define NN_BOSS_BOSS_TASK_OPTION_H_ 18 19 #include <nn/boss/boss_Const.h> 20 #include <nn/boss/boss_Result.h> 21 #include <nn/boss/boss_Types.h> 22 23 #ifdef __cplusplus 24 25 namespace nn { 26 namespace boss { 27 28 /*! 29 @brief タスクオプションを表すクラスです。タスクを登録する際のオプション情報設定などに利用します。(ただし現時点では、タスクオプション機能は未対応です。) 30 */ 31 class TaskOption 32 { 33 public: 34 /*! 35 @brief コンストラクタです。 36 */ 37 explicit TaskOption(void); 38 39 /*! 40 @brief デストラクタです。 41 */ 42 virtual ~TaskOption(void); 43 44 /*! 45 @brief タスクオプションの初期設定を行います。この初期化にとってオブジェクトの再利用が可能になります。 46 @return 関数の実行結果を返します。以下に挙げる Result を返します。 47 @retval ResultSuccess 初期化に成功しました。 48 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 49 */ 50 nn::Result Initialize(void); 51 52 /*! 53 @brief タスクの実行制御オプションの設定を行います。（将来の拡張機能です） 54 @param[in] exec タスクの実行制御オプションを指定します。 55 @return 関数の実行結果を返します。以下に挙げる Result を返します。 56 @retval ResultSuccess 初期化に成功しました。 57 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 58 */ 59 nn::Result Initialize(ExecOption exec); 60 61 /*! 62 @brief タスクの実行制御オプションに対するパラメータ設定を行います。（将来の拡張機能です） 63 @param[in] target 実行制御変更後のタスクステップIDを指定します。 64 @param[in] param1 制御パラメータ１を指定します。 65 @param[in] param2 制御パラメータ２を指定します。 66 @return 関数の実行結果を返します。以下に挙げる Result を返します。 67 @retval ResultSuccess 設定に成功しました。 68 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 69 */ 70 nn::Result SetConditional(u8 target, u32 param1, u32 param2); 71 72 73 /*! 74 @brief クラス内のプロパティの値を設定します。説明部のデータ型の領域を確保した後、呼び出してください。 75 下記のプロパティを使用できます。\n 76 識別子 説明 \n 77 TASK_STEP タスクステップのID番号。データの型は、u8 です。 \n 78 @param[in] type プロパティの識別子を指定します。 79 @param[in] pValue 値を指定します。 80 @param[in] size 値のサイズを指定します。 81 @return 関数の実行結果を返します。以下に挙げる Result を返します。 82 @retval ResultSuccess 設定に成功しました。 83 @retval ResultInvalidPropertyValue プロパティ値のポインタがNULLです。 84 @retval ResultInvalidPropertyType プロパティタイプがサポート外です。 85 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 86 */ 87 nn::Result SetProperty(PropertyType type, void* pValue, size_t size); 88 89 /*! 90 @brief クラス内のプロパティの値を取得します。説明部のデータ型の領域を確保した後、呼び出してください。 91 下記のプロパティを使用できます。\n 92 識別子 説明 \n 93 TASK_EXEC_OPTION タスク実行オプション。データの型は、ExecOption です。 \n 94 TASK_STEP タスクステップのID番号。データの型は、u8 です。 \n 95 @param[in] type プロパティの識別子を指定します。 96 @param[out] pValue 値を指定します。 97 @param[in] size 値のサイズを指定します。 98 @return 関数の実行結果を返します。以下に挙げる Result を返します。 99 @retval ResultSuccess 取得に成功しました。 100 @retval ResultInvalidPropertyValue プロパティ値のポインタがNULLです。 101 @retval ResultInvalidPropertyType プロパティタイプがサポート外です。 102 @retval 上記以外 想定外のエラー(エラー内容については、@ref boss_Result.h を参照)。 103 */ 104 nn::Result GetProperty(PropertyType type, void* pValue, size_t size); 105 106 protected: 107 friend class AccessConfig; 108 TaskOptionConfig m_Option; 109 }; 110 111 } // end of namespace boss 112 } // end of namespace nn 113 114 #endif // __cplusplus 115 116 #endif /* NN_BOSS_BOSS_TASK_OPTION_H_ */ 117