<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>ANTLR Support Libraries 2.7.1+: antlr::ANTLRException Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body onload='searchBox.OnSelectItem(0);'> <!-- Generated by Doxygen 1.7.3 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">ANTLR Support Libraries 2.7.1+</div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="inherits.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceantlr.html">antlr</a> </li> <li class="navelem"><a class="el" href="classantlr_1_1ANTLRException.html">ANTLRException</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pri-attribs">Private Attributes</a> </div> <div class="headertitle"> <h1>antlr::ANTLRException Class Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="antlr::ANTLRException" --> <p><code>#include <<a class="el" href="ANTLRException_8hpp_source.html">ANTLRException.hpp</a>></code></p> <div class="dynheader"> Inheritance diagram for antlr::ANTLRException:</div> <div class="dyncontent"> <div class="center"><img src="classantlr_1_1ANTLRException__inherit__graph.png" border="0" usemap="#antlr_1_1ANTLRException_inherit__map" alt="Inheritance graph"/></div> <map name="antlr_1_1ANTLRException_inherit__map" id="antlr_1_1ANTLRException_inherit__map"> </map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classantlr_1_1ANTLRException-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classantlr_1_1ANTLRException.html#a7b8b122edb64083afd78510832a0a255">ANTLRException</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create ANTLR base exception without error message. <a href="#a7b8b122edb64083afd78510832a0a255"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classantlr_1_1ANTLRException.html#a19e3d02fcac00031ba7ef22b0615aa2e">ANTLRException</a> (const std::string &s)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create ANTLR base exception with error message. <a href="#a19e3d02fcac00031ba7ef22b0615aa2e"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classantlr_1_1ANTLRException.html#a77521b70b1a1cff29a469bcdabdbf693">~ANTLRException</a> () throw ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classantlr_1_1ANTLRException.html#ab549853b44358f1eccd1afe7e9b2bb70">toString</a> () const </td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classantlr_1_1ANTLRException.html#a4a55963f27829ada6085e9cfc1b5e873">getMessage</a> () const </td></tr> <tr><td colspan="2"><h2><a name="pri-attribs"></a> Private Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classantlr_1_1ANTLRException.html#a75d0d996d6054bea8d95a1b0ce6b8594">text</a></td></tr> </table> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a7b8b122edb64083afd78510832a0a255"></a><!-- doxytag: member="antlr::ANTLRException::ANTLRException" ref="a7b8b122edb64083afd78510832a0a255" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">antlr::ANTLRException::ANTLRException </td> <td>(</td> <td class="paramname"></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Create ANTLR base exception without error message. </p> </div> </div> <a class="anchor" id="a19e3d02fcac00031ba7ef22b0615aa2e"></a><!-- doxytag: member="antlr::ANTLRException::ANTLRException" ref="a19e3d02fcac00031ba7ef22b0615aa2e" args="(const std::string &s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">antlr::ANTLRException::ANTLRException </td> <td>(</td> <td class="paramtype">const std::string & </td> <td class="paramname"><em>s</em></td><td>)</td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Create ANTLR base exception with error message. </p> </div> </div> <a class="anchor" id="a77521b70b1a1cff29a469bcdabdbf693"></a><!-- doxytag: member="antlr::ANTLRException::~ANTLRException" ref="a77521b70b1a1cff29a469bcdabdbf693" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual antlr::ANTLRException::~ANTLRException </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> throw ()<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a4a55963f27829ada6085e9cfc1b5e873"></a><!-- doxytag: member="antlr::ANTLRException::getMessage" ref="a4a55963f27829ada6085e9cfc1b5e873" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual std ::string antlr::ANTLRException::getMessage </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return error message without additional info (if present) </p> <dl class="note"><dt><b>Note:</b></dt><dd>when making your own exceptions classes override toString and call in toString getMessage which relays the text attribute from here. </dd></dl> <p>Reimplemented in <a class="el" href="classantlr_1_1NoViableAltForCharException.html#a918d6c0d9949a3249589d7dd278ab3e0">antlr::NoViableAltForCharException</a>.</p> </div> </div> <a class="anchor" id="ab549853b44358f1eccd1afe7e9b2bb70"></a><!-- doxytag: member="antlr::ANTLRException::toString" ref="ab549853b44358f1eccd1afe7e9b2bb70" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual std ::string antlr::ANTLRException::toString </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const<code> [inline, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return complete error message with line/column number info (if present) </p> <dl class="note"><dt><b>Note:</b></dt><dd>for your own exceptions override this one. Call getMessage from here to get the 'clean' error message stored in the text attribute. </dd></dl> <p>Reimplemented in <a class="el" href="classantlr_1_1RecognitionException.html#a0fb969ee1a75ddccacc998fae9f57f38">antlr::RecognitionException</a>.</p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a75d0d996d6054bea8d95a1b0ce6b8594"></a><!-- doxytag: member="antlr::ANTLRException::text" ref="a75d0d996d6054bea8d95a1b0ce6b8594" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">std ::string <a class="el" href="classantlr_1_1ANTLRException.html#a75d0d996d6054bea8d95a1b0ce6b8594">antlr::ANTLRException::text</a><code> [private]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>antlr/<a class="el" href="ANTLRException_8hpp_source.html">ANTLRException.hpp</a></li> </ul> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small>Generated on Fri Mar 25 2011 for ANTLR Support Libraries 2.7.1+ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>