CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
session_JoinCommunitySetting.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 nn::pia::inet::NexJoinCommunitySetting
31  */
33 {
34 public:
35  /*!
36  @brief デストラクタ。
37  */
38  virtual ~JoinCommunitySetting();
39 
40  /*!
41  @brief 参加するコミュニティを指定します。
42  @param[in] communityId 参加するコミュニティID。
43  */
44  void SetCommunityId(uint32_t communityId);
45 
46  /*!
47  @cond PRIVATE
48  @brief 指定したコミュニティIDを取得します。
49  @return 指定したコミュニティIDを返します。
50  */
51  uint32_t GetCommunityId() const;
52  //! @endcond
53 
54  /*!
55  @brief 設定をリセットします。
56  */
57  virtual void Reset();
58 
59 protected:
60  // デフォルトコンストラクタ
62 
63  void Copy(const JoinCommunitySetting& rhs);
64 
65  uint32_t m_CommunityId;
66 
67 private:
68  NN_PIA_DISALLOW_COPY(JoinCommunitySetting);
69 };
70 }
71 }
72 } // end of namespace nn::pia::session