1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 3 <title>PVLoggerLayout class Reference</title> 4 <link href="doxygen.css" rel="stylesheet" type="text/css"> 5 </head><body> 6 <!-- Generated by Doxygen 1.2.18 --> 7 <center> 8 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="modules.html">Modules</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="annotated.html">Data Structures</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Data Fields</a> <a class="qindex" href="globals.html">Globals</a> </center> 9 <hr><h1>PVLoggerLayout Class Reference</h1><code>#include <<a class="el" href="pvlogger__accessories_8h-source.html">pvlogger_accessories.h</a>></code> 10 <p> 11 <table border=0 cellpadding=0 cellspacing=0> 12 <tr><td></td></tr> 13 <tr><td colspan=2><br><h2>Public Types</h2></td></tr> 14 <tr><td nowrap align=right valign=top>typedef PVLogger::message_id_type </td><td valign=bottom><a class="el" href="classPVLoggerLayout.html#s0">message_id_type</a></td></tr> 15 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> 16 <tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classPVLoggerLayout.html#a0">~PVLoggerLayout</a> ()</td></tr> 17 <tr><td nowrap align=right valign=top>virtual int32 </td><td valign=bottom><a class="el" href="classPVLoggerLayout.html#a1">FormatString</a> (char *formatBuf, int32 formatBufSize, <a class="el" href="classPVLoggerLayout.html#s0">message_id_type</a> msgID, const char *fmt, va_list va)=0</td></tr> 18 <tr><td nowrap align=right valign=top>virtual int32 </td><td valign=bottom><a class="el" href="classPVLoggerLayout.html#a2">FormatOpaqueMessage</a> (char *formatBuf, int32 formatBufSize, <a class="el" href="classPVLoggerLayout.html#s0">message_id_type</a> msgID, int32 numPairs, va_list va)=0</td></tr> 19 </table> 20 <hr><a name="_details"></a><h2>Detailed Description</h2> 21 Base class for all message formatters. This class defines the interface to the message formatter. There are two kinds of msg formatting APIs, one to format text messages, and other to format opaque message buffers. 22 <p> 23 <hr><h2>Member Typedef Documentation</h2> 24 <a name="s0" doxytag="PVLoggerLayout::message_id_type"></a><p> 25 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 26 <tr> 27 <td class="md"> 28 <table cellpadding="0" cellspacing="0" border="0"> 29 <tr> 30 <td class="md" nowrap valign="top"> typedef PVLogger::message_id_type PVLoggerLayout::message_id_type 31 </table> 32 </td> 33 </tr> 34 </table> 35 <table cellspacing=5 cellpadding=0 border=0> 36 <tr> 37 <td> 38 39 </td> 40 <td> 41 42 <p> 43 </td> 44 </tr> 45 </table> 46 <hr><h2>Constructor & Destructor Documentation</h2> 47 <a name="a0" doxytag="PVLoggerLayout::~PVLoggerLayout"></a><p> 48 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 49 <tr> 50 <td class="md"> 51 <table cellpadding="0" cellspacing="0" border="0"> 52 <tr> 53 <td class="md" nowrap valign="top"> virtual PVLoggerLayout::~PVLoggerLayout </td> 54 <td class="md" valign="top">( </td> 55 <td class="mdname1" valign="top" nowrap> </td> 56 <td class="md" valign="top">) </td> 57 <td class="md" nowrap><code> [inline, virtual]</code></td> 58 </tr> 59 60 </table> 61 </td> 62 </tr> 63 </table> 64 <table cellspacing=5 cellpadding=0 border=0> 65 <tr> 66 <td> 67 68 </td> 69 <td> 70 71 <p> 72 </td> 73 </tr> 74 </table> 75 <hr><h2>Member Function Documentation</h2> 76 <a name="a2" doxytag="PVLoggerLayout::FormatOpaqueMessage"></a><p> 77 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 78 <tr> 79 <td class="md"> 80 <table cellpadding="0" cellspacing="0" border="0"> 81 <tr> 82 <td class="md" nowrap valign="top"> virtual int32 PVLoggerLayout::FormatOpaqueMessage </td> 83 <td class="md" valign="top">( </td> 84 <td class="md" nowrap valign="top">char * </td> 85 <td class="mdname" nowrap> <em>formatBuf</em>, </td> 86 </tr> 87 <tr> 88 <td></td> 89 <td></td> 90 <td class="md" nowrap>int32 </td> 91 <td class="mdname" nowrap> <em>formatBufSize</em>, </td> 92 </tr> 93 <tr> 94 <td></td> 95 <td></td> 96 <td class="md" nowrap><a class="el" href="classPVLoggerLayout.html#s0">message_id_type</a> </td> 97 <td class="mdname" nowrap> <em>msgID</em>, </td> 98 </tr> 99 <tr> 100 <td></td> 101 <td></td> 102 <td class="md" nowrap>int32 </td> 103 <td class="mdname" nowrap> <em>numPairs</em>, </td> 104 </tr> 105 <tr> 106 <td></td> 107 <td></td> 108 <td class="md" nowrap>va_list </td> 109 <td class="mdname" nowrap> <em>va</em></td> 110 </tr> 111 <tr> 112 <td></td> 113 <td class="md">) </td> 114 <td class="md" colspan="2"><code> [pure virtual]</code></td> 115 </tr> 116 117 </table> 118 </td> 119 </tr> 120 </table> 121 <table cellspacing=5 cellpadding=0 border=0> 122 <tr> 123 <td> 124 125 </td> 126 <td> 127 128 <p> 129 Formats the data and copies it to the given buffer. 130 <p> 131 <dl compact><dt><b>Returns: </b></dt><dd> 132 The length of the buffer used. </dl> </td> 133 </tr> 134 </table> 135 <a name="a1" doxytag="PVLoggerLayout::FormatString"></a><p> 136 <table width="100%" cellpadding="2" cellspacing="0" border="0"> 137 <tr> 138 <td class="md"> 139 <table cellpadding="0" cellspacing="0" border="0"> 140 <tr> 141 <td class="md" nowrap valign="top"> virtual int32 PVLoggerLayout::FormatString </td> 142 <td class="md" valign="top">( </td> 143 <td class="md" nowrap valign="top">char * </td> 144 <td class="mdname" nowrap> <em>formatBuf</em>, </td> 145 </tr> 146 <tr> 147 <td></td> 148 <td></td> 149 <td class="md" nowrap>int32 </td> 150 <td class="mdname" nowrap> <em>formatBufSize</em>, </td> 151 </tr> 152 <tr> 153 <td></td> 154 <td></td> 155 <td class="md" nowrap><a class="el" href="classPVLoggerLayout.html#s0">message_id_type</a> </td> 156 <td class="mdname" nowrap> <em>msgID</em>, </td> 157 </tr> 158 <tr> 159 <td></td> 160 <td></td> 161 <td class="md" nowrap>const char * </td> 162 <td class="mdname" nowrap> <em>fmt</em>, </td> 163 </tr> 164 <tr> 165 <td></td> 166 <td></td> 167 <td class="md" nowrap>va_list </td> 168 <td class="mdname" nowrap> <em>va</em></td> 169 </tr> 170 <tr> 171 <td></td> 172 <td class="md">) </td> 173 <td class="md" colspan="2"><code> [pure virtual]</code></td> 174 </tr> 175 176 </table> 177 </td> 178 </tr> 179 </table> 180 <table cellspacing=5 cellpadding=0 border=0> 181 <tr> 182 <td> 183 184 </td> 185 <td> 186 187 <p> 188 Formats the string and copies it to the given buffer. 189 <p> 190 <dl compact><dt><b>Returns: </b></dt><dd> 191 The length of the string not including the trailing '\0' </dl> </td> 192 </tr> 193 </table> 194 <hr>The documentation for this class was generated from the following file:<ul> 195 <li><a class="el" href="pvlogger__accessories_8h-source.html">pvlogger_accessories.h</a></ul> 196 <hr size="1"><img src="pvlogo_small.jpg"><address style="align: right;"><small>OSCL API</small> 197 <address style="align: left;"><small>Posting Version: OPENCORE_20090310 </small> 198 </small></address> 199 </body> 200 </html> 201
