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 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50<title>nn::ptm::CTR</title> 51 </head> 52 <body> 53<h1><CODE>nn::ptm::CTR</CODE> Namespace</h1> 54<h2>Description</h2> 55 <div class="section"> 56<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 "::CTR" portion.))</p></div> 57 <a name="class" id="class"> 58<h2>Classes</h2> 59 <div class="section"> 60 <table class="members"> 61 <tr> 62 <th> 63<a href="../../../nn/ptm/CTR/ResultOverWriteAlarm/Overview.html"><CODE>nn::ptm::CTR::ResultOverWriteAlarm</CODE></a> 64 </th> 65<td>Indicates that the alarm has already been configured.</td> 66 </tr> 67 <tr> 68 <th> 69<a href="../../../nn/ptm/CTR/ResultNoAlarm/Overview.html"><CODE>nn::ptm::CTR::ResultNoAlarm</CODE></a> 70 </th> 71<td>Indicates that the alarm has not been configured.</td> 72 </tr> 73 <tr> 74 <th> 75<a href="../../../nn/ptm/CTR/ResultNotRegistered/Overview.html"><CODE>nn::ptm::CTR::ResultNotRegistered</CODE></a> 76 </th> 77<td>Indicates that an alarm notification event has not been set.</td> 78 </tr> 79 <tr> 80 <th> 81<a href="../../../nn/ptm/CTR/ResultInvalidAlarm/Overview.html"><CODE>nn::ptm::CTR::ResultInvalidAlarm</CODE></a> 82 </th> 83<td>Indicates that the date specified for the alarm is out of range.</td> 84 </tr> </table> 85 </div> 86 </a> <a name="enum" id="enum"> 87<h2>Enumerated Types</h2> 88 <div class="section"> 89 <table class="members"> 90 <tr> 91<th class="category" colspan="3">Hardware States</th> 92 </tr> 93 <tr> 94 <td width="100"> </td> 95 <th> 96<a href="../../../nn/ptm/CTR/AdapterState.html">AdapterState</a> 97 </th> 98<td>Indicates the state of the power adapter.</td> 99 </tr> 100 <tr> 101 <td width="100"> </td> 102 <th> 103<a href="../../../nn/ptm/CTR/BatteryChargeState.html">BatteryChargeState</a> 104 </th> 105<td>Indicates the battery's charging state.</td> 106 </tr> 107 <tr> 108 <td width="100"> </td> 109 <th> 110<a href="../../../nn/ptm/CTR/BatteryLevel.html">BatteryLevel</a> 111 </th> 112<td>Indicates the remaining battery charge level.</td> 113 </tr> </table> 114 </div> 115 </a> <a name="function" id="function"> 116<h2>Functions</h2> 117 <div class="section"> 118 <table class="members"> 119 <tr> 120<th class="category" colspan="3">Hardware States</th> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125<a href="../../../nn/ptm/CTR/GetAdapterState.html">GetAdapterState</a> 126 </th> 127<td>Gets the state of the power adapter.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132<a href="../../../nn/ptm/CTR/GetBatteryLevel.html">GetBatteryLevel</a> 133 </th> 134<td>Gets the remaining battery charge level.</td> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139<a href="../../../nn/ptm/CTR/GetBatteryChargeState.html">GetBatteryChargeState</a> 140 </th> 141<td>Gets the battery's charging state.</td> 142 </tr> 143 <tr> 144<th class="category" colspan="3">Alarm-Related</th> 145 </tr> 146 <tr> 147 <td width="100"> </td> 148 <th> 149<a href="../../../nn/ptm/CTR/RegisterAlarmEvent.html">RegisterAlarmEvent</a> 150 </th> 151<td>Registers an event for getting an alarm notification.</td> 152 </tr> 153 <tr> 154 <td width="100"> </td> 155 <th> 156<a href="../../../nn/ptm/CTR/SetRtcAlarm.html">SetRtcAlarm</a> 157 </th> 158<td>Sets an alarm.</td> 159 </tr> 160 <tr> 161 <td width="100"> </td> 162 <th> 163<a href="../../../nn/ptm/CTR/GetRtcAlarm.html">GetRtcAlarm</a> 164 </th> 165<td>Gets the time for which the alarm has been set.</td> 166 </tr> 167 <tr> 168 <td width="100"> </td> 169 <th> 170<a href="../../../nn/ptm/CTR/CancelRtcAlarm.html">CancelRtcAlarm</a> 171 </th> 172<td>Cancels a configured alarm.</td> 173 </tr> 174 <tr> 175<th class="category" colspan="3">Other</th> 176 </tr> 177 <tr> 178 <td width="100"> </td> 179 <th> 180<a href="../../../nn/ptm/CTR/Initialize.html"><CODE>Initialize</CODE></a> 181 </th> 182<td>Initializes the PTM library.</td> 183 </tr> 184 <tr> 185 <td width="100"> </td> 186 <th> 187<a href="../../../nn/ptm/CTR/Finalize.html"><CODE>Finalize</CODE></a> 188 </th> 189<td>Finalizes the PTM library.</td> 190 </tr> </table> 191 </div> 192 </a> 193 <hr><p>CONFIDENTIAL</p></body> 194</html>