CTR Pia  4.11.3
Game Communication Engine
inet_NexSessionSearchCriteriaOwner.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: inet_NexSessionSearchCriteriaOwner.h
4 
5  Copyright Nintendo. All rights reserved.
6 
7  These coded instructions, statements, and computer programs contain
8  proprietary information of Nintendo of America Inc. and/or Nintendo
9  Company Ltd., and are protected by Federal copyright law. They may
10  not be disclosed to third parties or copied or duplicated in any form,
11  in whole or in part, without the prior written consent of Nintendo.
12  *---------------------------------------------------------------------------*/
13 
14 
15 #pragma once
16 
17 #include <pia/inet/inet_definitions.h>
18 
19 #include <pia/inet/inet_NexSessionTypes.h>
20 #include <pia/session/session_SessionSearchCriteria.h>
21 
22 namespace nn
23 {
24 namespace pia
25 {
26 namespace inet
27 {
28 
29 /*!
30  @brief The condition class used when searching for a session.
31 
32  @see nn::pia::session::SessionSearchCriteria
33 */
35 {
36 public:
37 /*!
38  @brief The default constructor.
39 */
41  session::SessionSearchCriteria(),
42  m_OwnerPrincipalId(0)
43  {
44  m_KeyType = session::SessionSearchCriteria::SearchCriteriaKey_OwnerPrincipalId;
45  }
46 
47 /*!
48  @brief The constructor.
49  @param[in] ownerPrincipalId Specify the principal ID of the owner as a search condition.
50  @param[in] resultOffset Starting position of the entries to get as search results from the list of entries that match the search criteria.
51  @param[in] resultSize Number of entries to get as search results from the list of entries that match the search criteria.
52 */
53  NexSessionSearchCriteriaOwner(u32 ownerPrincipalId, u32 resultOffset, u32 resultSize) :
54  m_OwnerPrincipalId(ownerPrincipalId)
55  {
56  m_KeyType = session::SessionSearchCriteria::SearchCriteriaKey_OwnerPrincipalId;
57  m_ResultOffset = resultOffset;
58  m_ResultSize = resultSize;
59  }
60 
61 /*!
62  @brief The destructor.
63 */
65  {
66  }
67 
68 /*!
69  @brief Specifies the principal ID of the owner as a search condition.
70  @param[in] ownerPrincipalId The principal ID of the owner to use as a search condition.
71 */
72  void SetOwnerPrincipalId(u32 ownerPrincipalId)
73  {
74  m_OwnerPrincipalId = ownerPrincipalId;
75  }
76 
77 /*!
78  @brief Assignment operator.
79  @param[in] r The object to assign.
80  @return See this object.
81 */
83  {
85  m_OwnerPrincipalId = r.m_OwnerPrincipalId;
86  return *this;
87  }
88 
89 /*!
90  @cond PRIVATE
91 */
92  u32 GetOwnerPrincipalId() const
93  {
94  return m_OwnerPrincipalId;
95  }
96  //! @endcond
97 
98 protected:
99 
100  // The copy constructor is sealed.
102 
103  u32 m_OwnerPrincipalId;
104 
105 };
106 }
107 }
108 } // End of namespace nn::pia::inet.
109 
NexSessionSearchCriteriaOwner & operator=(const NexSessionSearchCriteriaOwner &r)
Assignment operator.
Definition: inet_NexSessionSearchCriteriaOwner.h:82
The condition class used when searching for a session.
Definition: inet_NexSessionSearchCriteriaOwner.h:34
Definition: assert.h:115
NexSessionSearchCriteriaOwner(u32 ownerPrincipalId, u32 resultOffset, u32 resultSize)
The constructor.
Definition: inet_NexSessionSearchCriteriaOwner.h:53
The base class for the search criteria used when searching for sessions.
Definition: session_SessionSearchCriteria.h:34
void SetOwnerPrincipalId(u32 ownerPrincipalId)
Specifies the principal ID of the owner as a search condition.
Definition: inet_NexSessionSearchCriteriaOwner.h:72
virtual ~NexSessionSearchCriteriaOwner()
The destructor.
Definition: inet_NexSessionSearchCriteriaOwner.h:64
NexSessionSearchCriteriaOwner()
The default constructor.
Definition: inet_NexSessionSearchCriteriaOwner.h:40
SessionSearchCriteria & operator=(const SessionSearchCriteria &r)
Assignment operator.
Definition: session_SessionSearchCriteria.h:99