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

#ifndef NN_BOSS_BOSS_STEP_ID_LIST_H_
#define NN_BOSS_BOSS_STEP_ID_LIST_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        タスクステップのIDリストを表すクラスです。あるタスクのタスクステップ一覧を取得するためなどに利用します。(ただし現時点では、タスクステップ機能は未対応です。)
*/
class StepIdList
{
public:
/*!
  @brief        コンストラクタです。
*/
    explicit StepIdList(void);

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

/*!
  @brief        一覧内のステップID個数を返します。
  @return       一覧の個数が返ります。<BR>
*/
    u16 GetSize(void);

/*!
  @brief        指定した位置のステップIDを返します。
  @param[in]    index   一覧内の位置を指定します。
  @return       ステップIDが返ります。<BR>
         @retval MAX_STEP_ID    indexが不正のため、SETP_IDが取得できません。
*/
    u8 GetStepId(u16 index);

protected:
    friend class AccessConfig;
    StepIdInfoList m_StepId;
};

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

#endif // __cplusplus

#endif /* NN_BOSS_BOSS_STEP_ID_LIST_H_ */