CTR Pia  4.11.3
Game Communication Engine
session_ISessionInfoList.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: session_ISessionInfoList.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/session/session_definitions.h>
18 #include <pia/session/session_ISessionInfo.h>
19 
20 namespace nn
21 {
22 namespace pia
23 {
24 namespace session
25 {
26 
27 /*!
28  @brief The interface for the session information list.
29 
30  @date 2014-02-27 Initial version.
31 */
33 {
34 public:
36  {
37  }
38  virtual ~ISessionInfoList()
39  {
40  }
41 
42  typedef ISessionInfo** Iterator;
43  typedef const ISessionInfo** ConstIterator;
44 
45 /*!
46  @brief Gets the iterator for those that start with <tt>ISessionInfo*</tt> (<tt>const</tt> version).
47  @return Returns an iterator for the element at the start of the container.
48 */
49  virtual ConstIterator Begin() const = 0;
50 /*!
51  @brief Gets the iterator for those that start with <tt>ISessionInfo*</tt> (non-<tt>const</tt> version).
52  @return Returns an iterator for the element at the start of the container.
53 */
54  virtual Iterator Begin() = 0;
55 /*!
56  @brief Gets the iterator for the <tt>ISessionInfo*</tt> that corresponds to what follows the end of the container (<tt>const</tt> version).
57  @return Returns an iterator for the element that corresponds to what follows the end of the container.
58 */
59  virtual ConstIterator End() const = 0;
60 /*!
61  @brief Gets the iterator for the <tt>ISessionInfo*</tt> that corresponds to what follows the end of the container (non-<tt>const</tt> version).
62  @return Returns an iterator for the element that corresponds to what follows the end of the container.
63 */
64  virtual Iterator End() = 0;
65 /*!
66  @brief Gets the number of elements in the list.
67  @return Returns the number of elements in the list.
68 */
69  virtual size_t GetSize() const = 0;
70 /*!
71  @brief Gets the maximum number for the list.
72  @return Returns the maximum number for the list.
73 */
74  virtual size_t GetMaxSize() const = 0;
75 };
76 }
77 }
78 } // end of namespace nn::pia::session
virtual ConstIterator Begin() const =0
Gets the iterator for those that start with ISessionInfo* (const version).
Definition: assert.h:115
virtual size_t GetMaxSize() const =0
Gets the maximum number for the list.
An interface to the session&#39;s information.
Definition: session_ISessionInfo.h:32
virtual ConstIterator End() const =0
Gets the iterator for the ISessionInfo* that corresponds to what follows the end of the container (co...
The interface for the session information list.
Definition: session_ISessionInfoList.h:32
virtual size_t GetSize() const =0
Gets the number of elements in the list.
This is the common base class used inside the Pia library.
Definition: common_RootObject.h:40