<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>DTN Reference Implementation: dtn::StringScheme Class Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> <link href="tabs.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.6 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</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> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacedtn.html">dtn</a>::<a class="el" href="classdtn_1_1StringScheme.html">StringScheme</a> </div> </div> <div class="contents"> <h1>dtn::StringScheme Class Reference</h1><!-- doxytag: class="dtn::StringScheme" --><!-- doxytag: inherits="dtn::Scheme" --><code>#include <<a class="el" href="StringScheme_8h-source.html">StringScheme.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for dtn::StringScheme:</div> <div class="dynsection"> <p><center><img src="classdtn_1_1StringScheme.png" usemap="#dtn::StringScheme_map" border="0" alt=""></center> <map name="dtn::StringScheme_map"> <area href="classdtn_1_1Scheme.html" alt="dtn::Scheme" shape="rect" coords="0,0,113,24"> </map> </div> <p> <a href="classdtn_1_1StringScheme-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2> <p>Definition at line <a class="el" href="StringScheme_8h-source.html#l00025">25</a> of file <a class="el" href="StringScheme_8h-source.html">StringScheme.h</a>.</p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1StringScheme.html#787afa84df43777ce71f93d8278649f8">validate</a> (const <a class="el" href="namespacedtn.html#0b3883e065c5b300f2581971eee1c009">URI</a> &uri, <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> is_pattern=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Validate that the SSP in the given URI is legitimate for this scheme. <a href="#787afa84df43777ce71f93d8278649f8"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1StringScheme.html#fe152c14aa867e29a65a859c3f84641e">match</a> (const <a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> &pattern, const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> &eid)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Match the pattern to the endpoint id in a scheme-specific manner. <a href="#fe152c14aa867e29a65a859c3f84641e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classdtn_1_1EndpointID.html#43d537f639ac64ca9b401701dae46f28">singleton_info_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1StringScheme.html#49383a4e03422db7ea9d8d62b88f03ce">is_singleton</a> (const <a class="el" href="namespacedtn.html#0b3883e065c5b300f2581971eee1c009">URI</a> &uri)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the given URI is a singleton EID. <a href="#49383a4e03422db7ea9d8d62b88f03ce"></a><br></td></tr> <tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1StringScheme.html#6683a0f5ddf79ffa8f63b349aa1c5309">StringScheme</a> ()</td></tr> <tr><td colspan="2"><br><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classdtn_1_1StringScheme.html#0da6f719e79efe3be054d662fd7849ac">oasys::Singleton< StringScheme ></a></td></tr> </table> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="6683a0f5ddf79ffa8f63b349aa1c5309"></a><!-- doxytag: member="dtn::StringScheme::StringScheme" ref="6683a0f5ddf79ffa8f63b349aa1c5309" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">dtn::StringScheme::StringScheme </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, private]</code></td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="StringScheme_8h-source.html#l00050">50</a> of file <a class="el" href="StringScheme_8h-source.html">StringScheme.h</a>.</p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="787afa84df43777ce71f93d8278649f8"></a><!-- doxytag: member="dtn::StringScheme::validate" ref="787afa84df43777ce71f93d8278649f8" args="(const URI &uri, bool is_pattern=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> dtn::StringScheme::validate </td> <td>(</td> <td class="paramtype">const <a class="el" href="namespacedtn.html#0b3883e065c5b300f2581971eee1c009">URI</a> & </td> <td class="paramname"> <em>uri</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> </td> <td class="paramname"> <em>is_pattern</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Validate that the SSP in the given URI is legitimate for this scheme. <p> If * the 'is_pattern' paraemeter is true, then the ssp is being validated as an <a class="el" href="classdtn_1_1EndpointIDPattern.html" title="A Distinct class for endpoint patterns (i.e.">EndpointIDPattern</a>.<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd>true if valid </dd></dl> <p>Implements <a class="el" href="classdtn_1_1Scheme.html#fe5c727a96aa6cd6bec8c731df4e868e">dtn::Scheme</a>.</p> <p>Definition at line <a class="el" href="StringScheme_8cc-source.html#l00031">31</a> of file <a class="el" href="StringScheme_8cc-source.html">StringScheme.cc</a>.</p> </div> </div><p> <a class="anchor" name="fe152c14aa867e29a65a859c3f84641e"></a><!-- doxytag: member="dtn::StringScheme::match" ref="fe152c14aa867e29a65a859c3f84641e" args="(const EndpointIDPattern &pattern, const EndpointID &eid)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="serialsource_8c.html#1062901a7428fdd9c7f180f5e01ea056">bool</a> dtn::StringScheme::match </td> <td>(</td> <td class="paramtype">const <a class="el" href="classdtn_1_1EndpointIDPattern.html">EndpointIDPattern</a> & </td> <td class="paramname"> <em>pattern</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classdtn_1_1EndpointID.html">EndpointID</a> & </td> <td class="paramname"> <em>eid</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Match the pattern to the endpoint id in a scheme-specific manner. <p> <p>Implements <a class="el" href="classdtn_1_1Scheme.html#93f324d766daa8cd2755602a7214e4b3">dtn::Scheme</a>.</p> <p>Definition at line <a class="el" href="StringScheme_8cc-source.html#l00043">43</a> of file <a class="el" href="StringScheme_8cc-source.html">StringScheme.cc</a>.</p> <p>References <a class="el" href="SDNV_8cc-source.html#l00044">ASSERT</a>, <a class="el" href="EndpointID_8h-source.html#l00261">dtn::EndpointID::scheme()</a>, and <a class="el" href="EndpointID_8h-source.html#l00258">dtn::EndpointID::str()</a>.</p> </div> </div><p> <a class="anchor" name="49383a4e03422db7ea9d8d62b88f03ce"></a><!-- doxytag: member="dtn::StringScheme::is_singleton" ref="49383a4e03422db7ea9d8d62b88f03ce" args="(const URI &uri)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classdtn_1_1EndpointID.html#43d537f639ac64ca9b401701dae46f28">Scheme::singleton_info_t</a> dtn::StringScheme::is_singleton </td> <td>(</td> <td class="paramtype">const <a class="el" href="namespacedtn.html#0b3883e065c5b300f2581971eee1c009">URI</a> & </td> <td class="paramname"> <em>uri</em> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Check if the given URI is a singleton EID. <p> <p>Implements <a class="el" href="classdtn_1_1Scheme.html#c7b3e53d5f176d3ae1a710407d443d9c">dtn::Scheme</a>.</p> <p>Definition at line <a class="el" href="StringScheme_8cc-source.html#l00053">53</a> of file <a class="el" href="StringScheme_8cc-source.html">StringScheme.cc</a>.</p> <p>References <a class="el" href="EndpointID_8h-source.html#l00206">dtn::EndpointID::SINGLETON</a>.</p> </div> </div><p> <hr><h2>Friends And Related Function Documentation</h2> <a class="anchor" name="0da6f719e79efe3be054d662fd7849ac"></a><!-- doxytag: member="dtn::StringScheme::oasys::Singleton< StringScheme >" ref="0da6f719e79efe3be054d662fd7849ac" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class oasys::Singleton< <a class="el" href="classdtn_1_1StringScheme.html">StringScheme</a> ><code> [friend]</code> </td> </tr> </table> </div> <div class="memdoc"> <p> <p>Definition at line <a class="el" href="StringScheme_8h-source.html#l00049">49</a> of file <a class="el" href="StringScheme_8h-source.html">StringScheme.h</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="StringScheme_8h-source.html">StringScheme.h</a><li><a class="el" href="StringScheme_8cc-source.html">StringScheme.cc</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:53 2008 for DTN Reference Implementation by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address> </body> </html>