/*---------------------------------------------------------------------------*
  Project:  Horizon
  File:     boss_TaskStatus.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_STATUS_H_
#define NN_BOSS_BOSS_TASK_STATUS_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 TaskStatus
{
public:
/*!
  @brief        コンストラクタです。
*/
    explicit TaskStatus(void);

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

/*!
  @brief        クラス内のプロパティの値を取得します。
                ステータスを確認したいタイミングで、nn::boss::GetTaskStatus()を呼び出す必要があります。
                下記のプロパティを使用できます。\n
        識別子              型 \n
        TASK_STATE_CODE TaskStateCode \n
        TASK_RESULT_CODE TaskResultCode \n
        TASK_COMM_ERROR_CODE u32 \n
        TASK_CURRENT_PRIORITY u32 \n
        TASK_EXECUTE_COUNT u32 \n
        TASK_PENDING_TIME u32 \n
        TASK_REMAIN_TIME u32 \n
        TASK_START_TIME s64 \n
        TASK_PROGRESS u32 \n
        TASK_DATA_SIZE u32 \n
        TASK_SERVICE_TERMINATED bool \n
        TASK_LAST_MODIFIED_TIME char lastModified[MAX_LASTMODIFIED_LENGTH] \n
        TASK_CURRENT_STEP u8 \n
        TASK_STEP_START_TIME s64 \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  「プロパティタイプがサポート外です。」を表すエラー
*/
    Result GetProperty(PropertyType type, void* pValue, size_t size);

protected:
    friend class AccessConfig;
    NN_PADDING4;
    TaskStatusInfo      m_Status;
};





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

#endif // __cplusplus

#endif /* NN_BOSS_BOSS_TASK_STATUS_H_ */