CTR-Pia  5.4.3
Game Communication Engine
 全て クラス ネームスペース 関数 変数 型定義 列挙型 列挙型の値 ページ
local_UdsSessionSearchCriteria.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/local/local_Definitions.h>
17 #if NN_PIA_LOCAL_ENABLE_UDS
18 #include <nn/pia/local/local_LocalSessionSearchCriteria.h>
19 #include <nn/pia/local/local_UdsNetworkSetting.h>
20 
21 namespace nn
22 {
23 namespace pia
24 {
25 namespace local
26 {
27 /*!
28  @brief UDS ライブラリ(ローカル通信)を利用したネットワークのセッションを検索する際に使用する検索条件のクラスです。
29  @details 検索結果として得られるセッションの最大数は nn::pia::session::Session::CreateInstance 呼び出し時に
30  指定する nn::pia::session::Session::Setting 構造体の browsedSessionInfoListNum の値になります。
31  */
33 {
34 public:
35  // コンストラクタ。
38  m_UdsScanNetworkSetting()
39  {
40  }
41 
42  // デストラクタ。
43  virtual ~UdsSessionSearchCriteria()
44  {
45  }
46 
47  /*!
48  @brief 検索条件にローカル通信 ID を指定します。
49  @param[in] localCommunicationId 検索条件に指定するローカル通信 ID です。@ref LocalFacade::CreateLocalCommunicationId で生成した値を指定する必要があります。
50  */
51  void SetLocalCommunicationId(uint32_t localCommunicationId)
52  {
53  m_UdsScanNetworkSetting.localCommunicationId = localCommunicationId;
54  }
55 
56  /*!
57  @brief 検索条件に通信モード識別用 ID を指定します。
58  @param[in] subId 検索条件に指定する通信モード識別用 ID です。0xff を指定するとあらゆる ID を探索します。
59  */
60  void SetSubId(uint8_t subId)
61  {
62  m_UdsScanNetworkSetting.subId = subId;
63  }
64 
65  virtual const LocalScanNetworkSetting* GetLocalScanNetworkSetting() const
66  {
67  return &m_UdsScanNetworkSetting;
68  }
69 
70  /*!
71  @cond PRIVATE
72  */
73  virtual bool IsHit(const LocalNetworkDescription* pDescription) const;
74  //!@endcond
75 
76  /*!
77  @brief 代入演算子です。
78  @param[in] rhs 代入するオブジェクトです。
79  @return 本オブジェクトへの参照。
80  */
81  UdsSessionSearchCriteria& operator=(const UdsSessionSearchCriteria& rhs);
82 
83  /*!
84  @brief 設定をコピーします。
85  @param[in] rhs コピー元のオブジェクトです。
86  */
87  void Copy(const UdsSessionSearchCriteria& rhs);
88 
89  /*!
90  @brief コピーコンストラクタ。。
91  @param[in] rhs コピー元のオブジェクトです。
92  */
93  UdsSessionSearchCriteria(const UdsSessionSearchCriteria& rhs);
94 
95  /*!
96  @brief 設定をリセットします。
97  */
98  virtual void Reset();
99 
100  // デバッグに有用な情報をプリント。
101  virtual void Trace(uint64_t flag) const
102  {
103  NN_PIA_UNUSED(flag);
104  }
105 
106 protected:
107  UdsScanNetworkSetting m_UdsScanNetworkSetting;
108 
109 private:
110 };
111 }
112 }
113 } // end of namespace nn::pia::local
114 #endif