CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
session_CreateCommunitySetting.h
1 /*--------------------------------------------------------------------------------*
2  Copyright (C)Nintendo All rights reserved.
3 
4  These coded instructions, statements, and computer programs contain proprietary
5  information of Nintendo and/or its licensed developers and are protected by
6  national and international copyright laws. They may not be disclosed to third
7  parties or copied or duplicated in any form, in whole or in part, without the
8  prior written consent of Nintendo.
9 
10  The content herein is highly confidential and should be handled accordingly.
11  *--------------------------------------------------------------------------------*/
12 
13 
14 #pragma once
15 
16 #include <nn/pia/session/session_Definitions.h>
17 
18 #include <nn/pia/session/session_Types.h>
19 
20 namespace nn
21 {
22 namespace pia
23 {
24 namespace session
25 {
26 /*!
27  @brief コミュニティの作成処理に関する設定を管理する基底クラスです。
28  @details アプリケーションが本クラスのインスタンスを作成することはありません。 本クラスを継承したクラスを使用する必要があります。
29 
30  @see inet::NexCreateCommunitySetting
31  */
33 {
34 public:
35  /*!
36  @brief デストラクタ。
37  */
38  virtual ~CreateCommunitySetting();
39 
40  /*!
41  @brief 作成するコミュニティの最小参加人数を指定します。
42  @param[in] min 作成するコミュニティに指定する最小参加人数。
43  */
44  void SetMinParticipantNum(uint16_t min);
45 
46  /*!
47  @cond PRIVATE
48  @brief 指定した最小参加人数を取得します。
49  @return 指定した最小参加人数を返します。
50  */
51  uint16_t GetMinParticipantNum() const;
52  //! @endcond
53 
54  /*!
55  @brief 作成するコミュニティの最大参加人数を指定します。
56  @param[in] max 作成するコミュニティに指定する最大参加人数。
57  */
58  void SetMaxParticipantNum(uint16_t max);
59 
60  /*!
61  @cond PRIVATE
62  @brief 指定した最大参加人数を取得します。
63  @return 指定した最大参加人数を返します。
64  */
65  uint16_t GetMaxParticipantNum() const;
66  //! @endcond
67 
68  /*!
69  @brief 設定をリセットします。
70  */
71  virtual void Reset();
72 
73 
74 protected:
75  // デフォルトコンストラクタ
77 
78  uint16_t m_MinParticipantNum;
79  uint16_t m_MaxParticipantNum;
80 
81 private:
82  NN_PIA_DISALLOW_COPY(CreateCommunitySetting);
83 };
84 }
85 }
86 } // end of namespace session