CTR Pia  4.11.3
Game Communication Engine
reckoning_Api.h
1 /*---------------------------------------------------------------------------*
2  Project: Pia
3  File: reckoning_Api.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/reckoning/reckoning_definitions.h>
18 
19 
20 namespace nn
21 {
22 namespace pia
23 {
24 namespace reckoning
25 {
26 
27 
28 /*!
29 @brief Gets whether the <tt>reckoning</tt> module is initialized.
30 
31 @return Returns <tt>true</tt> if it is initialized, and <tt>false</tt> otherwise.
32 @see Initialize, Finalize
33 */
34 bool IsInitialized(void);
35 
36 
37 /*!
38 @brief Initializes the <tt>reckoning</tt> module.
39 
40 @return Returns a <tt>Result</tt> value indicating success if initialization succeeds. You must make sure that the implementation of this function in your application does not return any errors.
41 @retval ResultAlreadyInitialized The module is already initialized. Programming error. Fix your program so that this error is not returned.
42 @see IsInitialized, Finalize
43 */
44 nn::Result Initialize(void);
45 
46 
47 /*!
48 @brief Finalizes the <tt>reckoning</tt> module.
49 This function does nothing and returns if it is called before the <tt>Initialize</tt> function has been called.
50 
51 @see IsInitialized, Initialize
52 
53 */
54 void Finalize(void);
55 
56 
57 /*!
58 @brief Declares the start of setup.
59 
60 @return Returns a <tt>Result</tt> value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
61 @retval ResultNotInitialized Indicates that the <tt>reckoning::Initialize</tt> function has not been called. Programming error. Fix your program so that this error is not returned.
62 @retval ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.
63 @see EndSetup
64 */
65 nn::Result BeginSetup(void);
66 
67 
68 /*!
69 @brief Declares the end of setup.
70 
71 @return Returns a <tt>Result</tt> value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
72 @retval ResultNotInitialized Indicates that the <tt>reckoning::Initialize</tt> function has not been called. Programming error. Fix your program so that this error is not returned.
73 @retval ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.
74 @see BeginSetup
75 */
76 nn::Result EndSetup(void);
77 
78 
79 /*!
80 @cond PRIVATE
81 @brief Indicates whether an application is executing code between calls to the <tt>BeginSetup</tt> and <tt>EndSetup</tt> functions.
82 
83 @details This function is thread-safe.
84 */
85 bool IsInSetupMode(void);
86 //! @endcond
87 }
88 }
89 } // end of namespace nn::pia::reckoning
Definition: assert.h:115
nn::Result EndSetup(void)
Declares the end of setup.
void Finalize(void)
Finalizes the reckoning module. This function does nothing and returns if it is called before the Ini...
nn::Result BeginSetup(void)
Declares the start of setup.
bool IsInitialized(void)
Gets whether the reckoning module is initialized.
nn::Result Initialize(void)
Initializes the reckoning module.