1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../css/manpage.css" type="text/css" />
7    <style type="text/css"><!--
8      span.static_style
9      {
10        font-size			: 8pt;
11        color				: white;
12        font-weight			: bold;
13        background			: #44f;
14        border-left			: solid 1px #aaf;
15        border-top			: solid 1px #aaf;
16        border-right		: solid 1px #00c;
17        border-bottom		: solid 1px #00c;
18        padding-left		: 2px;
19        padding-right		: 2px;
20      }
21      span.virtual_style
22      {
23        font-size			 : 8pt;
24        color				 : white;
25        font-weight			: bold;
26        background			: #0a0;
27        border-left			: solid 1px #0f0;
28        border-top			: solid 1px #0f0;
29        border-right		: solid 1px #060;
30        border-bottom		: solid 1px #060;
31        padding-left		: 2px;
32        padding-right		: 2px;
33      }
34      span.protected_style
35      {
36        font-size			 : 8pt;
37        color				 : white;
38        font-weight			: bold;
39        background			: #444;
40        border-left			: solid 1px #ccc;
41        border-top			: solid 1px #ccc;
42        border-right		: solid 1px #222;
43        border-bottom		: solid 1px #222;
44        padding-left		: 2px;
45        padding-right		: 2px;
46      }
47        --></style>
48<title>nn::ptm::CTR</title>
49  </head>
50  <body>
51<h1><CODE>nn::ptm::CTR</CODE> Namespace</h1>
52<h2>Description</h2>
53    <div class="section">
54<p>Namespace for <a href="../../../nn/ptm/CTR/Overview.html">CTR</a> functions relating to power management and clock.</p><p>(This can also be written without the &quot;::CTR&quot; portion.))</p><!-- write here --></div>
55    <a name="class" id="class">
56<h2>Classes</h2>
57      <div class="section">
58        <table class="members">
59          <tr>
60            <th>
61<a href="../../../nn/ptm/CTR/ResultOverWriteAlarm/Overview.html"><CODE>nn::ptm::CTR::ResultOverWriteAlarm</CODE></a>
62            </th>
63<td>Indicates that the alarm has already been configured.</td>
64          </tr>
65          <tr>
66            <th>
67<a href="../../../nn/ptm/CTR/ResultNoAlarm/Overview.html"><CODE>nn::ptm::CTR::ResultNoAlarm</CODE></a>
68            </th>
69<td>Indicates that the alarm has not been configured.</td>
70          </tr>
71          <tr>
72            <th>
73<a href="../../../nn/ptm/CTR/ResultNotRegistered/Overview.html"><CODE>nn::ptm::CTR::ResultNotRegistered</CODE></a>
74            </th>
75<td>Indicates that an alarm notification event has not been set.</td>
76          </tr>
77          <tr>
78            <th>
79<a href="../../../nn/ptm/CTR/ResultInvalidAlarm/Overview.html"><CODE>nn::ptm::CTR::ResultInvalidAlarm</CODE></a>
80            </th>
81<td>Indicates that the date specified for the alarm is out of range.</td>
82          </tr> </table>
83      </div>
84    </a> <a name="enum" id="enum">
85<h2>Enumerated Types</h2>
86      <div class="section">
87        <table class="members">
88          <tr>
89<th class="category" colspan="3">Hardware States</th>
90          </tr>
91          <tr>
92            <td width="100"> </td>
93            <th>
94<a href="../../../nn/ptm/CTR/AdapterState.html">AdapterState</a>
95            </th>
96<td>Indicates the state of the power adapter.</td>
97          </tr>
98          <tr>
99            <td width="100"> </td>
100            <th>
101<a href="../../../nn/ptm/CTR/BatteryChargeState.html">BatteryChargeState</a>
102            </th>
103<td>Indicates the battery's charging state.</td>
104          </tr>
105          <tr>
106            <td width="100"> </td>
107            <th>
108<a href="../../../nn/ptm/CTR/BatteryLevel.html">BatteryLevel</a>
109            </th>
110<td>Indicates the remaining battery charge level.</td>
111          </tr> </table>
112      </div>
113    </a> <a name="function" id="function">
114<h2>Functions</h2>
115      <div class="section">
116        <table class="members">
117          <tr>
118<th class="category" colspan="3">Hardware States</th>
119          </tr>
120          <tr>
121            <td width="100">  </td>
122            <th>
123<a href="../../../nn/ptm/CTR/GetAdapterState.html">GetAdapterState</a>
124            </th>
125<td>Gets the state of the power adapter.</td>
126          </tr>
127          <tr>
128            <td width="100">  </td>
129            <th>
130<a href="../../../nn/ptm/CTR/GetBatteryLevel.html">GetBatteryLevel</a>
131            </th>
132<td>Gets the remaining battery charge level.</td>
133          </tr>
134          <tr>
135            <td width="100">  </td>
136            <th>
137<a href="../../../nn/ptm/CTR/GetBatteryChargeState.html">GetBatteryChargeState</a>
138            </th>
139<td>Gets the battery's charging state.</td>
140          </tr>
141          <tr>
142<th class="category" colspan="3">Alarm-Related</th>
143          </tr>
144          <tr>
145            <td width="100">  </td>
146            <th>
147<a href="../../../nn/ptm/CTR/RegisterAlarmEvent.html">RegisterAlarmEvent</a>
148            </th>
149<td>Registers an event for getting an alarm notification.</td>
150          </tr>
151          <tr>
152            <td width="100">  </td>
153            <th>
154<a href="../../../nn/ptm/CTR/SetRtcAlarm.html">SetRtcAlarm</a>
155            </th>
156<td>Sets an alarm.</td>
157          </tr>
158          <tr>
159            <td width="100">  </td>
160            <th>
161<a href="../../../nn/ptm/CTR/GetRtcAlarm.html">GetRtcAlarm</a>
162            </th>
163<td>Gets the time for which the alarm has been set.</td>
164          </tr>
165          <tr>
166            <td width="100">  </td>
167            <th>
168<a href="../../../nn/ptm/CTR/CancelRtcAlarm.html">CancelRtcAlarm</a>
169            </th>
170<td>Cancels a configured alarm.</td>
171          </tr>
172          <tr>
173<th class="category" colspan="3">Other</th>
174          </tr>
175          <tr>
176            <td width="100">  </td>
177            <th>
178<a href="../../../nn/ptm/CTR/Initialize.html"><CODE>Initialize</CODE></a>
179            </th>
180<td>Initializes the PTM library.</td>
181          </tr>
182          <tr>
183            <td width="100">  </td>
184            <th>
185<a href="../../../nn/ptm/CTR/Finalize.html"><CODE>Finalize</CODE></a>
186            </th>
187<td>Finalizes the PTM library.</td>
188          </tr> </table>
189      </div>
190    </a>
191<h2>Revision History</h2>
192    <div class="section">
193      <dl class="history">
194        <dt>2010/11/10</dt>
195<dd>Initial version.<br />
196        </dd>
197      </dl>
198    </div>
199  <hr><p>CONFIDENTIAL</p></body>
200</html>
201