CTR Pia  4.11.3
Game Communication Engine
clone_SequentialSharingClone.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: clone_SequentialSharingClone.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/clone/clone_definitions.h>
18 #include <pia/clone/clone_SharingClone.h>
19 
20 namespace nn
21 {
22 namespace pia
23 {
24 namespace clone
25 {
26 
27 
28 /*!
29 @brief This class is a derivative of <tt>CloneBase</tt> and provides functionality for bidirectional sending and receiving. It is capable of unlimited sending.
30 
31 @attention <tt>EventCloneElement</tt> and <tt>reckoning::ReckoningCloneElement</tt> objects cannot be registered with <tt>SequentialSharingClone</tt>.
32 
33 @date 2013-09-25 Initial version.
34 */
36 {
37 public:
38 /*!
39 @brief Instantiates the object with default parameters (default constructor).
40 */
42 
43 
44 /*!
45 @brief Destroys the object (destructor).
46 */
47  virtual ~SequentialSharingClone();
48 
49 
50 /*!
51 @brief Prints information that is useful for debugging.
52 
53 @param[in] flag Specifies the bitwise OR of trace flags. For more information, see the <tt>@ref TraceFlag</tt> type.
54 */
55  virtual void Trace(u64 flag) const;
56 
57 
58  //! @cond PRIVATE
59 
60 public:
61  static Type GetTypeStatic()
62  {
63  return TYPE_SEQUENTIAL;
64  }
65  static Key ToKey(Id id)
66  {
67  return CloneBase::ToKey(TYPE_SEQUENTIAL, STATION_INDEX_INVALID, id);
68  }
69  virtual Type GetTypeVirtual() const
70  {
71  return GetTypeStatic();
72  }
73 
74 public:
75  virtual bool IsReadyToSetValue() const;
76 
77 protected:
78 public:
79  template <int TEST_ID, typename Arg>
80  static void Test(const SequentialSharingClone& obj, Arg* pArg = NULL);
81 
82  //! @endcond
83 };
84 }
85 }
86 } // end of namespace nn::pia::clone
virtual ~SequentialSharingClone()
Destroys the object (destructor).
This class is a derivative of CloneBase and provides functionality for bidirectional sending and rece...
Definition: clone_SharingClone.h:34
Definition: assert.h:115
ID indicating a station that is not present in the session.
Definition: platformCtr.h:59
virtual void Trace(u64 flag) const
Prints information that is useful for debugging.
SequentialSharingClone()
Instantiates the object with default parameters (default constructor).
This class is a derivative of CloneBase and provides functionality for bidirectional sending and rece...
Definition: clone_SequentialSharingClone.h:35
u32 Id
Specifies the type of the ID for identifying clones.
Definition: clone_CloneBase.h:68